Class Hierarchy All Classes All Fields and Methods

Class com.ibm.connector2.ims.ico.IMSConnectionFactory

java.lang.Object
   |
   +----com.ibm.connector2.ims.ico.IMSConnectionFactory

public class IMSConnectionFactory
implements Serializable
extends Object

The IMSConnectionFactory class provides an interface for getting connections to IMS Connect and, in turn, IMS OTMA. Connections are represented by IMSConnection instances, and are application-level handles to underlying physical connections such as TCP/IP sockets or Local Option connections. An application that uses the Common Client Interface (CCI) can look up an IMSConnectionFactory instance from the JNDI namespace and then use it to get an IMSConnection instance. This method is typically used when running in the managed environment of an application server such as WebSphere. For example:

        IMSConnectionFactory cf = null;
        Context ctx = null;
        // Create the initial context
        ctx = new InitialContext();
        // Get an IMSConnectionFactory instance. 
        cf = (IMSConnectionFactory) ctx.lookup("java:comp/env/myIMSTarget");
 

If JNDI is not configured, a CCI application can manually configure an IMSManagedConnectionFactory object and use it to obtain a connection factory. This method can be used in a non-managed environment such as running outside of an application server, in development mode, or when JNDI lookup fails.

        IMSConnectionFactory cf = null;
        IMSManagedConnectionFactory mcf = new IMSManagedConnectionFactory();
        mcf.setHostName("myHostName");
        mcf.setPortNumber(new Integer(9999));
        mcf.setDataStoreName("myIMS");
        ...
        cf = (IMSConnectionFactory) mcf.createConnectionFactory();		
 

Constructor Index
Constructor Description
IMSConnectionFactory() Creates an IMSConnectionFactory instance.
IMSConnectionFactory(javax.resource.spi.ConnectionManager) This constructor is used by IMSManagedConnectionFactory to create an IMSConnectionFactory instance.
Method Index
Method Description
javax.resource.cci.Connection getConnection() Gets a connection to a particular IMS Connect instance and, in turn, to a particular IMS OTMA.
javax.resource.cci.Connection getConnection(javax.resource.cci.ConnectionSpec) Gets a connection to a particular IMS Connect instance and, in turn, to a particular IMS OTMA.
ResourceAdapterMetaData getMetaData() Returns meta information about IMS Connector for Java, the resource adapter.
RecordFactory getRecordFactory() Gets a RecordFactory (not supported).
Reference getReference()  
void setReference(Reference) Sets the reference instance.

Constructors

IMSConnectionFactory

public IMSConnectionFactory() 

Creates an IMSConnectionFactory instance.

IMSConnectionFactory

public IMSConnectionFactory(javax.resource.spi.ConnectionManager aConnectionManager) 

This constructor is used by IMSManagedConnectionFactory to create an IMSConnectionFactory instance.

Methods

getConnection

public javax.resource.cci.Connection getConnection() throws ResourceException

Gets a connection to a particular IMS Connect instance and, in turn, to a particular IMS OTMA. This variant of the getConnection() method is used when the component requires the container to manage sign-on to IMS Connect/IMS (which is called container-managed sign-on), and does not need to send any other IMSConnectionSpec properties such as clientID.

getConnection

public javax.resource.cci.Connection getConnection(javax.resource.cci.ConnectionSpec aConnectionSpec) throws ResourceException

Gets a connection to a particular IMS Connect instance and, in turn, to a particular IMS OTMA. This variant of the getConnection() method is used when a component needs to pass resource adapter specific security information and additional connection parameters.

Both the security information and additional connection parameters are passed in an IMSConnectionSpec object.

Note: This will always be the version of getConnection used for component-managed sign-on.

getMetaData

public ResourceAdapterMetaData getMetaData() throws ResourceException

Returns meta information about IMS Connector for Java, the resource adapter. An invocation of this method does not require that an active connection to IMS via IMS Connect exists.

getRecordFactory

public RecordFactory getRecordFactory() throws ResourceException

Gets a RecordFactory (not supported).

Note: RecordFactory is not supported by IMS Connector for Java.

getReference

public final Reference getReference() throws NamingException

setReference

public final void setReference(Reference aRef) 

Sets the reference instance.

Class Hierarchy All Classes All Fields and Methods