com.ibm.connector2.cics
Class ECIConnectionFactory

java.lang.Object
  extended bycom.ibm.connector2.cics.ECIConnectionFactory

public final class ECIConnectionFactory
extends java.lang.Object

This abstract class provides the framework for CICS Connection Factories

it provides support for the logWriter, timeout, jndi reference and metadata properties. It also manages the Managed Connection Factory and Connection Manager References.


Field Summary
static java.lang.String CLASS_VERSION
           
 
Method Summary
 javax.resource.cci.Connection getConnection()
          Returns a Connection within a Non-Managed Environment.
 Connection getConnection(ConnectionSpec spec)
          This is the extended version of getConnection() which allows the user to pass an ECIConnectionSpec parameter containing their user credentials.
 ResourceAdapterMetaData getMetaData()
          Returns information about the Resource adapter
 RecordFactory getRecordFactory()
          This method is not supported in CCI for CICS TS.
 javax.naming.Reference getReference()
          return the Reference Object associated with this object.
 void setReference(javax.naming.Reference newRef)
          Sets the Reference instance.
 java.lang.String toString()
          return a string representation of this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION
See Also:
Constant Field Values
Method Detail

setReference

public void setReference(javax.naming.Reference newRef)
Sets the Reference instance. This method is called by the deployment code to set the Reference that can be later returned by the getReference method.

Parameters:
newRef - A Reference object

getReference

public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException
return the Reference Object associated with this object.

Returns:
The associated Reference Object
Throws:
javax.naming.NamingException

getRecordFactory

public RecordFactory getRecordFactory()
                               throws ResourceException
This method is not supported in CCI for CICS TS.

Throws:
NotSupportedException - This exception is always thrown
ResourceException

getConnection

public javax.resource.cci.Connection getConnection()
                                            throws javax.resource.ResourceException
Returns a Connection within a Non-Managed Environment. You cannot provide any extra connection information here. You can only do this through any extra methods on the Managed Connection Factory.

Returns:
The new connection
Throws:
ResourceException - If invalid connection returned

toString

public java.lang.String toString()
return a string representation of this object. It is made up of the super toString + the properties held in this object.

Returns:
A String representation

getConnection

public Connection getConnection(ConnectionSpec spec)
                         throws ResourceException
This is the extended version of getConnection() which allows the user to pass an ECIConnectionSpec parameter containing their user credentials. The user credentials passed are not required by CCI for CICS TS and so they are ignored.

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

getMetaData

public ResourceAdapterMetaData getMetaData()
Returns information about the Resource adapter

Returns:
The meta data for this Resource Adapter