CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.connector2.cics
Class ECIManagedConnectionFactory

java.lang.Object
  extended by com.ibm.connector2.cics.CICSManagedConnectionFactory
      extended by com.ibm.connector2.cics.ECIManagedConnectionFactory
All Implemented Interfaces:
CICSLogTraceLevels, java.io.Serializable, javax.resource.spi.ManagedConnectionFactory, javax.resource.spi.ResourceAdapterAssociation, javax.resource.spi.ValidatingManagedConnectionFactory

public final class ECIManagedConnectionFactory
extends CICSManagedConnectionFactory

An ECIManagedConnectionFactory is used to create physical ECI connections to the CICS Transaction Gateway. In managed mode this is controlled by the J2EE application server and properties are set by configuring the ConnectionFactory objects via the application server. In non-managed mode the client application is required to create an instance of this class and set the relevant properties itself. Once this is done a ConnectionFactory object can be obtained which will inherit these properties.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.ibm.connector2.cics.CICSLogTraceLevels
RAS_TRACE_ENTRY_EXIT, RAS_TRACE_ERROR_EXCEPTION, RAS_TRACE_INTERNAL, RAS_TRACE_OFF
 
Constructor Summary
ECIManagedConnectionFactory()
           
 
Method Summary
 java.lang.Object createConnectionFactory()
          This method is the default route to creating ECIConnectionFactory objects.
 java.lang.Object createConnectionFactory(javax.resource.spi.ConnectionManager cm)
          This method allows a ConnectionManager to be specified as the one to be used by the returned ECIConnectionFactory.
 boolean equals(java.lang.Object inObj)
          This method returns true if two ECIManagedConnectionFactory objects are equal.
 java.lang.String getTPNName()
          Accessor for TPNName.
 java.lang.String getTranName()
          Accessor for tranName.
 int hashCode()
          Returns a hashcode based on all configurable properties.
 void setTPNName(java.lang.String name)
          Setter for TPNName.
 void setTranName(java.lang.String name)
          Setter for tranName.
 java.lang.String toString()
          Returns a string representation of this object.
 
Methods inherited from class com.ibm.connector2.cics.CICSManagedConnectionFactory
addPropertyChangeListener, firePropertyChange, getApplid, getApplidQualifier, getCipherSuites, getClientSecurity, getConnectionURL, getInterceptPlugin, getInvalidConnections, getKeyRingClass, getKeyRingPassword, getLogHelper, getLogWriter, getPassword, getPortNumber, getRequestExits, getResourceAdapter, getServerName, getServerSecurity, getSocketConnectTimeout, getTraceLevel, getUserName, removePropertyChangeListener, setApplid, setApplidQualifier, setCipherSuites, setClientSecurity, setConnectionURL, setInterceptPlugin, setKeyRingClass, setKeyRingPassword, setLogWriter, setPassword, setPortNumber, setRequestExits, setResourceAdapter, setServerName, setServerSecurity, setSocketConnectTimeout, setTraceLevel, setUserName
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ECIManagedConnectionFactory

public ECIManagedConnectionFactory()
Method Detail

createConnectionFactory

public java.lang.Object createConnectionFactory()
                                         throws javax.resource.ResourceException
This method is the default route to creating ECIConnectionFactory objects. The returned object will be associated with the supplied DefaultConnectionManager that it will use in its factory methods. If this method is invoked then it implies we are in non managed mode.

Returns:
The new ECIConnectionFactory object.
Throws:
javax.resource.ResourceException

hashCode

public int hashCode()
Returns a hashcode based on all configurable properties.

Specified by:
hashCode in interface javax.resource.spi.ManagedConnectionFactory
Overrides:
hashCode in class CICSManagedConnectionFactory
Returns:
A hashcode for this instance.

createConnectionFactory

public java.lang.Object createConnectionFactory(javax.resource.spi.ConnectionManager cm)
                                         throws javax.resource.ResourceException
This method allows a ConnectionManager to be specified as the one to be used by the returned ECIConnectionFactory.

Parameters:
cm - The ConnectionManager object to associate with the new ECIConnectionFactory.
Returns:
The new ECIConnectionFactory object.
Throws:
javax.resource.ResourceException

equals

public boolean equals(java.lang.Object inObj)
This method returns true if two ECIManagedConnectionFactory objects are equal.

Specified by:
equals in interface javax.resource.spi.ManagedConnectionFactory
Overrides:
equals in class CICSManagedConnectionFactory
Parameters:
inObj - The object to be tested for equality.
Returns:
Whether the ECIManagedConnectionFactory is equal to the supplied object.

toString

public java.lang.String toString()
Returns a string representation of this object.

Overrides:
toString in class CICSManagedConnectionFactory
Returns:
A string representation of this object.

getTranName

public java.lang.String getTranName()
Accessor for tranName. The called program runs under the default mirror transaction, but is linked to under the tranName transaction name. This name is available to the called program in the exec interface block (EIB) for querying the transaction ID.

Returns:
The current tranName to run under.

getTPNName

public java.lang.String getTPNName()
Accessor for TPNName. This is the name of the CICS mirror transaction that the called program will run under. This option is like the TRANSID option on an EXEC CICS LINK command. A transaction definition in CICS for this TRANSID must point to the DFHMIRS program. Note that TPNName takes precedence if both TranName and TPNName are specified.

Returns:
The current TPNName to run under.

setTranName

public void setTranName(java.lang.String name)
Setter for tranName. The called program runs under the default mirror transaction, but is linked to under the tranName transaction name. This name is available to the called program in the exec interface block (EIB) for querying the transaction ID.

Parameters:
name - The new tranName to use.

setTPNName

public void setTPNName(java.lang.String name)
Setter for TPNName. This is the name of the CICS mirror transaction that the called program will run under. This option is like the TRANSID option on an EXEC CICS LINK command. A transaction definition in CICS for this TRANSID must point to the DFHMIRS program. Note that TPNName takes precedence if both TranName and TPNName are specified.

Parameters:
name - The new TPNName to use.

©Copyright IBM Corp. 1994, 2014
Legal