javax.resource.spi.ActivationSpec Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jboss-connector-api_1.6_spec

JSR 322: Java(TM) EE Connector Architecture 1.6 API

There is a newer version: 1.0.1.Final

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2008-2009, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package javax.resource.spi;

/**
 * This interface serves as a marker. An instance of an ActivationSpec must be a
 * JavaBean and must be serializable. This holds the activation configuration
 * information for a message endpoint.
 * 
 * @version 1.0
 * @author Ram Jeyaraman
 */
public interface ActivationSpec extends ResourceAdapterAssociation 
{
   
   /**
    * This method may be called by a deployment tool to validate the overall
    * activation configuration information provided by the endpoint deployer.
    * This helps to catch activation configuration errors earlier on without
    * having to wait until endpoint activation time for configuration
    * validation. The implementation of this self-validation check behavior is
    * optional.
    * 
    * Note: As of Java EE Connectors 1.6 specification, resource adapter
    *       implementations are recommended to use the annotations or the
    *       XML validation deployment descriptor facilities defined by
    *       the Bean Validation specification to express their validation
    *       requirements of its configuration properties to the
    *       application server.
    *
    * @throws InvalidPropertyException indicates invalid configuration property settings.
    */         
   void validate() throws InvalidPropertyException;
}