javax.resource.spi.ManagedConnectionFactory 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.security.auth.Subject;
import java.util.Set;
import javax.resource.ResourceException;
import javax.resource.NotSupportedException;
/**
* ManagedConnectionFactory instance is a factory of both ManagedConnection
* and EIS-specific connection factory instances. This interface supports
* connection pooling by providing methods for matching and creation of
* ManagedConnection instance. A ManagedConnectionFactory
* instance is required to be a JavaBean.
*
* @version 0.6
* @author Rahul Sharma
*
* @see javax.resource.spi.ManagedConnection
*/
public interface ManagedConnectionFactory extends java.io.Serializable {
/**
* Creates a Connection Factory instance. The Connection Factory
* instance gets initialized with the passed ConnectionManager. In
* the managed scenario, ConnectionManager is provided by the
* application server.
*
* @param cxManager ConnectionManager to be associated with
* created EIS connection factory instance
* @return EIS-specific Connection Factory instance or
* javax.resource.cci.ConnectionFactory instance
*
* @throws ResourceException Generic exception
* @throws ResourceAdapterInternalException
* Resource adapter related error condition
*/
public Object createConnectionFactory(ConnectionManager cxManager)
throws ResourceException;
/**
* Creates a Connection Factory instance. The Connection Factory
* instance gets initialized with a default ConnectionManager provided
* by the resource adapter.
*
* @return EIS-specific Connection Factory instance or
* javax.resource.cci.ConnectionFactory instance
*
* @throws ResourceException Generic exception
* @throws ResourceAdapterInternalException
* Resource adapter related error condition
*/
public Object createConnectionFactory() throws ResourceException;
/**
* Creates a new physical connection to the underlying EIS
* resource manager.
*
* ManagedConnectionFactory uses the security information (passed as
* Subject) and additional ConnectionRequestInfo (which is specific to
* ResourceAdapter and opaque to application server) to create this new
* connection.
*
* @param subject Caller's security information
* @param cxRequestInfo Additional resource adapter specific connection
* request information
*
* @throws ResourceException generic exception
* @throws SecurityException security related error
* @throws ResourceAllocationException
* failed to allocate system resources for
* connection request
* @throws ResourceAdapterInternalException
* resource adapter related error condition
* @throws EISSystemException internal error condition in EIS instance
*
* @return ManagedConnection instance
*/
public ManagedConnection createManagedConnection(
Subject subject,
ConnectionRequestInfo cxRequestInfo)
throws ResourceException;
/**
* Returns a matched connection from the candidate set of connections.
*
*
*
ManagedConnectionFactory uses the security info (as in Subject)
* and information provided through ConnectionRequestInfo and additional
* Resource Adapter specific criteria to do matching. Note that criteria
* used for matching is specific to a resource adapter and is not
* prescribed by the Connector specification.
*
* This method returns a ManagedConnection instance that is the best
* match for handling the connection allocation request.
*
* @param connectionSet candidate connection set
* @param subject caller's security information
* @param cxRequestInfo additional resource adapter specific
* connection request information
*
* @throws ResourceException generic exception
* @throws SecurityException security related error
* @throws ResourceAdapterInternalException
* resource adapter related error condition
* @throws NotSupportedException if operation is not supported
*
* @return ManagedConnection if resource adapter finds an
* acceptable match otherwise null
**/
public ManagedConnection matchManagedConnections(
Set connectionSet,
Subject subject,
ConnectionRequestInfo cxRequestInfo)
throws ResourceException;
/**
* Set the log writer for this ManagedConnectionFactory instance.
*
* The log writer is a character output stream to which all logging and
* tracing messages for this ManagedConnectionfactory instance will be
* printed.
*
* ApplicationServer manages the association of output stream with the
* ManagedConnectionFactory. When a ManagedConnectionFactory object is
* created the log writer is initially null, in other words, logging is
* disabled. Once a log writer is associated with a
* ManagedConnectionFactory, logging and tracing for
* ManagedConnectionFactory instance is enabled.
*
*
The ManagedConnection instances created by ManagedConnectionFactory
* "inherits" the log writer, which can be overridden by ApplicationServer
* using ManagedConnection.setLogWriter to set ManagedConnection specific
* logging and tracing.
*
* @param out PrintWriter - an out stream for
* error logging and tracing
* @throws ResourceException generic exception
* @throws ResourceAdapterInternalException
* resource adapter related error condition
*/
public void setLogWriter(java.io.PrintWriter out) throws ResourceException;
/**
* Get the log writer for this ManagedConnectionFactory instance.
*
*
The log writer is a character output stream to which all logging and
* tracing messages for this ManagedConnectionFactory instance will be
* printed
*
*
ApplicationServer manages the association of output stream with the
* ManagedConnectionFactory. When a ManagedConnectionFactory object is
* created the log writer is initially null, in other words, logging is
* disabled.
*
* @return PrintWriter
* @throws ResourceException generic exception
*/
public java.io.PrintWriter getLogWriter() throws ResourceException;
/**
* Returns the hash code for the ManagedConnectionFactory
*
* @return hash code for the ManagedConnectionFactory
*/
public int hashCode();
/**
* Check if this ManagedConnectionFactory is equal to another
* ManagedConnectionFactory.
*
* @return true if two instances are equal
*/
public boolean equals(Object other);
}