com.ibm.dse.services.otma
Interface OTMAConnectionService

All Known Implementing Classes:
OTMAConnection

public interface OTMAConnectionService
extends CommonCommunicationsService

The OTMAConnectionService interface provides OTMAConnection services.


Field Summary
static java.lang.String ALLOC
           
static java.lang.String automaticConnectionEstablishment
          If true connection will be established automatically.
static java.lang.String CLOSE
           
static java.lang.String disabled
           
static java.lang.String enabled
           
static java.lang.String FREE
           
static java.lang.String IMSMemberName
          The value to determine the IMS member name.
static java.lang.String IMSModName
          The name of the IMSModName.Should be set to blank.
static java.lang.String LISTEN_THREAD
          The name of the additional thread employed by OTMAConnection instance.
static java.lang.String lterm
          The name of the lterm.Should be set to blank.
static java.lang.String numberOfResponseSegments
          Number of segments sent by IMS.
static java.lang.String OPEN
           
static java.lang.String receiveLength
          Length of buffer available to receive message.
static java.lang.String SAFgroupName
          The name of the IMS SAF group name.Should be set to blank.
static java.lang.String SENDRECEIVE
           
static java.lang.String sessions
          The number of the maximum paralel sessions.
static java.lang.String TpipePrefix
          The name of the IMS Tpipe prefix..
static java.lang.String transaction
          Length of buffer available to receive message.
static java.lang.String userId
          The name of RACF ID Should be set to blank.
static java.lang.String XCFgroupName
          The value to determine the OTMA XCF group name.
static java.lang.String XCFMemberName
          The value to determine the Client XCF member name.
 
Fields inherited from interface com.ibm.dse.services.comms.CommonCommunicationsService
CLOSED, DATA, DATASENT, ERROR, OPENED, RECEIVERC, TIMEOUT
 
Method Summary
 void closeConnection()
          This method closes OTMA connection .
 boolean getAutomaticConnectionEstablishment()
          Gets the automaticSessionEstablishment property (java.lang.Boolean) value.
 java.lang.String getIMSModName()
          Returns IMSModName passed to IMS, optional.
 java.lang.String getIMSName()
          Returns Server IMS XCF member name for this member.
 java.lang.String getLTERM()
          Returns LTERM passed to IMS, optional.
 int getNumberOfResponseSegments()
          Returns number of segments sent by IMS.
 int getReceiveBufferLength()
          Returns length of buffer available to receive message.
 java.lang.String getSAFgroupName()
          Returns The SAF(Security Access Facility) group name to be passed to OTMA.
 int getSessionsNumber()
          Returns number of parallel sessions that are intended to be supported with IMS.
 java.lang.String getTpipePrefix()
          Returns first 1 to 4 characters of the TPIPE names.
 java.lang.String getTransaction()
          Returns name of IMS transaction or command to be sent to IMS.
 java.lang.String getUserId()
          Returns The SAF(Security Access Facility) user ID to be passed to OTMA.
 java.lang.String getXCFgroupName()
          Returns OTMA XCF Group Name (1 to 8 chars).
 java.lang.String getXCFMemberName()
          Returns Client XCF Member Name.
 void initInstance()
          Loads dynamic link library used for OTMA C/I native calls and opends a connection to IMS if automaticConnectionEstablishment selected.
 void openConnection()
          This method establishes a multi-session OTMA connection.
 OTMAMessage sendReceive(java.lang.String aTransaction, java.lang.String aData, byte[] session, int[] sendSegmentList, long timeout)
          Sends data over this session to IMS and receives the output produced.
 OTMAMessage sendReceive(java.lang.String aTransaction, java.lang.String aData, byte[] session, long timeout)
          Sends data over this session to IMS and receives the output produced.
 OTMAMessage sendReceive(java.lang.String aTransaction, java.lang.String aData, int[] sendSegmentList, long timeout)
          Sends data over this session to IMS and receives the output produced.
 OTMAMessage sendReceive(java.lang.String aTransaction, java.lang.String aData, long timeout)
          Sends data over this session to IMS and receives the output produced.
 void setAutomaticConnectionEstablishment(boolean newAutomaticConnectionEstablishment)
          Sets the automaticSessionEstablishment property (java.lang.Boolean) value.
 void setIMSModName(java.lang.String newIMSModName)
          Sets the value of the IMSModName property.
 void setIMSName(java.lang.String newIMSName)
          Sets the value of the IMSName property.
 void setLTERM(java.lang.String newLTERM)
          Sets the value of the LTERM property.
 void setNumberOfResponseSegments(int newNumberOfResponseSegments)
          Sets the value of the numberOfResponseSegments property.
 void setReceiveBufferLength(int newReceiveBufferLength)
          Sets length of buffer available to receive message.
 void setSAFgroupName(java.lang.String newSAFGroupName)
          Sets the value of the SAFgroupName property.
 void setSessionsNumber(int newSessionsNumber)
          Sets the value of the sessionsNumber property.
 void setTpipePrefix(java.lang.String newTpipePrefix)
          Sets the value of the tpipePrefix property.
 void setTransaction(java.lang.String newTransaction)
          Sets name of IMS transaction or command to be sent to IMS.
 void setUserId(java.lang.String newUserId)
          Sets the SAF(Security Access Facility) user ID to be passed to OTMA.
 void setXCFGroupName(java.lang.String newGroupName)
          Sets the value of the XCFgroupName property.
 void setXCFMemberName(java.lang.String newPartnerName)
          Sets the value of the partnerName property.
 void terminate()
          Terminates the internal resources and closes 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

LISTEN_THREAD

public static final java.lang.String LISTEN_THREAD
The name of the additional thread employed by OTMAConnection instance.

XCFgroupName

public static final java.lang.String XCFgroupName
The value to determine the OTMA XCF group name.

IMSMemberName

public static final java.lang.String IMSMemberName
The value to determine the IMS member name.

XCFMemberName

public static final java.lang.String XCFMemberName
The value to determine the Client XCF member name.

sessions

public static final java.lang.String sessions
The number of the maximum paralel sessions.

TpipePrefix

public static final java.lang.String TpipePrefix
The name of the IMS Tpipe prefix..

userId

public static final java.lang.String userId
The name of RACF ID Should be set to blank.

SAFgroupName

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

lterm

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

IMSModName

public static final java.lang.String IMSModName
The name of the IMSModName.Should be set to blank.

automaticConnectionEstablishment

public static final java.lang.String automaticConnectionEstablishment
If true connection will be established automatically.

receiveLength

public static final java.lang.String receiveLength
Length of buffer available to receive message.

transaction

public static final java.lang.String transaction
Length of buffer available to receive message.

numberOfResponseSegments

public static final java.lang.String numberOfResponseSegments
Number of segments sent by IMS.

enabled

public static final java.lang.String enabled

disabled

public static final java.lang.String disabled

OPEN

public static final java.lang.String OPEN

CLOSE

public static final java.lang.String CLOSE

ALLOC

public static final java.lang.String ALLOC

FREE

public static final java.lang.String FREE

SENDRECEIVE

public static final java.lang.String SENDRECEIVE
Method Detail

closeConnection

public void closeConnection()
                     throws DSEOTMAException
This method closes OTMA connection . It is called to free storage for communication and to leave XCF group. This function may be called when communications are in flight or an openConnection is processing. When connection is closed, event CLOSED is signaled.
Throws:
DSEOTMAException - if OTMA C/I error produced.

getAutomaticConnectionEstablishment

public boolean getAutomaticConnectionEstablishment()
Gets the automaticSessionEstablishment property (java.lang.Boolean) value. If automaticConnectionEstablishment set to true connection established automatically . Default to false.
Returns:
The automaticSessionEstablishment property value.
See Also:
#setAutomaticSessionEstablishment

getIMSModName

public java.lang.String getIMSModName()
Returns IMSModName passed to IMS, optional.
Returns:
java.lang.String - The current value of IMSModName.

getIMSName

public java.lang.String getIMSName()
Returns Server IMS XCF member name for this member. (char[16]). Mandatory.
Returns:
java.lang.String - The current value of IMSName.

getLTERM

public java.lang.String getLTERM()
Returns LTERM passed to IMS, optional.
Returns:
java.lang.String

getNumberOfResponseSegments

public int getNumberOfResponseSegments()
Returns number of segments sent by IMS. Default value set to 4.
Returns:
int

getReceiveBufferLength

public int getReceiveBufferLength()
Returns length of buffer available to receive message. If message received is longer that this length , the message is truncated. Default value set to 4096.
Returns:
int

getSAFgroupName

public java.lang.String getSAFgroupName()
Returns The SAF(Security Access Facility) group name to be passed to OTMA. Optional.
Returns:
java.lang.String - The current value of SAFgroupName.

getSessionsNumber

public int getSessionsNumber()
Returns number of parallel sessions that are intended to be supported with IMS. Long integer from 001 to 999. Default to 10.
Returns:
int - The current value of sessionsNumber.

getTpipePrefix

public java.lang.String getTpipePrefix()
Returns first 1 to 4 characters of the TPIPE names. Mandatory.
Returns:
java.lang.String - The current value of TpipePrefix.

getTransaction

public java.lang.String getTransaction()
Returns name of IMS transaction or command to be sent to IMS. If it's not specified in SGML file it has to be specified in the corresponding sendReceive method.
Returns:
java.lang.String

getUserId

public java.lang.String getUserId()
Returns The SAF(Security Access Facility) user ID to be passed to OTMA. For example RACF user ID. Optional.
Returns:
java.lang.String

getXCFgroupName

public java.lang.String getXCFgroupName()
Returns OTMA XCF Group Name (1 to 8 chars). Mandatory.
Returns:
java.lang.String - The current value of XCFgroupName.

getXCFMemberName

public java.lang.String getXCFMemberName()
Returns Client XCF Member Name. Mandatory.
Returns:
java.lang.String - The current value of XCFMemberName.

initInstance

public void initInstance()
                  throws java.lang.UnsatisfiedLinkError,
                         DSEOTMAException
Loads dynamic link library used for OTMA C/I native calls and opends a connection to IMS if automaticConnectionEstablishment selected.
Throws:
java.lang.UnsatisfiedLinkError - if dynamic Link Library not found in path.
DSEOTMAException - if automaticConnectionEstablishment enabled and an error is produced opening the connection.

openConnection

public void openConnection()
                    throws DSEOTMAException
This method establishes a multi-session OTMA connection. The caller must call openConnection to connect when IMS is available. When IMS is not up or OTMA is not started the attempt will fail . Method openConnection is synchronous call and waits until the connection is completed or when the attempt has failed. When connection is opened, event OPEN is signaled. Otherwise event CLOSED is signaled.OpenConnection is synchronous call and waits until the connection is completed or when the attempt has failed.
Throws:
DSEOTMAException - if OTMA C/I error produced.

sendReceive

public OTMAMessage sendReceive(java.lang.String aTransaction,
                               java.lang.String aData,
                               byte[] session,
                               int[] sendSegmentList,
                               long timeout)
                        throws DSEOTMAException
Sends data over this session to IMS and receives the output produced.
Parameters:
aTransaction, - name of IMS transaction or command to be sent to IMS.
aData, - Data to be sent to IMS.
session, - session handler returned by a previous interaction when inside a conversation.
sendSegmentList, - Array of lengths of message segments to be sent to IMS. First element is count of following segment lengths .
timeout, - time interval to wait for this request.
Returns:
OTMAMessage class is returned , containing all attributes returned by OTMA C/I for this request.
Throws:
DSEOTMAException - if OTMA C/I error produced.

sendReceive

public OTMAMessage sendReceive(java.lang.String aTransaction,
                               java.lang.String aData,
                               byte[] session,
                               long timeout)
                        throws DSEOTMAException
Sends data over this session to IMS and receives the output produced.
Parameters:
aTransaction, - name of IMS transaction or command to be sent to IMS.
aData, - Data to be sent to IMS.
session, - session handler returned by a previous interaction when inside a conversation.
timeout, - time interval to wait for this request.
Returns:
OTMAMessage class is returned , containing all attributes returned by OTMA C/I for this request.
Throws:
DSEOTMAException - if OTMA C/I error produced.

sendReceive

public OTMAMessage sendReceive(java.lang.String aTransaction,
                               java.lang.String aData,
                               int[] sendSegmentList,
                               long timeout)
                        throws DSEOTMAException
Sends data over this session to IMS and receives the output produced.
Parameters:
aTransaction, - name of IMS transaction or command to be sent to IMS.
aData, - Data to be sent to IMS.
sendSegmentList, - Array of lengths of message segments to be sent to IMS. First element is count of following segment lengths .
timeout, - time interval to wait for this request.
Returns:
OTMAMessage class is returned , containing all attributes returned by OTMA C/I for this request.
Throws:
DSEOTMAException - if OTMA C/I error produced.

sendReceive

public OTMAMessage sendReceive(java.lang.String aTransaction,
                               java.lang.String aData,
                               long timeout)
                        throws DSEOTMAException
Sends data over this session to IMS and receives the output produced.
Parameters:
aTransaction, - name of IMS transaction or command to be sent to IMS.
aData, - Data to be sent to IMS.
timeout, - time interval to wait for this request.
Returns:
OTMAMessage class is returned , containing all attributes returned by OTMA C/I for this request.
Throws:
DSEOTMAException - if OTMA C/I error produced.

setAutomaticConnectionEstablishment

public void setAutomaticConnectionEstablishment(boolean newAutomaticConnectionEstablishment)
Sets the automaticSessionEstablishment property (java.lang.Boolean) value. If automaticConnectionEstablishment set to true connection established automatically . Default to false.
Parameters:
newAutomaticConnectionEstablishment - boolean

setIMSModName

public void setIMSModName(java.lang.String newIMSModName)
Sets the value of the IMSModName property.
Parameters:
newIMSModName - java.lang.String

setIMSName

public void setIMSName(java.lang.String newIMSName)
Sets the value of the IMSName property.
Parameters:
newIMSName - java.lang.String

setLTERM

public void setLTERM(java.lang.String newLTERM)
Sets the value of the LTERM property.
Parameters:
newLTERM - java.lang.String

setNumberOfResponseSegments

public void setNumberOfResponseSegments(int newNumberOfResponseSegments)
Sets the value of the numberOfResponseSegments property.
Parameters:
newNumberOfResponseSegments - int

setReceiveBufferLength

public void setReceiveBufferLength(int newReceiveBufferLength)
Sets length of buffer available to receive message. If message received is longer that this length , the message is truncated. Default value set to 4096.
Parameters:
newReceiveBufferLength - int

setSAFgroupName

public void setSAFgroupName(java.lang.String newSAFGroupName)
Sets the value of the SAFgroupName property.
Parameters:
newSAFGroupName - java.lang.String

setSessionsNumber

public void setSessionsNumber(int newSessionsNumber)
Sets the value of the sessionsNumber property.
Parameters:
newSessionsNumber - int

setTpipePrefix

public void setTpipePrefix(java.lang.String newTpipePrefix)
Sets the value of the tpipePrefix property.
Parameters:
newTpipePrefix - java.lang.String

setTransaction

public void setTransaction(java.lang.String newTransaction)
Sets name of IMS transaction or command to be sent to IMS.
Parameters:
newTransaction - java.lang.String

setUserId

public void setUserId(java.lang.String newUserId)
Sets the SAF(Security Access Facility) user ID to be passed to OTMA. For example RACF user ID. Optional.
Parameters:
newUserId - java.lang.String

setXCFGroupName

public void setXCFGroupName(java.lang.String newGroupName)
Sets the value of the XCFgroupName property.
Parameters:
newGroupName - java.lang.String

setXCFMemberName

public void setXCFMemberName(java.lang.String newPartnerName)
Sets the value of the partnerName property.
Parameters:
newPartnerName - java.lang.String

terminate

public void terminate()
Terminates the internal resources and closes the conversation. This method is automatically invoked when context where the OTMAConnection is located, is unchained.