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

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2018 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

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;
}