com.ibm.dse.services.itoc
Interface ITOCConnectionService

All Known Implementing Classes:
ITOCConnection

public interface ITOCConnectionService
extends CommonCommunicationsService

The ITOCConnectionService interface provides ITOCConnection services.


Field Summary
static java.lang.String automaticACK
          The value to determine if ackonowledgement message are sent automatically or not.
static java.lang.String clientId
          The name of the clientId.
static java.lang.String commitMode
          The value of commit mode.
static byte CONFIRM
           
static java.lang.String dataStoreName
          The name of the IMS datastore.
static java.lang.String enabled
           
static java.lang.String hostName
          The name of the IMS host.
static java.lang.String LISTEN_THREAD
          The name of the thread employed working on commit mode 1.
static java.lang.String lterm
          The name of the lterm.Can be set to blank.
static byte MFS_NO
           
static byte MFS_YES
           
static byte MODE0
           
static byte MODE1
           
static byte NONE
           
static java.lang.String password
          The name of the IMS user password.
static java.lang.String port
          The value of the IMS port.
static java.lang.String receiveOnlyTimeout
          The value of the timeout when working on commit mode 0, using receiveonly protocol.
static java.lang.String requestMFS
          The name of the MFS mod received from the IMS
static java.lang.String SAFgroupName
          The name of the IMS group.Can be set to blank.
static java.lang.String sendOnly
          The value to decide the protocol when working on commit mode 0.
static java.lang.String synchLevel
          The value of the synchronization level.
static java.lang.String synchronousMode
          The option choiced by the user relating transaction flow.
static java.lang.String transaction
          The transaction name.
static java.lang.String UNSOLICITED
          The name of the thread employed working on commit mode 0.
static java.lang.String userId
          The name of the IMS userId.
static java.lang.String version
          The value of the IMS release.
 
Fields inherited from interface com.ibm.dse.services.comms.CommonCommunicationsService
CLOSED, DATA, DATASENT, ERROR, OPENED, RECEIVERC, TIMEOUT
 
Method Summary
 void initInstance()
          Initiates all processes depending commit mode.
 void send(java.lang.String aTransaction, java.lang.String aData)
          Sends transaction to IMS.
 void send(java.lang.String aTransaction, java.lang.String[] segments)
          Sends transaction to IMS.
 void sendACK()
          Sends ACKNOWLEDGE message to IMS when working in confirm mode.
 void sendNACK()
          Sends NEGATIVE ACKNOWLEDGE message to IMS when working in confirm mode.
 ITOCMessage sendReceive(java.lang.String aTransaction, java.lang.String[] segments, long timeout)
          Sends transaction to IMS and awaits for response.
 ITOCMessage sendReceive(java.lang.String aTransaction, java.lang.String aData, long timeout)
          Sends transaction to IMS and awaits for response.
 void setUserExit(java.lang.String newUserExit)
          Set the userExit value to UserExit parameter.
 void terminate()
          Terminates the conversation.
 
Methods inherited from interface com.ibm.dse.services.comms.CommonCommunicationsService
ccClose, ccOpen, ccReceiveData, ccSendData, ccSendReceive, getCcClosedEventName, getCcDataReceivedEventName, getCcErrorReceivedEventName, getCcOpenedEventName, isFree, isOffline, setInUse
 
Methods inherited from interface com.ibm.dse.base.Notifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent
 

Field Detail

CONFIRM

public static final byte CONFIRM

NONE

public static final byte NONE

MODE1

public static final byte MODE1

MODE0

public static final byte MODE0

MFS_YES

public static final byte MFS_YES

MFS_NO

public static final byte MFS_NO

LISTEN_THREAD

public static final java.lang.String LISTEN_THREAD
The name of the thread employed working on commit mode 1.

UNSOLICITED

public static final java.lang.String UNSOLICITED
The name of the thread employed working on commit mode 0.

synchronousMode

public static final java.lang.String synchronousMode
The option choiced by the user relating transaction flow.

requestMFS

public static final java.lang.String requestMFS
The name of the MFS mod received from the IMS

automaticACK

public static final java.lang.String automaticACK
The value to determine if ackonowledgement message are sent automatically or not.

sendOnly

public static final java.lang.String sendOnly
The value to decide the protocol when working on commit mode 0.

commitMode

public static final java.lang.String commitMode
The value of commit mode.

userId

public static final java.lang.String userId
The name of the IMS userId.

transaction

public static final java.lang.String transaction
The transaction name.

password

public static final java.lang.String password
The name of the IMS user password. Can be set to blank.

SAFgroupName

public static final java.lang.String SAFgroupName
The name of the IMS group.Can be set to blank.

clientId

public static final java.lang.String clientId
The name of the clientId.

synchLevel

public static final java.lang.String synchLevel
The value of the synchronization level.

lterm

public static final java.lang.String lterm
The name of the lterm.Can be set to blank.

hostName

public static final java.lang.String hostName
The name of the IMS host.

dataStoreName

public static final java.lang.String dataStoreName
The name of the IMS datastore.

port

public static final java.lang.String port
The value of the IMS port.

version

public static final java.lang.String version
The value of the IMS release.

receiveOnlyTimeout

public static final java.lang.String receiveOnlyTimeout
The value of the timeout when working on commit mode 0, using receiveonly protocol.

enabled

public static final java.lang.String enabled
Method Detail

initInstance

public void initInstance()
                  throws DSECCException
Initiates all processes depending commit mode. Possibles values are:
Throws:
DSEException - .

send

public void send(java.lang.String aTransaction,
                 java.lang.String[] segments)
          throws java.io.IOException,
                 java.lang.Exception
Sends transaction to IMS. First check socket state. Then sends header and data separately.
Parameters:
java.lang.String - aTransaction. Transaction code to be sent.
java.lang.String - segments. Segments array relating transaction.
Throws:
java.io.IOException. -  
java.lang.Exception. -  

send

public void send(java.lang.String aTransaction,
                 java.lang.String aData)
          throws java.io.IOException,
                 java.lang.Exception
Sends transaction to IMS. First check socket state. Then sends header and data separately.
Parameters:
java.lang.String - aTransaction. Transaction code to be sent.
java.lang.String - aData. Segment data.
Throws:
java.io.IOException. -  
java.lang.Exception. -  

sendACK

public void sendACK()
             throws java.io.IOException,
                    java.lang.Exception
Sends ACKNOWLEDGE message to IMS when working in confirm mode.
Throws:
java.io.IOException. -  

sendNACK

public void sendNACK()
              throws java.io.IOException
Sends NEGATIVE ACKNOWLEDGE message to IMS when working in confirm mode.
Throws:
java.io.IOException. -  

sendReceive

public ITOCMessage sendReceive(java.lang.String aTransaction,
                               java.lang.String[] segments,
                               long timeout)
                        throws java.io.IOException,
                               java.lang.Exception
Sends transaction to IMS and awaits for response.
Parameters:
aTransaction - java.lang.String
segments - array of Strings
timeout - long
Returns:
ITOCMessage
Throws:
java.io.IOException. -  
java.lang.Exception. -  

sendReceive

public ITOCMessage sendReceive(java.lang.String aTransaction,
                               java.lang.String aData,
                               long timeout)
                        throws java.io.IOException,
                               java.lang.Exception
Sends transaction to IMS and awaits for response.
Parameters:
aTransaction - java.lang.String
aData - java.lang.String
timeout - long
Returns:
ITOCMessage
Throws:
java.io.IOException. -  
java.lang.Exception. -  

setUserExit

public void setUserExit(java.lang.String newUserExit)
Set the userExit value to UserExit parameter.
Parameters:
newUserExit - java.lang.String

terminate

public void terminate()
Terminates the conversation. This method terminates the internal thread and closes the conversation.