com.ibm.connector2.ims.ico

Class IMSManagedConnection

  1. java.lang.Object
  2. extended bycom.ibm.connector2.ims.ico.IMSManagedConnection
All implemented interfaces:
com.ibm.ims.ico.IMSICOProperties

  1. public abstract class IMSManagedConnection
  2. extends java.lang.Object
  3. implements com.ibm.ims.ico.IMSICOProperties
An IMSManagedConnection is an abstract class for the IMS managed connection that represents a physical connection to IMS via IMS Connect. This class contains methods and properties for handling generic (non-communication-protocol specific) connection interactions with IMS Connect.

Java applications using the Common Client Interface (CCI) do not directly reference IMSManagedConnection.


Field Summary

Modifier and Type Field and Description
  1. java.lang.String
iconDestID
Fields inherited from interface com.ibm.ims.ico.IMSICOProperties
COMMIT_THEN_SEND, DEFAULT_ALTCLIENTID_NAME, DEFAULT_CANCELTIMER, DEFAULT_CM0DEDICATED, DEFAULT_CM0RESPONSE, DEFAULT_COMMIT_MODE, DEFAULT_CONVID_HEX_ZEROES, DEFAULT_CONVID_STRING, DEFAULT_CURRENT_SEGMENT, DEFAULT_DATASTORE_NAME, DEFAULT_ENCRYPTYPE, DEFAULT_GROUPNAME, DEFAULT_HOSTNAME, DEFAULT_IGNORE_PURG_CALL, DEFAULT_IMSCONNNAME, DEFAULT_ISSSL, DEFAULT_KEYSTORENAME, DEFAULT_KEYSTOREPASSWD, DEFAULT_LTERM_NAME, DEFAULT_MAP_NAME, DEFAULT_PASSWORD, DEFAULT_PORTNUMBER, DEFAULT_REROUTE_NAME, DEFAULT_TRANSEXPIRATION, DEFAULT_TRUSTSTORENAME, DEFAULT_TRUSTSTOREPASSWD, DEFAULT_USECONVID, DEFAULT_USERNAME, ENCRYPTYPE_0, ENCRYPTYPE_1, ENCRYPTYPE_2, IBM_SSL_CERT_TYPE, MAX_ALTCLIENTIDNAME, MAX_CIPHER_ARRAY, MAX_CLIENTID, MAX_CONVID_STRING, MAX_DATASTORENAME, MAX_GROUPNAME, MAX_IMSCONNNAME, MAX_LTERMNAME, MAX_MAPNAME, MAX_PASSWORD, MAX_REROUTENAME, MAX_SSLSTOREPASSWORD, MAX_USERNAME, MODE_ACK_TEXT, MODE_COMMIT_TEXT, MODE_END_CONVERSATION_TEXT, MODE_FORGET_TEXT, MODE_NACK_TEXT, MODE_PREPARE_TEXT, MODE_RECEIVE_ASYNCOUTPUT_AUTO_TEXT, MODE_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT_TEXT, MODE_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT_TEXT, MODE_RECEIVE_ASYNCOUTPUT_TEXT, MODE_RECEIVE_TEXT, MODE_RECOVER_TEXT, MODE_ROLLBACK_TEXT, MODE_SEND_ONLY_TEXT, MODE_SEND_RECEIVE_TEXT, MODE_SYNCCAL_RESPONSE_TEXT, SEND_THEN_COMMIT, SSL_PROVIDER, SSL_STORE_TYPE_JCE4758RACFKS, SSL_STORE_TYPE_JCERACFKS, SSL_STORE_TYPE_JKS, SUN_SSL_CERT_TYPE, SYNC_LEVEL_CONFIRM, SYNC_LEVEL_NONE, SYNC_LEVEL_SYNCPT

Method Summary

Modifier and Type Method and Description
  1. void
addConnectionEventListener(javax.resource.spi.ConnectionEventListener aListener)
Used by the application server to register a listener interested in receiving notification of events associated with this IMSManagedConnection instance.
  1. void
associateConnection(java.lang.Object handle)
Associates a connection handle with an IMSManagedConnection instance.
  1. void
cleanup()
Called by the application server to clean up any client-specific state data maintained by an IMSManagedConnection instance and put the IMSManagedConnection instance back in the pool.
  1. void
destroy()
Closes the physical connection and releases all system resources held by the associated IMSManagedConnection instance.
  1. void
dissociateConnections()
Called by an application server that is capable of lazy connection association in order to dissociate a ManagedConnection instance from all of its connection handles.
  1. ConnectionEventListener
getARMListener()
  1. java.lang.String
getClientID()
  1. java.lang.Object
getConnection(javax.security.auth.Subject aSubject,ConnectionRequestInfo aConnectionRequestInfo)
Called by the application server to create a new application-level handle to an object that represents an underlying physical connection (an IMSManagedConnection instance).
  1. javax.resource.spi.LocalTransaction
getLocalTransaction()
Returns a javax.resource.spi.LocalTransaction instance that enables the application server to manage local transactions for the resource manager.
  1. java.io.PrintWriter
getLogWriter()
Returns a reference to the logWriter to allow the client application to write messages to the trace log.
  1. IMSManagedConnectionFactory
getMCFactory()
Insert the method's description here.
  1. javax.resource.spi.ManagedConnectionMetaData
getMetaData()
Returns the IMSMangedConnectionMetaData instance which contains information about the associated IMSManagedConnection instance.
  1. java.lang.Integer
getTraceLevel()
Returns the value of the traceLevel property.
  1. javax.transaction.xa.XAResource
getXAResource()
Returns a javax.transaction.xa.XAResource instance that enables the application server to demarcate global transactions with a resource manager .
  1. void
removeConnectionEventListener(javax.resource.spi.ConnectionEventListener aListener)
The application server uses the removeConnectionEventListener method to remove a connection listener from an IMSManagedConnection instance.
  1. void
setLogWriter(java.io.PrintWriter aLogWriter)
Sets the value of the logWriter property.
  1. void
setTraceLevel(java.lang.Integer aTraceLevel)
Sets the value of the traceLevel property.
  1. boolean
testConnection()
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

iconDestID

  1. public java.lang.String iconDestID

Method Detail

addConnectionEventListener

  1. public void addConnectionEventListener( javax.resource.spi.ConnectionEventListener aListener)
Used by the application server to register a listener interested in receiving notification of events associated with this IMSManagedConnection instance.
Parameters:
aListener - An interested listener (the application server.)

associateConnection

  1. public void associateConnection( java.lang.Object handle)
  2. throws javax.resource.ResourceException

Associates a connection handle with an IMSManagedConnection instance. In the case of lazy connection association, associateConnection is invoked by the connection manager so that a connection handle can be returned to the active state.

Used by the application server to change the association of an application-level connection handle (IMSConnection object) with a ManagedConnection instance (IMSManagedConnection instance). The application server finds the right ManagedConnection instance and calls the associateConnection method.

The method implementation for a ManagedConnection should dissociate the connection handle (passed as a parameter) from its currently associated ManagedConnection and associate the new connection handle with itself.

Parameters:
handle - A connection handle to be reassociated.
Throws:
javax.resource.ResourceException - If handle passed is not of type IMSConnection.

cleanup

  1. public void cleanup()
  2. throws javax.resource.ResourceException

Called by the application server to clean up any client-specific state data maintained by an IMSManagedConnection instance and put the IMSManagedConnection instance back in the pool. This includes invalidating all connection handles associated with the instance. The application server calls cleanup() after the end of a connection sharing scope or when the last associated connection handle is closed for an IMSManagedConnection instance.

The cleanup() method does not close the physical connection (for example, a TCP/IP socket) to IMS Connect.

Throws:
javax.resource.ResourceException - A problem was encountered while resetting the state of this IMSManagedConnection instance.

testConnection

  1. public boolean testConnection()

destroy

  1. public void destroy()
  2. throws javax.resource.ResourceException
Closes the physical connection and releases all system resources held by the associated IMSManagedConnection instance. It is called by the application server:
  • To manage the size of the connection pool
  • To disconnect when it receives a connection error event indicating a fatal error on the physical connection
Throws:
javax.resource.ResourceException - If problems were encountered in closing the connection.

getConnection

  1. public java.lang.Object getConnection( javax.security.auth.Subject aSubject,
  2. ConnectionRequestInfo aConnectionRequestInfo)
  3. throws javax.resource.ResourceException

Called by the application server to create a new application-level handle to an object that represents an underlying physical connection (an IMSManagedConnection instance).

This method may be called by the application server to re-authenticate a physical connection (when the physical connection already exists in the pool under a different security context.) Re-authentication is allowed if no active connection handles are currently associated with the IMSManagedConnection instance. With re-authentication, the getConnection method changes the security context of the underlying IMS managed connection instance and returns a new connection handle in the form of an IMSConnection instance.

Parameters:
aSubject - Security information for container-managed EIS sign-on.
aConnectionRequestInfo - Security information for component-managed EIS sign-on.
Returns:
A new IMSConnection instance.
Throws:
javax.resource.ResourceException - An internal problem was encountered while executing the getConnection method.

getLocalTransaction

  1. public javax.resource.spi.LocalTransaction getLocalTransaction( )
  2. throws javax.resource.ResourceException
Returns a javax.resource.spi.LocalTransaction instance that enables the application server to manage local transactions for the resource manager.
Returns:
A LocalTransaction instance.
Throws:
javax.resource.ResourceException
See Also:
IMSLocalTransaction

getLogWriter

  1. public java.io.PrintWriter getLogWriter( )
Returns a reference to the logWriter to allow the client application to write messages to the trace log.
Returns:
The logWriter property value.
See Also:

getMetaData

  1. public javax.resource.spi.ManagedConnectionMetaData getMetaData( )
  2. throws javax.resource.ResourceException
Returns the IMSMangedConnectionMetaData instance which contains information about the associated IMSManagedConnection instance.
Returns:
The IMSMangedConnectionMetaData instance.
Throws:
javax.resource.ResourceException

getTraceLevel

  1. public java.lang.Integer getTraceLevel( )
Returns the value of the traceLevel property. The traceLevel value determines the level of detail written to the trace log.
Returns:
The trace level of the IMS managed connection instance.
See Also:

getXAResource

  1. public javax.transaction.xa.XAResource getXAResource( )
  2. throws javax.resource.ResourceException
Returns a javax.transaction.xa.XAResource instance that enables the application server to demarcate global transactions with a resource manager .

An application server enlists this XAResource instance with a transaction manager if the ManagedConnection instance is used in a JTA transaction that is coordinated by the transaction manager.

Returns:
An XAResource instance.
Throws:
javax.resource.ResourceException
See Also:
IMSXAResource

getMCFactory

  1. public IMSManagedConnectionFactory getMCFactory( )
Insert the method's description here.

removeConnectionEventListener

  1. public void removeConnectionEventListener( javax.resource.spi.ConnectionEventListener aListener)
The application server uses the removeConnectionEventListener method to remove a connection listener from an IMSManagedConnection instance.

setLogWriter

  1. public void setLogWriter(java.io.PrintWriter aLogWriter)
  2. throws javax.resource.ResourceException
Sets the value of the logWriter property. A log writer is a character output stream to which all logging and tracing messages are printed.
Parameters:
aLogWriter - The new value for the logWriter property.
Throws:
javax.resource.ResourceException
See Also:

setTraceLevel

  1. public void setTraceLevel(java.lang.Integer aTraceLevel)
Sets the value of the traceLevel property.
Parameters:
aTraceLevel - The new value for the traceLevel property.
See Also:

dissociateConnections

  1. public void dissociateConnections( )
  2. throws ResourceException
Called by an application server that is capable of lazy connection association in order to dissociate a ManagedConnection instance from all of its connection handles.
Throws:
ResourceException

getARMListener

  1. public ConnectionEventListener getARMListener( )

getClientID

  1. public java.lang.String getClientID( )