CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.connector2.cics
Class EPIManagedConnectionFactory

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

public final class EPIManagedConnectionFactory
extends CICSManagedConnectionFactory

An EPIManagedConnectionFactory is used to create physical EPI 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
EPIManagedConnectionFactory()
          Default constructor.
 
Method Summary
 java.lang.Object createConnectionFactory()
          This will create an EPIConnectionFactory.
 java.lang.Object createConnectionFactory(javax.resource.spi.ConnectionManager manager)
          This will create an EPIConnectionFactory.
 boolean equals(java.lang.Object inObj)
          Returns true if all the configurable properties are equal.
 java.lang.String getDeviceType()
          Return the current device type.
 java.lang.String getEncoding()
          Return the current encoding.
 java.lang.Integer getInstallTimeout()
          Get the install timeout value in seconds.
 java.lang.String getLogonLogoffClass()
          Return the current logonLogoff class name.
 java.lang.Integer getReadTimeout()
          Returns the current read timeout value in seconds.
 java.lang.Integer getSignonType()
          Return the sign on type:
 int hashCode()
          Returns a hashcode based on all configurable properties.
 void setDeviceType(java.lang.String strDevice)
          Set the device type that terminals created through this factory should use.
 void setEncoding(java.lang.String strEncoding)
          Set the encoding you wish to have the 3270 datastreams converted to and send to the CICS server.
 void setInstallTimeout(java.lang.Integer iInstallTimeout)
          Set the install timeout.
 void setLogonLogoffClass(java.lang.String strLogonLogoff)
          Set the logonLogoff class to be instantiated and called if a signon capable or signon unknown terminal is created.
 void setReadTimeout(java.lang.Integer iReadTimeout)
          Set the read timeout.
 void setSignonType(java.lang.Integer newSignon)
          Set the sign on type:
0 = Signon Capable
1 = Signon InCapable
 java.lang.String toString()
          Return a string representation of this class.
 
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

EPIManagedConnectionFactory

public EPIManagedConnectionFactory()
Default constructor. All properties must be configured via the setters as this object won't be valid until properties have been set.

Method Detail

setSignonType

public void setSignonType(java.lang.Integer newSignon)
Set the sign on type:
0 = Signon Capable
1 = Signon InCapable

Invalid value results in Signon Capable.

Parameters:
newSignon - The sign on type required

getSignonType

public java.lang.Integer getSignonType()
Return the sign on type:

0 = Signon Capable
1 = Signon Incapable

Returns:
Signon Type.

setEncoding

public void setEncoding(java.lang.String strEncoding)
Set the encoding you wish to have the 3270 datastreams converted to and send to the CICS server. The encodings should be one of the java encodings. Not all are supported by this resource adapter and you must ensure your cics server supports it as well.

Parameters:
strEncoding - The Java Encoding to use for 3270 datastreams.

getEncoding

public java.lang.String getEncoding()
Return the current encoding.

Returns:
Current encoding.

setDeviceType

public void setDeviceType(java.lang.String strDevice)
Set the device type that terminals created through this factory should use.

Parameters:
strDevice - The device type.

getDeviceType

public java.lang.String getDeviceType()
Return the current device type.

Returns:
The current device type.

setLogonLogoffClass

public void setLogonLogoffClass(java.lang.String strLogonLogoff)
Set the logonLogoff class to be instantiated and called if a signon capable or signon unknown terminal is created.

Parameters:
strLogonLogoff - The fully qualified class name.

getLogonLogoffClass

public java.lang.String getLogonLogoffClass()
Return the current logonLogoff class name.

Returns:
The logonlogoff class name.

setReadTimeout

public void setReadTimeout(java.lang.Integer iReadTimeout)
Set the read timeout. This value, in seconds, defines the maximum time allowed to wait within a conversional transaction with no reply, before the transaction is abended. Range is 0 - 3600. If < 0 the value is set to 0. If > 3600 the value is set to 3600.

Parameters:
iReadTimeout - The read timeout value in seconds.

getReadTimeout

public java.lang.Integer getReadTimeout()
Returns the current read timeout value in seconds.

Returns:
The current read timeout in seconds.

setInstallTimeout

public void setInstallTimeout(java.lang.Integer iInstallTimeout)
Set the install timeout. This value, in seconds, defines the maximum time to wait for a terminal to install before giving up and no terminal being returned Range is 0 - 3600. If < 0 the value is set to 0. If > 3600 the value is set to 3600.

Parameters:
iInstallTimeout - The install timeout in seconds.

getInstallTimeout

public java.lang.Integer getInstallTimeout()
Get the install timeout value in seconds.

Returns:
The install timeout in seconds.

createConnectionFactory

public java.lang.Object createConnectionFactory()
                                         throws javax.resource.ResourceException
This will create an EPIConnectionFactory. An application will obtain one of these and use it to create connections associated with managed connections that are created by this factory.

This method creates a connection factory in a non managed environment, so a supplied default connection manager is used rather than an application server environment.

Throws:
resourceException
javax.resource.ResourceException

createConnectionFactory

public java.lang.Object createConnectionFactory(javax.resource.spi.ConnectionManager manager)
                                         throws javax.resource.ResourceException
This will create an EPIConnectionFactory. An application will obtain one of these and use it to create connections associated with managed connections that are created by this factory.

This method creates a connection factory in a managed environment, so will be invoked by an application server, providing it's own connection manager.

Parameters:
manager - A suitable ConnectionManager to be associated with the EPIConnectionFactory.
Throws:
resourceException
javax.resource.ResourceException

equals

public boolean equals(java.lang.Object inObj)
Returns true if all the configurable properties are equal.

Specified by:
equals in interface javax.resource.spi.ManagedConnectionFactory
Overrides:
equals in class CICSManagedConnectionFactory
Returns:
True if all configurable properties are equal.

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.

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 CICSManagedConnectionFactory
Returns:
A string representation of this instance.

©Copyright IBM Corp. 1994, 2014
Legal