Class Hierarchy All Classes All Fields and Methods

Class com.ibm.connector2.ims.ico.IMSInteraction

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

public class IMSInteraction
extends Object

A component uses an instance of this class to perform an interaction with IMS via IMS Connect. A typical interaction is running an IMS transaction. For example, an application that uses the Common Client Interface (CCI) would use an Interaction instance to run an IMS transaction as follows:

        Connection connection = cf.getConnection();

        // Create an interaction instance to use to submit the IMS transaction. 
        IMSInteraction interaction = (IMSInteraction) connection.createInteraction(); 

        // Set interactionSpec properties.
        IMSInteractionSpec iSpec = new IMSInteractionSpec(); 
        iSpec.setInteractionVerb(IMSInteractionSpec.SYNC_SEND_RECEIVE);
        ...
        // Create the input record
        ...

        // Send the input message to IMS to run the transaction and
        // return the output message.
        interaction.execute(iSpec, input, output);	  
 

A CCI application can also use an Interaction instance to send a request asnychronously to IMS OTMA to retrieve a queued output message. The message was queued when the output of a Commit Mode 0 interaction on a dedicated persistent socket could not be delivered.

        // Get a factory to create dedicated persistent socket connection
        IMSConnectionFactory cf = null;
        IMSManagedConnectionFactory mcf = new IMSManagedConnectionFactory();
        mcf.setHostName("myHostName");
        mcf.setPortNumber(new Integer(9999));
        mcf.setDataStoreName("myIMS");
        mcf.setCM0Dedicated(new Boolean("TRUE"));
        cf = (IMSConnectionFactory) mcf.createConnectionFactory();	

        // Create a connection for use by clientID "CLIENT01" 
        IMSConnectionSpec aCSpec = new IMSConnectionSpec();
        aCSpec.setClientID("CLIENT01");
        connection = connectionFactory.getConnection(aCSpec);

        // Create an interaction instance to use to retrieve the asynchronous output message. 
        IMSInteraction interaction = (IMSInteraction) connection.createInteraction();

        // Set interactionSpec properties.
        IMSInteractionSpec iSpec = new IMSInteractionSpec(); 
        iSpec.setInteractionVerb(IMSInteractionSpec.SYNC_RECEIVE_ASYNCOUTPUT);
        iSpec.setCommitMode(0);
        ...
        // Send a request to IMS to return the asynchronous output message.
        interaction.execute(iSpec, null, output);	  
 

A CCI application can also use an Interaction instance to send a message to IMS OTMA to end a conversation:

        // Note: conn is a handle to the connection used to carry on the
        // conversation.  An application must use the same connection with IMS Connect 
        // (TCP/IP socket or Local Option connection) for all the iterations
        // of a conversation.
        IMSInteraction interaction = (IMSInteraction) conn.createInteraction();

        // Set interactionSpec properties.
        IMSInteractionSpec iSpec = new IMSInteractionSpec();
        iSpec.setInteractionVerb(IMSInteractionSpec.SYNC_END_CONVERSATION);
        ...
        // Send a message to end the conversation
        interaction.execute(iSpec, null);
 

Constructor Index
Constructor Description
IMSInteraction(IMSConnection) Creates an IMSInteraction instance for use in an interaction with IMS via IMS Connect.
Method Index
Method Description
void clearWarnings() Clears all the warnings reported by this IMSInteraction instance.
void close() Releases all resources maintained by IMS Connector for Java for the IMSInteraction instance.
javax.resource.cci.Record execute(javax.resource.cci.InteractionSpec, javax.resource.cci.Record) Performs an interaction with IMS OTMA via IMS Connect.
boolean execute(javax.resource.cci.InteractionSpec, javax.resource.cci.Record, javax.resource.cci.Record) Performs an interaction with IMS via IMS Connect.
javax.resource.cci.Connection getConnection() Returns the connection associated with this interaction.
javax.resource.cci.RecordFactory getRecordFactory() Returns a RecordFactory object that is used to create generic Record instances.
javax.resource.cci.ResourceWarning getWarnings() Gets the first ResourceWarning from the chain of warnings associated with this Interaction instance.

Constructors

IMSInteraction

public IMSInteraction(IMSConnection aConnection) 

Creates an IMSInteraction instance for use in an interaction with IMS via IMS Connect.

Methods

clearWarnings

public void clearWarnings() throws ResourceException

Clears all the warnings reported by this IMSInteraction instance. After a call to this method, the method getWarnings returns null until a new warning is reported for this IMSInteraction instance.

Note: Currently, IMS Connector for Java does not issue any warnings.

close

public void close() throws ResourceException

Releases all resources maintained by IMS Connector for Java for the IMSInteraction instance. The close of an IMSInteraction instance does not close the associated IMSConnection instance.

execute

public javax.resource.cci.Record execute(javax.resource.cci.InteractionSpec interactionSpec,
                                         javax.resource.cci.Record input) throws ResourceException

Performs an interaction with IMS OTMA via IMS Connect. This variant of the execute method is used by applications that use the Common Client Interface (CCI) to send a request to IMS OTMA to force the end of an IMS conversation. In this case, the interactionVerb property of the IMSInteractionSpec instance is set to SYNC_END_CONVERSATION, and the input Record instance is ignored.

execute

public boolean execute(javax.resource.cci.InteractionSpec interactionSpec,
                       javax.resource.cci.Record input,
                       javax.resource.cci.Record output) throws ResourceException

Performs an interaction with IMS via IMS Connect. For example, this variant of the execute method can be used run a simple IMS transaction on a Local Option or shareable persistent socket connection by invoking the execute method with the following:

Both non-conversational and conversational IMS transactions can be run using this variant of the execute method.

This variant of the execute method can also be used on dedicated persistent socket connections to run an IMS transaction using Commit Mode 0, retrieve queued output messages from Commit Mode 0 interactions, or retrieve messages that were inserted to alternate Program Contorl Blocks (PCBs).

For example, to retrieve undelivered output from a Commit Mode 0 interaction on a socket connection dedicated to "CLIENT01", the execute method is invoked with:

Note: For interactions on a dedicated persistent socket connection the Interaction instance is obtained from a connection that is dedicated to a particular clientID. The value for this clientID is provided in the IMSConnectionSpec object passed to the getConnection() method used to obtain the connection.

For Commit Mode 0 interactions that use interactionVerb = SYNC_SEND_RECEIVE on a dedicated persistent socket connection, clientID identifies the queue to which the output message will be queued if it cannot be delivered to the client. For Commit Mode 0 interactions that use interactionVerb = SYNC_RECEIVE_ASYNCOUTPUT, clientID identifies the queue from which the message will be retrieved.

getConnection

public final javax.resource.cci.Connection getConnection() 

Returns the connection associated with this interaction.

getRecordFactory

public javax.resource.cci.RecordFactory getRecordFactory() throws ResourceException

Returns a RecordFactory object that is used to create generic Record instances.

Note: IMS Connector for Java does not support this method.

getWarnings

public javax.resource.cci.ResourceWarning getWarnings() throws ResourceException

Gets the first ResourceWarning from the chain of warnings associated with this Interaction instance.

Note: Currently, IMS Connector for Java does not issue any warnings.

Class Hierarchy All Classes All Fields and Methods