CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.connector2.cics
Class CICSConnectionFactory

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

public abstract class CICSConnectionFactory
extends java.lang.Object
implements javax.resource.cci.ConnectionFactory

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.

See Also:
Serialized Form

Method Summary
 javax.resource.cci.Connection getConnection()
          Returns a connection within a non-managed environment.
 javax.resource.cci.RecordFactory getRecordFactory()
          This will throw a NotSupportedException if invoked.
 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 instance.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.resource.cci.ConnectionFactory
getConnection, getMetaData
 

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.

Specified by:
getReference in interface javax.naming.Referenceable
Returns:
The associated reference object.
Throws:
javax.naming.NamingException

getRecordFactory

public javax.resource.cci.RecordFactory getRecordFactory()
                                                  throws javax.resource.ResourceException
This will throw a NotSupportedException if invoked.

Specified by:
getRecordFactory in interface javax.resource.cci.ConnectionFactory
Throws:
javax.resource.ResourceException - if invoked.

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.

Specified by:
getConnection in interface javax.resource.cci.ConnectionFactory
Returns:
The new connection.
Throws:
javax.resource.ResourceException - if an invalid connection is returned.

toString

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

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this instance.

©Copyright IBM Corp. 1994, 2014
Legal