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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1

Show newest version

/*
 * 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;

import javax.resource.ResourceException;

/**
 * This interface specifies the methods to associate a 
 * ResourceAdapter object with other objects that 
 * implement this interface like 
 * ManagedConnectionFactory and ActivationSpec.
 *
 * @version 1.0
 * @author  Ram Jeyaraman
 */
public interface ResourceAdapterAssociation 
{
   
   /**
    * Get the associated ResourceAdapter object.
    *
    * @return the associated ResourceAdapter object.
    */
   ResourceAdapter getResourceAdapter();
   
   /**
    * Associate this object with a ResourceAdapter object. 
    * Note, this method must be called exactly once. That is, the 
    * association must not change during the lifetime of this object.
    *
    * @param ra ResourceAdapter object to be associated with.
    *
    * @throws ResourceException generic exception.
    *
    * @throws ResourceAdapterInternalException
    *            resource adapter related error condition.
    *
    * @throws IllegalStateException indicates that this object is in an
    * illegal state for the method invocation. For example, this occurs when
    * this method is called more than once on the same object.
    */
   void setResourceAdapter(ResourceAdapter ra) throws ResourceException;
}