Package All Classes All Fields and Methods Deprecated


com.ibm.connector2.ims.ico
Class IMSInteractionSpec

java.lang.Object
  extended bycom.ibm.connector2.ims.ico.IMSInteractionSpec
All Implemented Interfaces:
com.ibm.ims.ico.IMSICOProperties, IMSInteractionSpecProperties, javax.resource.cci.InteractionSpec, java.io.Serializable

public class IMSInteractionSpec
extends java.lang.Object
implements javax.resource.cci.InteractionSpec, java.io.Serializable, IMSInteractionSpecProperties, com.ibm.ims.ico.IMSICOProperties

An instance of this class contains properties that are used in an interaction with IMS via IMS Connect.

See Also:
IMSInteraction.execute(InteractionSpec, Record, Record), Serialized Form

Field Summary
 java.beans.PropertyChangeSupport propertyChange
          IMS Connector for Java internal use only.
 
Fields inherited from interface javax.resource.cci.InteractionSpec
SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE
 
Fields inherited from interface com.ibm.connector2.ims.ico.IMSInteractionSpecProperties
DEFAULT_ASYNCOUTPUT_AVAILABLE, DEFAULT_CONVERTED_TIMEOUT_VALUE, DEFAULT_INTERACTION_VERB, DEFAULT_PURGE_ASYNCOUTPUT, DEFAULT_REROUTE, DEFAULT_RUNTIME_IMS_REQUEST_TYPE, DEFAULT_SOTIMEOUT_VALUE, DEFAULT_TIMEOUT_INDEX_VALUE, DEFAULT_TIMEOUT_VALUE, IMS_REQUEST_TYPE_IMS_COMMAND, IMS_REQUEST_TYPE_IMS_TRANSACTION, IMS_REQUEST_TYPE_MFS_TRANSACTION, MAX_TIMEOUT_VALUE, NUM_OF_BASE_VERBS, NUM_OF_IMS_VERBS, NUM_OF_VERBS, SYNC_END_CONVERSATION, SYNC_LEVEL, SYNC_LEVEL_TEXT, SYNC_RECEIVE_ASYNCOUTPUT, SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT, SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT, TIMEOUT_DEFAULT, TIMEOUT_NOWAIT_FLAG, TIMEOUT_SMALL, TIMEOUT_WAITFOREVER_FLAG, VERB_SYNC_END_CONVERSATION_TEXT, VERB_SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT_TEXT, VERB_SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT_TEXT, VERB_SYNC_RECEIVE_ASYNCOUTPUT_TEXT, VERB_SYNC_RECEIVE_TEXT, VERB_SYNC_SEND_RECEIVE_TEXT, VERB_SYNC_SEND_TEXT
 
Fields inherited from interface com.ibm.ims.ico.IMSICOProperties
COMMIT_THEN_SEND, DEFAULT_ALTCLIENTID_NAME, DEFAULT_CM0DEDICATED, DEFAULT_COMMIT_MODE, DEFAULT_CURRENT_SEGMENT, DEFAULT_DATASTORE_NAME, DEFAULT_ENCRYPTYPE, DEFAULT_GROUPNAME, DEFAULT_HOSTNAME, DEFAULT_IMSCONNNAME, DEFAULT_ISSSL, DEFAULT_KEYSTORENAME, DEFAULT_KEYSTOREPASSWD, DEFAULT_LTERM_NAME, DEFAULT_MAP_NAME, DEFAULT_PASSWORD, DEFAULT_PORTNUMBER, DEFAULT_REPOSITORYID, DEFAULT_REPOSITORYURI, DEFAULT_REROUTE_NAME, DEFAULT_TRUSTSTORENAME, DEFAULT_TRUSTSTOREPASSWD, DEFAULT_USERNAME, ENCRYPTYPE_0, ENCRYPTYPE_1, ENCRYPTYPE_2, IBM_SSL_CERT_TYPE, MAX_ALTCLIENTIDNAME, MAX_CIPHER_ARRAY, MAX_CLIENTID, 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_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, 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
 
Constructor Summary
IMSInteractionSpec()
          The default constructor.
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a PropertyChangeListener for all the properties.
 void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
          Adds a PropertyChangeListener for a property.
 void firePropertyChange(java.beans.PropertyChangeEvent evt)
          Fires a PropertyChangeEvent to listeners.
 void firePropertyChange(java.lang.String propertyName, boolean oldValue, boolean newValue)
          Reports a boolean bound property update to any registered listeners.
 void firePropertyChange(java.lang.String propertyName, int oldValue, int newValue)
          Reports an int bound property update to any registered listeners.
 void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
          Reports a String bound property update to any registered listeners.
 java.lang.String getAltClientID()
          Returns the String representation of the altClientID property.
 boolean getAsyncOutputAvailable()
          Returns the value of the asyncOutputAvailable property, indicating whether there are any asynchronous output messages available (true) or not (false).
 int getCommitMode()
          Returns the value of the commitMode property.
 boolean getConvEnded()
          Returns the value of the convEnded property, indicating whether an IMS conversation has ended (true) or is still in progress (false).
 int getExecutionTimeout()
          Returns the value of the executionTimeout property.
 int getImsRequestType()
          Returns the value of the imsRequestType property.
 int getInteractionVerb()
          Returns the value of the interactionVerb property.
static java.lang.String getInteractionVerbText(int interactionVerb)
          Returns the String representation of the interactionVerb property.
 java.lang.String getLtermName()
          Returns the String representation of the ltermName property.
 java.lang.String getMapName()
          Returns the value of the mapName property, typically the name of an MFS Message Output Descriptor (MFS MOD).
 java.beans.PropertyChangeSupport getPropertyChange()
          Accessor for the propertyChange field.
 boolean getPurgeAsyncOutput()
          Returns the value of the purgeAsyncOutput property, indicating whether IMS Connect will purge asynchronous output messages (true) or not (false).
 boolean getReRoute()
          Returns the value of the reRoute property, indicating whether asynchronous output will be rerouted to an alternate destination (true) or not (false).
 java.lang.String getReRouteName()
          Returns the String representation of the reRouteName property.
 int getSocketTimeout()
          Returns the value of the socketTimeout property.
 int getSyncLevel()
           
 boolean hasListeners(java.lang.String propertyName)
          Checks if there are any listeners for a specific property.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a PropertyChangeListener from the listener list.
 void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
          Removes a PropertyChangeListener for a specific property.
 void setAltClientID(java.lang.String newAltClientID)
          Sets the value of the altClientID property.
 void setAsyncOutputAvailable(boolean newAsyncOutputAvailable)
          Sets the value of the asyncOutputAvailable property.
 void setCommitMode(int newCommitMode)
          Sets the commitMode property to a specified value.
 void setConvEnded(boolean newConvEnded)
          Sets the value of the convEnded property.
 void setExecutionTimeout(int newTimeout)
          Sets the value of the executionTimeout property, which is the time it takes for IMS Connect to send an interaction to IMS and receive a response.
 void setImsRequestType(int newImsRequestType)
          Sets the value of the imsRequestType property.
 void setInteractionVerb(int newVerb)
          Sets the value of the interactionVerb property.
 void setLtermName(java.lang.String newLtermName)
          Sets the value of the ltermName property.
 void setMapName(java.lang.String newMapName)
          Sets the value of the mapName property, typically the name of an MFS Message Output Descriptor (MFS MOD).
 void setPurgeAsyncOutput(boolean newPurgeAsyncOutput)
          Sets the value of the purgeAsyncOutput property.
 void setReRoute(boolean newReRoute)
          Sets the value of the reRoute property.
 void setReRouteName(java.lang.String newReRouteName)
          Sets the value of the reRouteName property.
 void setSocketTimeout(int newSoTimeout)
          Sets the value of the socketTimeout property, which is the time IMS Connector for Java will wait on behalf of the client, to receive a reply after sending a message to IMS Connect.
 void setSyncLevel(int newSyncLevel)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

propertyChange

public transient java.beans.PropertyChangeSupport propertyChange
IMS Connector for Java internal use only.

Constructor Detail

IMSInteractionSpec

public IMSInteractionSpec()
The default constructor.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for all the properties.

Parameters:
listener - The PropertyChangeListener to be added.

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for a property.

Parameters:
listener - The PropertyChangeListener to be added.
propertyName - The name of the property to listen on.

firePropertyChange

public void firePropertyChange(java.beans.PropertyChangeEvent evt)
Fires a PropertyChangeEvent to listeners.

Parameters:
evt - The PropertyChangeEvent object.

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               int oldValue,
                               int newValue)
Reports an int bound property update to any registered listeners.

Parameters:
propertyName - The name of the property that was changed.
oldValue - The old value of the property.
newValue - The new value of the property.

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)
Reports a String bound property update to any registered listeners.

Parameters:
propertyName - The name of the property that was changed.
oldValue - The old value of the property.
newValue - The new value of the property.

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               boolean oldValue,
                               boolean newValue)
Reports a boolean bound property update to any registered listeners.

Parameters:
propertyName - The name of the property that was changed.
oldValue - The old value of the property.
newValue - The new value of the property.

getAsyncOutputAvailable

public final boolean getAsyncOutputAvailable()
Returns the value of the asyncOutputAvailable property, indicating whether there are any asynchronous output messages available (true) or not (false).

Returns:
boolean - The value of the asyncOutputAvailable property.

getPurgeAsyncOutput

public final boolean getPurgeAsyncOutput()
Returns the value of the purgeAsyncOutput property, indicating whether IMS Connect will purge asynchronous output messages (true) or not (false).

Returns:
boolean - The value of the purgeAsyncOutput property.

getReRoute

public final boolean getReRoute()
Returns the value of the reRoute property, indicating whether asynchronous output will be rerouted to an alternate destination (true) or not (false).

Returns:
boolean - The value of the reRoute property.

getCommitMode

public final int getCommitMode()
Returns the value of the commitMode property.

Returns:
int - The value of the commitMode property.
See Also:
setCommitMode(int)

getConvEnded

public final boolean getConvEnded()
Returns the value of the convEnded property, indicating whether an IMS conversation has ended (true) or is still in progress (false).

Returns:
boolean - The value of the convEnded property.

getExecutionTimeout

public final int getExecutionTimeout()
Returns the value of the executionTimeout property.

Returns:
int - The value of the executionTimeout property.
See Also:
setExecutionTimeout(int)

getSocketTimeout

public int getSocketTimeout()
Returns the value of the socketTimeout property.

Returns:
int - The value of the socketTimeout property.
See Also:
setSocketTimeout(int)

getImsRequestType

public final int getImsRequestType()
Returns the value of the imsRequestType property.

Returns:
int - The value of the imsRequestType property.
See Also:
setImsRequestType(int)

getInteractionVerb

public final int getInteractionVerb()
Returns the value of the interactionVerb property.

Returns:
int - The value of the interactionVerb property.
See Also:
setInteractionVerb(int)

getInteractionVerbText

public static java.lang.String getInteractionVerbText(int interactionVerb)
Returns the String representation of the interactionVerb property.

Note: This method is for IMS Connector for Java internal use only.

Parameters:
interactionVerb - The value of the interactionVerb property.
Returns:
String - The String representation of the interactionVerb property.

getLtermName

public final java.lang.String getLtermName()
Returns the String representation of the ltermName property.

Returns:
String - The String representation of the ltermName property
See Also:
setLtermName(String)

getMapName

public final java.lang.String getMapName()
Returns the value of the mapName property, typically the name of an MFS Message Output Descriptor (MFS MOD). On output, the name of the MOD provided in the I/O PCB by the IMS application program is provided to the Java application by the getMapName method.

Note: The mapName property should not be used by Java applications that use an enterprise service whose input and output messages are generated by WebSphere Studio's MFS support.

Returns:
String - The value of the mapName property; typically the name of an MFS MOD. Use of mapName is optional.
See Also:
setMapName(String)

getReRouteName

public final java.lang.String getReRouteName()
Returns the String representation of the reRouteName property.

Returns:
String - The String representation of the reRouteName property
See Also:
setReRouteName(String)

getAltClientID

public final java.lang.String getAltClientID()
Returns the String representation of the altClientID property.

Returns:
String - The String representation of the altClientID property
See Also:
setAltClientID(String)

getPropertyChange

public java.beans.PropertyChangeSupport getPropertyChange()
Accessor for the propertyChange field.


hasListeners

public boolean hasListeners(java.lang.String propertyName)
Checks if there are any listeners for a specific property.

Parameters:
propertyName - The name of the property.
Returns:
boolean - true if there are one or more listeners for the given property, false otherwise.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list.

Parameters:
listener - The PropertyChangeListener to be removed.

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener for a specific property.

Parameters:
propertyName - The name of the property that was listened on.
listener - The PropertyChangeListener to be removed.

setAsyncOutputAvailable

public void setAsyncOutputAvailable(boolean newAsyncOutputAvailable)
Sets the value of the asyncOutputAvailable property. True indicates that there is an asynchronous output message available while false indicates that there is not. Note: This method is only used by IMS Connector for Java.

Parameters:
newAsyncOutputAvailable - The new value for the asyncOutputAvailable the property.

setPurgeAsyncOutput

public void setPurgeAsyncOutput(boolean newPurgeAsyncOutput)
Sets the value of the purgeAsyncOutput property. True indicates that IMS Connect will purge asynchronous output while false indicates that it will not.

Parameters:
newPurgeAsyncOutput - The new value for the purgeAsyncOutput the property.

setReRoute

public void setReRoute(boolean newReRoute)
Sets the value of the reRoute property. True indicates that asynchronous output will be rerouted to an alternate destination while false indicates that it will not.

Parameters:
newReRoute - The new value for the reRoute the property.

setCommitMode

public void setCommitMode(int newCommitMode)
                   throws javax.resource.ResourceException
Sets the commitMode property to a specified value. This value defines the type of Commit Mode associated with the interaction with IMS via IMS Connect. Values supported are:

SEND_THEN_COMMIT (value 1)
IMS processes the transaction and sends a response back before committing the data.
COMMIT_THEN_SEND (value 0)
IMS processes the transaction and commits the data before sending a response.

Parameters:
newCommitMode - The new value for the commitMode property.
Throws:
javax.resource.ResourceException - If an invalid commitMode value is specified.

setConvEnded

public void setConvEnded(boolean newConvEnded)
Sets the value of the convEnded property. True indicates that the conversation has ended while false indicates that the conversation is still active.

Note: This method is for IMS Connector for Java use only. The convEnded property is an output-only property and should not be set, on input, by the application component.

Parameters:
newConvEnded - The new value for the convEnded the property.

setExecutionTimeout

public void setExecutionTimeout(int newTimeout)
                         throws javax.resource.ResourceException
Sets the value of the executionTimeout property, which is the time it takes for IMS Connect to send an interaction to IMS and receive a response. It is converted into a value that is acceptable to IMS Connect.

Parameters:
newTimeout - The new value for the executionTimeout property.
Throws:
javax.resource.ResourceException - If an invalid executionTimeout value is specified.
javax.resource.NotSupportedException - If an executionTimeout value is specified that is valid for the architecture but not supported by IMS Connector for Java, this derivative of ResourceException is thrown.

setSocketTimeout

public void setSocketTimeout(int newSoTimeout)
                      throws javax.resource.ResourceException
Sets the value of the socketTimeout property, which is the time IMS Connector for Java will wait on behalf of the client, to receive a reply after sending a message to IMS Connect.

Parameters:
newSoTimeout - The new value for the socketTimeout property.
Throws:
javax.resource.ResourceException - If an invalid executionTimeout value is specified.
javax.resource.spi.CommException - If socketTimeout has occurred for the interaction.

setImsRequestType

public void setImsRequestType(int newImsRequestType)
                       throws javax.resource.ResourceException
Sets the value of the imsRequestType property. This value defines the type of IMS request associated with the interaction with IMS via IMS Connect. Supported values are:

IMS_REQUEST_TYPE_IMS_TRANSACTION (value 1)
The request is an IMS transaction. Normal transaction output returned by IMS is used to populate the application's output message. If IMS returns a "DFS" message, the IMS resource adapter throws an IMSDFSMessageException. Value 1 is used for applications that are not generated using WebSphere Studio MFS support.
IMS_REQUEST_TYPE_IMS_COMMAND (value 2)
The request is an IMS command. Command output returned by IMS, including "DFS" messages, is used to populate the application's output message. The IMSDFSMessageException is not thrown. Value 2 is used for applications that submit IMS commands.
IMS_REQUEST_TYPE_MFS_TRANSACTION (value 3)
Value 3 is reserved for applications that are generated using WebSphere Studio MFS support. Normal transaction output returned by IMS, as well as "DFS" messages, are used to populate the application's output message. The IMSDFSMessageException is not thrown.

Parameters:
newImsRequestType - The new value for the imsRequestType property.
Throws:
javax.resource.ResourceException - If an invalid imsRequestType value is specified.

setInteractionVerb

public void setInteractionVerb(int newVerb)
                        throws javax.resource.ResourceException
Sets the value of the interactionVerb property. This value defines the mode of the interaction with IMS via IMS Connect. IMS Connector for Java supports the following values:
SYNC_SEND (value 0)
Used to send a request to IMS when a response is not expected, in another words, perform a send only interaction.
SYNC_SEND_RECEIVE (value 1)
Used for the single interation of a non-conversational IMS transaction and for each iteration of a conversational IMS transaction.
SYNC_END_CONVERSATION (value 3)
Used to force the end of an IMS conversational transaction.
SYNC_RECEIVE_ASYNCOUTPUT (value 4)
Used to retrieve asynchronous output messages. With this type of interaction, the Java client can only receive a single message. If there are no messages in the IMS OTMA Asynchronous Queue for the clientID when the request is made, no further attempts are made to retrieve the message. No message is returned and a timeout will occur after the length of time specified in the executionTimeout property of the SYNC_RECEIVE_ASYNCOUTPUT interaction.
SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT (value 5)
Used to retrieve asynchronous output messages. With this type of interaction, the Java client can only receive a single message. If there are no messages in the IMS OTMA Asynchronous Queue for the clientID when the request is made, no further attempts are made to retrieve the message. No message is returned and a timeout will occur after the length of time specified in the executionTimeout property of the SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT interaction.
SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT (value 6)
Used to retrieve asynchronous output messages. With this type of interaction, the Java client can only receive a single message. If there are no messages in the IMS OTMA Asynchronous Queue for the clientID when the request is made, IMS Connect waits for OTMA to return a message. IMS Connect waits the length of time specified in the executionTimeout property of the SYNC_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT interaction before returning an exception.

Note: SYNC_RECEIVE (value 2) is currently not supported by IMS Connector for Java.

Parameters:
newVerb - The new value for the interactionVerb property.
Throws:
javax.resource.ResourceException - If an invalid interactionVerb value is specified.
javax.resource.NotSupportedException - If an interactionVerb value is specified that is valid for the architecture but not supported by IMS Connector for Java, this derivative of ResourceException is thrown.

setLtermName

public void setLtermName(java.lang.String newLtermName)
                  throws javax.resource.ResourceException
Sets the value of the ltermName property. This value is used to override the value in the LTERM field of the IMS application program's I/O PCB, with the intent that the IMS application will make logic decisions based on the override value. See the IMS Connect User's Guide and Reference for a description of how the LTERM override is used.

Parameters:
newLtermName - The new value for the ltermName property. Use of ltermName is optional.
Throws:
javax.resource.ResourceException - If an invalid ltermName value is specified.

setMapName

public void setMapName(java.lang.String newMapName)
                throws javax.resource.ResourceException
Sets the value of the mapName property, typically the name of an MFS Message Output Descriptor (MFS MOD). The MOD name will be provided to the IMS application program in the I/O PCB.

Note: The mapName property should not be used by Java applications that use an enterprise serive whose input and output messages are generated by WebSphere Studio's MFS support.

Parameters:
newMapName - The new value for the mapName property; typically the name of an MFS MOD. Use of mapName is optional.
Throws:
javax.resource.ResourceException - If an invalid mapName value is specified.
See Also:
getMapName()

setReRouteName

public void setReRouteName(java.lang.String newReRouteName)
                    throws javax.resource.ResourceException
Sets the value of the reRouteName property. A reRouteName must be from 1-8 alphanumeric characters (A-Z, 0-9, @, #, $) and must not start with the prefix "HWS".

Parameters:
newReRouteName - The new value for the reRouteName property
Throws:
javax.resource.ResourceException - If an invalid reRouteName value is specified.

setAltClientID

public void setAltClientID(java.lang.String newAltClientID)
                    throws javax.resource.ResourceException
Sets the value of the altClientID property. An altClientID must be from 1-8 alphanumeric characters (A-Z, 0-9, @, #, $)

Parameters:
newAltClientID - The new value for the altClientID property
Throws:
javax.resource.ResourceException - If an invalid altClientID value is specified.

getSyncLevel

public int getSyncLevel()
Returns:
Returns the syncLevel.

setSyncLevel

public void setSyncLevel(int newSyncLevel)
                  throws javax.resource.NotSupportedException
Throws:
javax.resource.NotSupportedException

Package All Classes All Fields and Methods Deprecated