Package All Classes All Fields and Methods Deprecated
java.lang.Objectcom.ibm.connector2.ims.ico.IMSInteractionSpec
An instance of this class contains properties that are used in an interaction with IMS via IMS Connect.
IMSInteraction.execute(InteractionSpec, Record, Record)
,
Serialized FormField 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.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 |
public transient java.beans.PropertyChangeSupport propertyChange
Constructor Detail |
public IMSInteractionSpec()
Method Detail |
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The PropertyChangeListener to be added.public void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
listener
- The PropertyChangeListener to be added.propertyName
- The name of the property to listen on.public void firePropertyChange(java.beans.PropertyChangeEvent evt)
evt
- The PropertyChangeEvent object.public void firePropertyChange(java.lang.String propertyName, int oldValue, int newValue)
propertyName
- The name of the property that was changed.oldValue
- The old value of the property.newValue
- The new value of the property.public void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
propertyName
- The name of the property that was changed.oldValue
- The old value of the property.newValue
- The new value of the property.public void firePropertyChange(java.lang.String propertyName, boolean oldValue, boolean newValue)
propertyName
- The name of the property that was changed.oldValue
- The old value of the property.newValue
- The new value of the property.public final boolean getAsyncOutputAvailable()
public final boolean getPurgeAsyncOutput()
public final boolean getReRoute()
public final int getCommitMode()
setCommitMode(int)
public final boolean getConvEnded()
public final int getExecutionTimeout()
setExecutionTimeout(int)
public int getSocketTimeout()
setSocketTimeout(int)
public final int getImsRequestType()
setImsRequestType(int)
public final int getInteractionVerb()
setInteractionVerb(int)
public static java.lang.String getInteractionVerbText(int interactionVerb)
Note: This method is for IMS Connector for Java internal use only.
interactionVerb
- The value of the interactionVerb property.
public final java.lang.String getLtermName()
setLtermName(String)
public final java.lang.String getMapName()
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.
setMapName(String)
public final java.lang.String getReRouteName()
setReRouteName(String)
public final java.lang.String getAltClientID()
setAltClientID(String)
public java.beans.PropertyChangeSupport getPropertyChange()
public boolean hasListeners(java.lang.String propertyName)
propertyName
- The name of the property.
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The PropertyChangeListener to be removed.public void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
propertyName
- The name of the property that was listened on.listener
- The PropertyChangeListener to be removed.public void setAsyncOutputAvailable(boolean newAsyncOutputAvailable)
newAsyncOutputAvailable
- The new value for the
asyncOutputAvailable the property.public void setPurgeAsyncOutput(boolean newPurgeAsyncOutput)
newPurgeAsyncOutput
- The new value for the
purgeAsyncOutput the property.public void setReRoute(boolean newReRoute)
newReRoute
- The new value for the
reRoute the property.public void setCommitMode(int newCommitMode) throws javax.resource.ResourceException
newCommitMode
- The new value for the
commitMode property.
javax.resource.ResourceException
- If an invalid commitMode
value is specified.public void setConvEnded(boolean newConvEnded)
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.
newConvEnded
- The new value for the convEnded
the property.public void setExecutionTimeout(int newTimeout) throws javax.resource.ResourceException
newTimeout
- The new value for the
executionTimeout property.
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.public void setSocketTimeout(int newSoTimeout) throws javax.resource.ResourceException
newSoTimeout
- The new value for the
socketTimeout property.
javax.resource.ResourceException
- If an invalid executionTimeout
value is specified.
javax.resource.spi.CommException
- If socketTimeout has occurred for
the interaction.public void setImsRequestType(int newImsRequestType) throws javax.resource.ResourceException
newImsRequestType
- The new value for the
imsRequestType property.
javax.resource.ResourceException
- If an invalid imsRequestType
value is specified.public void setInteractionVerb(int newVerb) throws javax.resource.ResourceException
Note: SYNC_RECEIVE (value 2) is currently not supported by IMS Connector for Java.
newVerb
- The new value for the
interactionVerb property.
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.public void setLtermName(java.lang.String newLtermName) throws javax.resource.ResourceException
newLtermName
- The new value for the
ltermName property.
Use of ltermName is optional.
javax.resource.ResourceException
- If an invalid ltermName
value is specified.public void setMapName(java.lang.String newMapName) throws javax.resource.ResourceException
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.
newMapName
- The new value for the mapName
property; typically the name of
an MFS MOD.
Use of mapName is optional.
javax.resource.ResourceException
- If an invalid mapName
value is specified.getMapName()
public void setReRouteName(java.lang.String newReRouteName) throws javax.resource.ResourceException
newReRouteName
- The new value for the reRouteName
property
javax.resource.ResourceException
- If an invalid reRouteName
value is specified.public void setAltClientID(java.lang.String newAltClientID) throws javax.resource.ResourceException
newAltClientID
- The new value for the altClientID
property
javax.resource.ResourceException
- If an invalid altClientID
value is specified.public int getSyncLevel()
public void setSyncLevel(int newSyncLevel) throws javax.resource.NotSupportedException
javax.resource.NotSupportedException