javax.resource.spi.ConnectionManager 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;
/** ConnectionManager interface provides a hook for the resource adapter to
* pass a connection request to the application server.
*
*
An application server provides implementation of the ConnectionManager
* interface. This implementation is not specific to any particular type of
* the resource adapter or connection factory interface.
*
*
The ConnectionManager implementation delegates to the application
* server to enable latter to provide quality of services (QoS) - security,
* connection pool management, transaction management and error
* logging/tracing.
*
*
An application server implements these services in a generic manner,
* independent of any resource adapter and EIS specific mechanisms. The
* connector architecture does not specify how an application server
* implements these services; the implementation is specific to an
* application server.
*
*
After an application server hooks-in its services, the connection
* request gets delegated to a ManagedConnectionFactory instance either
* for the creation of a new physical connection or for the matching of
* an already existing physical connection.
*
*
An implementation class for ConnectionManager interface is
* required to implement the java.io.Serializable interface.
*
*
In the non-managed application scenario, the ConnectionManager
* implementation class can be provided either by a resource adapter (as
* a default ConnectionManager implementation) or by application
* developers. In both cases, QOS can be provided as components by third
* party vendors.
*
* @since 0.6
* @author Rahul Sharma
* @see javax.resource.spi.ManagedConnectionFactory
**/
public interface ConnectionManager
extends java.io.Serializable {
/** The method allocateConnection gets called by the resource adapter's
* connection factory instance. This lets connection factory instance
* (provided by the resource adapter) pass a connection request to
* the ConnectionManager instance.
*
* The connectionRequestInfo parameter represents information specific
* to the resource adapter for handling of the connection request.
*
* @param mcf
* used by application server to delegate
* connection matching/creation
* @param cxRequestInfo
* connection request Information
*
* @return connection handle with an EIS specific connection interface.
*
*
* @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
**/
public
Object allocateConnection(ManagedConnectionFactory mcf,
ConnectionRequestInfo cxRequestInfo)
throws ResourceException;
}