IMS TM Resource Adapter Version 11
Serialized Form
| Package com.ibm.connector2.ims.ico |
connectionManager
javax.resource.spi.ConnectionManager connectionManager
- The connection manager that manages the connections for this factory.
managedConnectionFactory
IMSManagedConnectionFactory managedConnectionFactory
- The IMSManagedConnectionFactory that created this IMSConnectionFactory instance.
resourceAdapterMetaData
IMSResourceAdapterMetaData resourceAdapterMetaData
- Information about the resource adapter (IMS TM Resource Adapter).
reference
javax.naming.Reference reference
- For javax.resource.Referenceable
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceAccess extends java.lang.Object implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_cs extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_de extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_es extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_fr extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_hu extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_it extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_ja extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_ko extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_pl extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_pt_BR extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_ru extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_zh extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_zh_HK extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSConnectionSpecToolResourceBundle_zh_TW extends java.util.ListResourceBundle implements
Serializable |
messages
java.util.Vector<E> messages
| Class com.ibm.connector2.ims.ico.IMSInputStreamRecord extends com.ibm.j2ca.base.BaseInputStreamRecord implements
Serializable |
serialVersionUID: -5184819107117747369L
logWriter
java.io.PrintWriter logWriter
- Log writer for logging and tracing specific to the IMSManagedConnection instance for this IMSAdapter instance. If logWriter is null, logging and tracing are disabled. If logWriter is not
null, the value of traceLevel controls logging and tracing.
classHashName
java.lang.String classHashName
buffer_
byte[] buffer_
size
int size
logUtil
com.ibm.j2ca.extension.logging.LogUtils logUtil
interactionVerb
int interactionVerb
- Defines the mode of the interaction with IMS via IMS Connect.
asyncOutputAvailable
boolean asyncOutputAvailable
- Indicates if there is any asynchronous output message available. This is an output property.
purgeAsyncOutput
boolean purgeAsyncOutput
-
This property exposes the "purgeNotDeliverable" function of IMS Connect. This property controls whether or not IMS Connect will purge undelivered I/O PCB output and applies to
Commit Mode 0 interactions on shareable persistent socket connections. IMS TM Resource Adapter will not support this property on dedicated persistent sockets.
The property purgeAsyncOutput is only valid for SYNC_SEND_RECEIVE interactions on shareable persistent socket connections. It is not valid for SYNC_SEND or
SYNC_RECEIVE_ASYNCOUTPUT interactions or for SYNC_SEND_RECEIVE interactions on dedicated persistent socket connections.
If purgeAsyncOutput is TRUE the following output messages will be purged:
- Undelivered output message inserted to the I/O PCB by the primary IMS application program
- Output messages inserted to the I/O PCB by secondary IMS application programs invoked by "Program to Program" switch
If the purgeAsyncOutput property is not specified on a SYNC_SEND_RECEIVE interaction on a shareable persistent socket connection, the default will be TRUE.
If the purgeAsyncOutput property is not specified on SYNC_RECEIVE_ASYNCOUTPUT, SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT, SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT, or SYNC_SEND
interactions on a shareable persistent socket connection, the default will be FALSE.
reRoute
boolean reRoute
-
This property controls whether or not undelivered I/O PCB output will be rerouted to a named destination and only applies to CM0 output. If reRoute is TRUE, the asynchronous
output will not be queued to the TPIPE of the generated clientID. Instead it will be queued to the named destination.
The property reRoute is only valid for SYNC_SEND_RECEIVE interactions on shareable persistent socket connections. It is not valid for SYNC_SEND or SYNC_RECEIVE_ASYNCOUTPUT
interactions or for SYNC_SEND_RECEIVE interactions on dedicated persistent socket connections. The default value for reRoute is FALSE.
If both reRoute and purgeAsyncOutput are set to TRUE, an exception is thrown.
commitMode
int commitMode
- Defines the type of Commit Mode associated with the interaction with IMS via IMS Connect.
imsRequestType
int imsRequestType
- Defines the type of IMS request associated with the interaction with IMS via IMS Connect.
ltermName
java.lang.String ltermName
- Defines the LTERM override value. The value of this property will be placed in the IO/PCB for use by the IMS application program. It is up to the application program how this value is
used. For example, it may be used as an alternate destination for the output message.
mapName
java.lang.String mapName
- Defines the name of the MFS Message Input Descriptor (MFS MID) or MFS Message Output Descriptor (MFS MOD) associated with this interaction.
reRouteName
java.lang.String reRouteName
-
If reRoute is TRUE, this property is used to provide the name of a destination to which asynchronous output will be queued. If reRoute is FALSE, the reRouteName
property will be ignored.
If reRoute is TRUE, and no reRouteName is provided, the value for reRouteName will be as follows:
- The value specified in the IMS Connect configuration file
- If no value is specified in the IMS Connect configuration file, the value "HWS$DEF" will be used
The property reRouteName is only valid for SYNC_SEND_RECEIVE interactions on shareable persistent socket connections. It is not valid for any interactions on dedicated
persistent socket connections.
convEnded
boolean convEnded
- Indicates if the IMS conversational transaction is in progress or has ended. This is an output property.
executionTimeout
int executionTimeout
- Defines the ExecutionTimeout value associated with the interaction with IMS via IMS Connect.
convertedTimeoutValue
int convertedTimeoutValue
- Defines the converted ExecutionTimeout associated with the interaction with IMS via IMS Connect.
timeoutIndexValue
int timeoutIndexValue
- Defines the ExecutionTimeout index value associated with the interaction with IMS via IMS Connect.
socketTimeout
int socketTimeout
- Defines the SocketTimeout value associated with the interaction with IMS via IMS Connect.
syncLevel
int syncLevel
- Defines the Synchronization Level for the IMS interaction
syncLevelSet
boolean syncLevelSet
- Property that indicates whether the Sync Level was explicitly set
altClientID
java.lang.String altClientID
- Defines the Alternate ClientID value that indicates the name of an asynchronous output queue/Tpipe to retrieve messages from during a ResumeTpipe request to IMS Connect using a shareable
persistent socket connection (TODO: himakar - add more (documentation) info based on the ResumeTpipe interaction table in FPS)
ignorePURGCall
boolean ignorePURGCall
- This property controls whether or not the PURG call in an CM0 IMS application should be ignored. If the ignorePURGCall is true, the PURG call in the CM0 IMS application will be
ignored such that output for the mutliple PURG calls will be sent back as a single output message with multiple segments. If the ignorePURGCall is false, the PURG call in the CM0 IMS
application will be not be ignored such that output for the mutliple PURG calls will be sent back as separate output messages. The first output message will be delivered to the client and the
subsequent messages will be NAK and reamin in the asynchronous hold queue for that client. The default value for ignorePURGCall is false. The ignorePURGCall flag is valid
for SYNC_SEND_RECEIVE interactions on shareable persistent socket connections and is applicable with Commit Mode 0. If the flag is set for a Commit Mode 1 interaction, the flag can be set,
but there is no effect on the PURG calls. The ignorePURGCall flag is not valid for SYNC_SEND, SYNC_END_CONVERSATION or SYNC_RECEIVE_ASYNCOUTPUT_* interactions or for
SYNC_SEND_RECEIVE interactions on dedicated persistent socket connections. An exception will be thrown.
convID
java.lang.String convID
- Defines the conversational id which corresponds to the Transaction Instance Block (TIB) token which is a timestamp This String is a hexadecimal string of characters converted from a byte
array. This is a input/output property
useConvID
boolean useConvID
- Defines a flag indicating whether an IMS conversation will be using the same connection for all the iterations (false) OR may be using any connection (shareable connection from
the same connection pool) for all the iterations (true). If the value is "true" (client-managed conversation state programming model), then the client application needs to
save the value of the conversation ID (convID) that gets generated at the end of the first iteration and pass it back-and-forth between the client application and IMS Connect in all the
subsequent iterations of the conversation. If the value is "false", the conversation state is managed by IMS Connect (connect-managed conversation state programming model) OR it is
a non-conversational transaction. The default for the runtime code will be false so that existing conversational applications need not change or migrate; a false value may also indicate that
it is a non-conversational transaction. Whereas the EMD code, will set this to true so that new conversational applications can start taking advantage of this flag by being connection
agnostic across iterations. This is an input property
syncCalloutCorrelatorToken
byte[] syncCalloutCorrelatorToken
calloutRequestType
int calloutRequestType
syncCalloutStatusCode
int syncCalloutStatusCode
transExpiration
boolean transExpiration
- This constant provides a default value for the transExpiration property of an IMSInteractionSpect object.
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceAccess extends java.lang.Object implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_cs extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_de extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_es extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_fr extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_hu extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_it extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_ja extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_ko extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_pl extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_pt_BR extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_ru extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_zh extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_zh_HK extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSInteractionSpecToolResourceBundle_zh_TW extends java.util.ListResourceBundle implements
Serializable |
supportsLazyConnAssociation
boolean supportsLazyConnAssociation
- Indicates if a connection handle for a ManagedConnection instance created by this ManagedConnectionFactory can be dissociated from its ManagedConnection instance. A value of true
indicates that the ConnectionManager being used with this instance of the resource adapter supports lazy connection association.
traceLevel
int traceLevel
- Trace level for logging and tracing specific to this IMSManagedConnectionFactory instance. See IMSTraceLevelProperties for definitions of trace levels.
HostName
java.lang.String HostName
- TCP/IP hostname of machine running IMS Connect. This property is a configurable property of IMSManagedConnectionFactory.
PortNumber
java.lang.Integer PortNumber
- Port number of an IMS Connect instance. Note that port numbers must be unique across all IMS Connect instances on a TCP/IP host machine. This property is a configurable property of
IMSManagedConnectionFactory.
IMSConnectName
java.lang.String IMSConnectName
- IMS Connect Name. This property is a configurable property of IMSManagedConnectionFactory.
DataStoreName
java.lang.String DataStoreName
- Name of target IMS datastore. This property is a configurable property of IMSManagedConnectionFactory, but is not used in the equals() and hashCode() methods.
UserName
java.lang.String UserName
- Default user name. This property is a configurable property of IMSManagedConnectionFactory, but is not used in the equals() and hashCode() methods.
Password
java.lang.String Password
- Default password. This property is a configurable property of IMSManagedConnectionFactory, but is not used in the equals() and hashCode() methods.
GroupName
java.lang.String GroupName
- Default group name. This property is a configurable property of IMSManagedConnectionFactory, but is not used in the equals() and hashCode() methods.
SSLEnabled
java.lang.Boolean SSLEnabled
- SSLEnabled is a Boolean variable whose value indictes if an SSL connection is desired or not. A true value indicates the use of SSL and a false value indicates that SSL is not
required.
SSLKeyStoreName
java.lang.String SSLKeyStoreName
- SSLKeyStoreName is the filename (along with the fullpath) of the keyStore which contains keys required during the SSL handshake. It usually holds private keys for the client but it can
also be used to store public keys or certificates.
SSLKeyStorePassword
java.lang.String SSLKeyStorePassword
- SSLKeyStorePasswd is the password for the keyStore file which contains keys.
SSLTrustStoreName
java.lang.String SSLTrustStoreName
- SSLTrustStoreName is the filename (along with the fullpath) of the keyStore which contains keys required during the SSL handshake. It usually holds public keys or certificates but it can
also be used to store private keys for the client .
SSLTrustStorePassword
java.lang.String SSLTrustStorePassword
- SSLTrustStorePasswd is the password for the keyStore file which contains keys.
SSLEncryptionType
java.lang.String SSLEncryptionType
- SSLEncryptionType is the Encryption Type for the SSL connection. It can have a value of "Strong" for strong encryption, i.e encryption with ciphers that have large key sizes or
it can have a value of "Weak" for weak encryption, i.e encryption with ciphers that have small key sizes.
CM0Dedicated
java.lang.Boolean CM0Dedicated
- CM0Dedicated is a Boolean variable whose value, if TRUE, indictes if the IMSManagedConnectionFactory creates IMSManagedConnection objects with sockets dedicated to a particular clientID.
Default is FALSE.
tmcf
long tmcf
- Tmcf is an internal timestamp value used in the socket reconnect support to keep track of the time that an error has been occurred in its socket connections.
classHashName
java.lang.String classHashName
myResourceAdapter
com.ibm.connector2.ims.ico.IMSResourceAdapter myResourceAdapter
- JCA 1.5 associates a ManagedConnectionFactory JavaBean with a ResourceAdapter.
dynamicTranRegEnabled
boolean dynamicTranRegEnabled
- Indicates if the Resource Adapter supports the JCA 1.0 Extension - Deferred Enlistment or not.
RRSTransactional
boolean RRSTransactional
TransactionResourceRegistration
java.lang.String TransactionResourceRegistration
LocalOptionThreadIdentitySupport
java.lang.String LocalOptionThreadIdentitySupport
TCPIPThreadIdentitySupport
java.lang.String TCPIPThreadIdentitySupport
threadSecurity
boolean threadSecurity
- IMS TM Resource Adapter does not need Connection Management to place an ACEE on the OS thread with the user identity associated with the current thread.
logUtil
com.ibm.j2ca.extension.logging.LogUtils logUtil
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceAccess extends java.lang.Object implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_cs extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_de extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_es extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_fr extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_hu extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_it extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_ja extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_ko extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_pl extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_pt_BR extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_ru extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_zh extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_zh_HK extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSManagedConnectionFactoryToolResourceBundle_zh_TW extends java.util.ListResourceBundle implements
Serializable |
| Class com.ibm.connector2.ims.ico.IMSOutputStreamRecord extends com.ibm.j2ca.base.BaseOutputStreamRecord implements
Serializable |
DEFAULT_ENCODING
java.lang.String DEFAULT_ENCODING
DEFAULT_TRANCODELENGTH
int DEFAULT_TRANCODELENGTH
DEFAULT_SIZE
int DEFAULT_SIZE
logWriter
java.io.PrintWriter logWriter
- Log writer for logging and tracing specific to the IMSManagedConnection instance for this IMSAdapter instance. If logWriter is null, logging and tracing are disabled. If logWriter is not
null, the value of traceLevel controls logging and tracing.
logUtil
com.ibm.j2ca.extension.logging.LogUtils logUtil
CLASSNAME
java.lang.String CLASSNAME
classHashName
java.lang.String classHashName
buffer_
byte[] buffer_
| Package com.ibm.connector2.ims.ico.inbound |
HostName
java.lang.String HostName
PortNumber
java.lang.Integer PortNumber
- Port number of an IMS Connect instance. Note that port numbers must be unique across all IMS Connect instances on a TCP/IP host machine. This property is a configurable property of
IMSActivationSpec
DataStoreName
java.lang.String DataStoreName
- Name of target IMS datastore. This property is a configurable property of IMSActivationSpec, but is not used in the equals() and hashCode() methods.
QueueNames
java.lang.String QueueNames
- A comma-delimited list of names of queues to listen to for inbound messages. This property is a configurable property of IMSActivationSpec
UserName
java.lang.String UserName
- Default user name. This property is a configurable property of IMSActivationSpec, but is not used in the equals() and hashCode() methods.
Password
java.lang.String Password
- Default password. This property is a configurable property of IMSActivationSpec, but is not used in the equals() and hashCode() methods.
GroupName
java.lang.String GroupName
- Default group name. This property is a configurable property of IMSActivationSpec, but is not used in the equals() and hashCode() methods.
SSLEnabled
java.lang.Boolean SSLEnabled
- SSLEnabled is a Boolean variable whose value indictes if an SSL connection is desired or not. A true value indicates the use of SSL and a false value indicates that SSL is not
required.
SSLKeyStoreName
java.lang.String SSLKeyStoreName
- SSLKeyStoreName is the filename (along with the fullpath) of the keyStore which contains keys required during the SSL handshake. It usually holds private keys for the client but it can
also be used to store public keys or certificates.
SSLKeyStorePassword
java.lang.String SSLKeyStorePassword
- SSLKeyStorePasswd is the password for the keyStore file which contains keys.
SSLTrustStoreName
java.lang.String SSLTrustStoreName
- SSLTrustStoreName is the filename (along with the fullpath) of the keyStore which contains keys required during the SSL handshake. It usually holds public keys or certificates but it can
also be used to store private keys for the client .
SSLTrustStorePassword
java.lang.String SSLTrustStorePassword
- SSLTrustStorePasswd is the password for the keyStore file which contains keys.
SSLEncryptionType
java.lang.String SSLEncryptionType
- SSLEncryptionType is the Encryption Type for the SSL connection. It can have a value of "Strong" for strong encryption, i.e encryption with ciphers that have large key sizes or
it can have a value of "Weak" for weak encryption, i.e encryption with ciphers that have small key sizes.
| Class com.ibm.connector2.ims.ico.inbound.IMSInboundInteractionSpec extends java.lang.Object implements
Serializable |
serialVersionUID: -4689688689848196645L
mapName
java.lang.String mapName
queueName
java.lang.String queueName