Class Hierarchy All Classes All Fields and Methods

Class com.ibm.connector2.ims.ico.IMSInteractionSpec

java.lang.Object
   |
   +----com.ibm.connector2.ims.ico.IMSInteractionSpec

public class IMSInteractionSpec
implements Serializable, IMSInteractionSpecProperties
extends Object

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

Field Index
Field Description
propertyChange IMS Connector for Java internal use only.
Constructor Index
Constructor Description
IMSInteractionSpec() The default constructor.
Method Index
Method Description
void addPropertyChangeListener(PropertyChangeListener) Adds a PropertyChangeListener for all the properties.
void addPropertyChangeListener(String, PropertyChangeListener) Adds a PropertyChangeListener for a property.
void firePropertyChange(PropertyChangeEvent) Fires a PropertyChangeEvent to listeners.
void firePropertyChange(String, boolean, boolean) Reports a boolean bound property update to any registered listeners.
void firePropertyChange(String, int, int) Reports an int bound property update to any registered listeners.
void firePropertyChange(String, Object, Object) Reports a String bound property update to any registered listeners.
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.
String getInteractionVerbText(int) Returns the String representation of the interactionVerb property.
String getLtermName() Returns the String representation of the ltermName property.
String getMapName() Returns the value of the mapName property, typically the name of an MFS Message Output Descriptor (MFS MOD).
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).
String getReRouteName() Returns the String representation of the reRouteName property.
int getSocketTimeout() Returns the value of the socketTimeout property.
boolean hasListeners(String) Checks if there are any listeners for a specific property.
void removePropertyChangeListener(PropertyChangeListener) Removes a PropertyChangeListener from the listener list.
void removePropertyChangeListener(String, PropertyChangeListener) Removes a PropertyChangeListener for a specific property.
void setAsyncOutputAvailable(boolean) Sets the value of the asyncOutputAvailable property.
void setCommitMode(int) Sets the commitMode property to a specified value.
void setConvEnded(boolean) Sets the value of the convEnded property.
void setExecutionTimeout(int) 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) Sets the value of the imsRequestType property.
void setInteractionVerb(int) Sets the value of the interactionVerb property.
void setLtermName(String) Sets the value of the ltermName property.
void setMapName(String) Sets the value of the mapName property, typically the name of an MFS Message Output Descriptor (MFS MOD).
void setPurgeAsyncOutput(boolean) Sets the value of the purgeAsyncOutput property.
void setReRoute(boolean) Sets the value of the reRoute property.
void setReRouteName(String) Sets the value of the reRouteName property.
void setSocketTimeout(int) 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.

Fields

propertyChange

public transient java.beans.PropertyChangeSupport propertyChange

IMS Connector for Java internal use only.

Constructors

IMSInteractionSpec

public IMSInteractionSpec() 

The default constructor.

Methods

addPropertyChangeListener

public synchronized void addPropertyChangeListener(PropertyChangeListener listener) 

Adds a PropertyChangeListener for all the properties.

addPropertyChangeListener

public synchronized void addPropertyChangeListener(String propertyName,
                                                   PropertyChangeListener listener) 

Adds a PropertyChangeListener for a property.

firePropertyChange

public void firePropertyChange(PropertyChangeEvent evt) 

Fires a PropertyChangeEvent to listeners.

firePropertyChange

public void firePropertyChange(String propertyName,
                               boolean oldValue,
                               boolean newValue) 

Reports a boolean bound property update to any registered listeners.

firePropertyChange

public void firePropertyChange(String propertyName,
                               int oldValue,
                               int newValue) 

Reports an int bound property update to any registered listeners.

firePropertyChange

public void firePropertyChange(String propertyName,
                               Object oldValue,
                               Object newValue) 

Reports a String bound property update to any registered listeners.

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).

getCommitMode

public final int getCommitMode() 

Returns the value of the commitMode property.

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).

getExecutionTimeout

public final int getExecutionTimeout() 

Returns the value of the executionTimeout property.

getImsRequestType

public final int getImsRequestType() 

Returns the value of the imsRequestType property.

getInteractionVerb

public final int getInteractionVerb() 

Returns the value of the interactionVerb property.

getInteractionVerbText

public static String getInteractionVerbText(int interactionVerb) 

Returns the String representation of the interactionVerb property.

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

getLtermName

public final String getLtermName() 

Returns the String representation of the ltermName property.

getMapName

public final 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.

getPropertyChange

public PropertyChangeSupport getPropertyChange() 

Accessor for the propertyChange field.

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).

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).

getReRouteName

public final String getReRouteName() 

Returns the String representation of the reRouteName property.

getSocketTimeout

public int getSocketTimeout() 

Returns the value of the socketTimeout property.

hasListeners

public synchronized boolean hasListeners(String propertyName) 

Checks if there are any listeners for a specific property.

removePropertyChangeListener

public synchronized void removePropertyChangeListener(PropertyChangeListener listener) 

Removes a PropertyChangeListener from the listener list.

removePropertyChangeListener

public synchronized void removePropertyChangeListener(String propertyName,
                                                      PropertyChangeListener listener) 

Removes a PropertyChangeListener for a specific property.

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.

setCommitMode

public void setCommitMode(int newCommitMode) throws 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.

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.

setExecutionTimeout

public void setExecutionTimeout(int newTimeout) throws 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.

setImsRequestType

public void setImsRequestType(int newImsRequestType) throws 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.

setInteractionVerb

public void setInteractionVerb(int newVerb) throws 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.

setLtermName

public void setLtermName(String newLtermName) throws 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.

setMapName

public void setMapName(String newMapName) throws 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.

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.

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.

setReRouteName

public void setReRouteName(String newReRouteName) throws 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".

setSocketTimeout

public void setSocketTimeout(int newSoTimeout) throws 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.

Class Hierarchy All Classes All Fields and Methods