jakarta.resource.cci.ConnectionFactory Maven / Gradle / Ivy
/*
* 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.cci;
import jakarta.resource.ResourceException;
import jakarta.resource.NotSupportedException;
/** ConnectionFactory provides an interface for getting
* connection to an EIS instance. An implementation of ConnectionFactory
* interface is provided by a resource adapter.
*
* Application code looks up a ConnectionFactory instance from JNDI
* namespace and uses it to get EIS connections.
*
*
An implementation class for ConnectionFactory is required to
* implement java.io.Serializable and
* jakarta.resource.Referenceableinterfaces to support
* JNDI registration.
*
* @author Rahul Sharma
* @version 0.8
* @see jakarta.resource.cci.Connection
* @see jakarta.resource.Referenceable
**/
public interface ConnectionFactory
extends java.io.Serializable,
jakarta.resource.Referenceable {
/** Gets a connection to an EIS instance. This getConnection variant
* should be used when a component wants the container to manage EIS
* sign-on. This case is termed container-managed sign-on. The
* component does not pass any security information.
*
*
* @return Connection instance
* @throws ResourceException Failed to get a connection to
* the EIS instance. Examples of
* error cases are:
*
* - Invalid configuration of ManagedConnectionFactory--
* example: invalid server name
*
- Application server-internal error--example:
* connection pool related error
*
- Communication error
*
- EIS-specific error--example: EIS not active
*
- Resource adapter-internal error
*
- Security related error; example: invalid user
*
- Failure to allocate system resources
*
**/
public
Connection getConnection() throws ResourceException;
/** Gets a connection to an EIS instance. A component should use
* the getConnection variant with jakarta.resource.cci.ConnectionSpec
* parameter, if it needs to pass any resource adapter specific
* security information and connection parameters. In the component-
* managed sign-on case, an application component passes security
* information (example: username, password) through the
* ConnectionSpec instance.
*
* It is important to note that the properties passed through
* the getConnection method should be client-specific (example:
* username, password, language) and not related to the
* configuration of a target EIS instance (example: port number,
* server name). The ManagedConnectionFactory instance is configured
* with complete set of properties required for the creation of a
* connection to an EIS instance.
*
* @param properties Connection parameters and security
* information specified as
* ConnectionSpec instance
* @return Connection instance
*
* @throws ResourceException Failed to get a connection to
* the EIS instance. Examples of
* error cases are:
*
* - Invalid specification of input parameters
*
- Invalid configuration of ManagedConnectionFactory--
* example: invalid server name
*
- Application server-internal error--example:
* connection pool related error
*
- Communication error
*
- EIS-specific error--example: EIS not active
*
- Resource adapter-internal error
*
- Security related error; example: invalid user
*
- Failure to allocate system resources
*
* @see jakarta.resource.cci.ConnectionSpec
**/
public
Connection getConnection(ConnectionSpec properties)
throws ResourceException;
/** Gets a RecordFactory instance. The RecordFactory is used for
* the creation of generic Record instances.
*
* @return RecordFactory RecordFactory instance
*
* @throws ResourceException Failed to create a RecordFactory
* @throws NotSupportedException Operation not supported
**/
public
RecordFactory getRecordFactory() throws ResourceException;
/** Gets metadata for the Resource Adapter. Note that the metadata
* information is about the ResourceAdapter and not the EIS instance.
* An invocation of this method does not require that an active
* connection to an EIS instance should have been established.
*
* @return ResourceAdapterMetaData instance
* @throws ResourceException Failed to get metadata information
* about the resource adapter
**/
public
ResourceAdapterMetaData getMetaData() throws ResourceException;
}