jakarta.resource.spi.LazyAssociatableConnectionManager Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS 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).
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.resource.spi;
import jakarta.resource.ResourceException;
/**
* This is a mix-in interface that may be optionally implemented by a
* ConnectionManager implementation. An implementation of
* this interface must support the lazy connection association optimization.
*
* @version 1.0
* @author Ram Jeyaraman
*/
public interface LazyAssociatableConnectionManager {
/**
* This method is called by a resource adapter (that is capable of
* lazy connection association optimization) in order to lazily associate
* a connection object with a ManagedConnection instance.
*
* @param connection the connection object that is to be associated.
*
* @param mcf The ManagedConnectionFactory instance that was
* originally used to create the connection object.
*
* @param cxReqInfo connection request information. This information must
* be the same as that used to originally create the connection object.
*
* @throws ResourceException Generic exception.
*
* @throws ApplicationServerInternalException
* Application server specific exception.
*
* @throws SecurityException Security related error.
*
* @throws ResourceAllocationException
* Failed to allocate system resources for
* connection request.
* @throws ResourceAdapterInternalException
* Resource adapter related error condition.
*/
void associateConnection(Object connection, ManagedConnectionFactory mcf,
ConnectionRequestInfo cxReqInfo) throws ResourceException;
/**
* This method is called by the resource adapter (that is capable of
* lazy connection association optimization) in order to notify the
* application server that a disassociated connection handle is closed.
* The application server can then perform any cleanup operations
* related to the disassociated connection handle in its connection pool.
*
* @param connection the disassociated connection object handle that
* has been closed
*
* @param mcf The ManagedConnectionFactory instance that was
* originally used to create the connection object.
*
* @since 1.6
*/
void inactiveConnectionClosed(Object connection,
ManagedConnectionFactory mcf);
}