CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.connector2.cics
Class ECIConnectionFactory

java.lang.Object
  extended by com.ibm.connector2.cics.CICSConnectionFactory
      extended by com.ibm.connector2.cics.ECIConnectionFactory
All Implemented Interfaces:
java.io.Serializable, javax.naming.Referenceable, javax.resource.cci.ConnectionFactory

public final class ECIConnectionFactory
extends CICSConnectionFactory

The ECIConnectionFactory allows a client component to request a connection to CICS. The getConnection() method is used to return an ECIConnection object that represents a handle to the underlying connection to CICS.

Note:In the ECI connector, the timeout property on the ECIConnectionFactory is meaningless. Any access to the set/getTimeout() methods will not result in an exception but neither will it affect the getConnection() call.

See Also:
Serialized Form

Constructor Summary
ECIConnectionFactory()
          Default constructor.
ECIConnectionFactory(javax.resource.spi.ConnectionManager cm, ECIManagedConnectionFactory emcf)
          Constructor.
 
Method Summary
 javax.resource.cci.Connection getConnection(javax.resource.cci.ConnectionSpec spec)
          This is the extended version of getConnection() which allows the user to pass an ECIConnectionSpec parameter containing their user credentials.
 javax.resource.cci.ResourceAdapterMetaData getMetaData()
          Returns information about the resource adapter.
 java.lang.String toString()
          Return a String representation of this class.
 
Methods inherited from class com.ibm.connector2.cics.CICSConnectionFactory
getConnection, getRecordFactory, getReference, setReference
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ECIConnectionFactory

public ECIConnectionFactory()
Default constructor. This constructor cannot be used to create a valid ECIConnectionFactory. It is only used by runtime servers that wish to create a simple object to handle referenceable usage.


ECIConnectionFactory

public ECIConnectionFactory(javax.resource.spi.ConnectionManager cm,
                            ECIManagedConnectionFactory emcf)
Constructor.

Method Detail

getConnection

public javax.resource.cci.Connection getConnection(javax.resource.cci.ConnectionSpec spec)
                                            throws javax.resource.ResourceException
This is the extended version of getConnection() which allows the user to pass an ECIConnectionSpec parameter containing their user credentials.

Parameters:
spec - The ECIConnectionSpec containing the users security credentials.
Returns:
The ECIConnection object representing the connection to CICS.
Throws:
javax.resource.ResourceException

getMetaData

public javax.resource.cci.ResourceAdapterMetaData getMetaData()
Returns information about the resource adapter.

Returns:
The metadata for this resource adapter.

toString

public java.lang.String toString()
Return a String representation of this class. This will return a string containing all the relevant property contents of this class.

Overrides:
toString in class CICSConnectionFactory
Returns:
The string representation of this class.

©Copyright IBM Corp. 1994, 2014
Legal