|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.dse.base.DSENotifier | +--com.ibm.dse.base.Service | +--com.ibm.dse.services.otma.OTMAConnection
This class allows a local application, located in OS/390 to communicate with IMS V6.1 .
Field Summary | |
static java.lang.String |
COMPID
The component id. |
static java.lang.String |
OTMA_WRAPPER_DLL
|
Fields inherited from class com.ibm.dse.base.Service |
externalizer |
Fields inherited from class com.ibm.dse.base.DSENotifier |
handlersList,
name |
Fields inherited from interface com.ibm.dse.services.otma.OTMAConnectionService |
ALLOC,
automaticConnectionEstablishment,
CLOSE,
disabled,
enabled,
FREE,
IMSMemberName,
IMSModName,
LISTEN_THREAD,
lterm,
numberOfResponseSegments,
OPEN,
receiveLength,
SAFgroupName,
SENDRECEIVE,
sessions,
TpipePrefix,
transaction,
userId,
XCFgroupName,
XCFMemberName |
Fields inherited from interface com.ibm.dse.services.comms.CommonCommunicationsService |
CLOSED,
DATA,
DATASENT,
ERROR,
OPENED,
RECEIVERC,
TIMEOUT |
Constructor Summary | |
OTMAConnection()
This constructor creates an OTMAConnection object. |
|
OTMAConnection(java.lang.String aName)
This constructor creates an OTMAConnection object. |
Method Summary | |
void |
ccClose()
Closes the communications channel. |
void |
ccOpen()
Opens the communications channel. |
CCMessage |
ccReceiveData(long timeout)
This method does´nt have sense for this service. |
void |
ccSendData(java.lang.String aData)
This method does´nt have sense for this service. |
CCMessage |
ccSendReceive(java.lang.String aData,
long timeout)
Sends a String to communication services, and waits for a Timeout to receive the data. |
void |
closeConnection()
This method closes OTMA connection . |
boolean |
getAutomaticConnectionEstablishment()
Gets the automaticSessionEstablishment property (java.lang.Boolean) value. |
java.lang.String |
getCcClosedEventName()
Gets the name of de close event. |
java.lang.String |
getCcDataReceivedEventName()
Gets the name of de data received event. |
java.lang.String |
getCcErrorReceivedEventName()
Gets the name of de error event. |
java.lang.String |
getCcOpenedEventName()
Gets the name of de open event. |
java.lang.String |
getIMSModName()
Returns IMSModName passed to IMS, optional. |
java.lang.String |
getIMSName()
Returns Server IMS XCF member name for this member. |
boolean |
getInUse()
Returns true if there is no available sessions. |
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. |
java.lang.Object |
initializeFrom(Tag aTag)
Initializes a OTMAConnection object with the aTag attributes. |
void |
initInstance()
Loads dynamic link library used for OTMA C/I native calls and opends a connection to IMS if automaticConnectionEstablishment selected. |
boolean |
isAutomaticConnectionEstablishment()
Returns true if automaticConnectionEstablishment property is enabled. |
boolean |
isFree()
Returns if the session is free |
boolean |
isOffline()
Returns if the session is offline |
void |
openConnection()
This method establishes a multi-session OTMA connection. |
OTMAMessage |
sendReceive(java.lang.String aTransaction,
Context aContext,
FormatElement aFormat,
long timeout)
Sends data over this session to IMS and receives the output produced. |
OTMAMessage |
sendReceive(java.lang.String aTransaction,
Context aContext,
java.lang.String aFormatName,
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,
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 |
setInUse(boolean anInUse)
Sets the inUse property (boolean) value. |
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. |
java.lang.String |
toString()
Returns a visual representation of this object. |
Methods inherited from class com.ibm.dse.base.Service |
externalizer,
getExternalizer,
getTagName,
readExternal,
readExternal,
readObject,
removeExternal,
setExternalizer,
toStrings,
toTags,
writeExternal,
writeExternal |
Methods inherited from class com.ibm.dse.base.DSENotifier |
addHandler,
getHandlersList,
getName,
removeHandler,
setName,
signalEvent,
signalEvent,
signalEvent |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final java.lang.String COMPID
public static final java.lang.String OTMA_WRAPPER_DLL
Constructor Detail |
public OTMAConnection()
public OTMAConnection(java.lang.String aName) throws java.io.IOException
aName
- java.lang.StringMethod Detail |
public void ccClose() throws DSECCException
public void ccOpen() throws DSECCException
public CCMessage ccReceiveData(long timeout) throws DSECCException
aTimeout
- longpublic void ccSendData(java.lang.String aData) throws DSECCException
aString
- java.lang.Stringpublic CCMessage ccSendReceive(java.lang.String aData, long timeout) throws DSECCException
aData,
- Data to be sent to IMS.timeout,
- time interval to wait for this request.public void closeConnection() throws DSEOTMAException
public boolean getAutomaticConnectionEstablishment()
#setAutomaticSessionEstablishment
public java.lang.String getCcClosedEventName()
public java.lang.String getCcDataReceivedEventName()
public java.lang.String getCcErrorReceivedEventName()
public java.lang.String getCcOpenedEventName()
public java.lang.String getIMSModName()
public java.lang.String getIMSName()
public boolean getInUse()
public java.lang.String getLTERM()
public int getNumberOfResponseSegments()
public int getReceiveBufferLength()
public java.lang.String getSAFgroupName()
public int getSessionsNumber()
public java.lang.String getTpipePrefix()
public java.lang.String getTransaction()
public java.lang.String getUserId()
public java.lang.String getXCFgroupName()
public java.lang.String getXCFMemberName()
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException, DSEException
aTag
- com.ibm.dse.base.Tagpublic void initInstance() throws java.lang.UnsatisfiedLinkError, DSEOTMAException
public boolean isAutomaticConnectionEstablishment()
public boolean isFree()
public boolean isOffline()
public void openConnection() throws DSEOTMAException
public OTMAMessage sendReceive(java.lang.String aTransaction, Context aContext, FormatElement aFormat, long timeout) throws DSEOTMAException, DSEException
aTransaction,
- name of IMS transaction or command to be sent to IMS.aContext
- com.ibm.dse.base.ContextaFormat
- com.ibm.dse.base.FormatElementtimeout,
- time interval to wait for this request.public OTMAMessage sendReceive(java.lang.String aTransaction, Context aContext, java.lang.String aFormatName, long timeout) throws DSEException
aTransaction,
- name of IMS transaction or command to be sent to IMS.aContext
- com.ibm.dse.base.ContextaFormat
- com.ibm.dse.base.FormatElementtimeout,
- time interval to wait for this request.public OTMAMessage sendReceive(java.lang.String aTransaction, java.lang.String aData, byte[] session, int[] sendSegmentList, long timeout) throws DSEOTMAException
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.public OTMAMessage sendReceive(java.lang.String aTransaction, java.lang.String aData, byte[] session, long timeout) throws DSEOTMAException
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.public OTMAMessage sendReceive(java.lang.String aTransaction, java.lang.String aData, int[] sendSegmentList, long timeout) throws DSEOTMAException
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.public OTMAMessage sendReceive(java.lang.String aTransaction, java.lang.String aData, long timeout) throws DSEOTMAException
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.public void setAutomaticConnectionEstablishment(boolean newAutomaticConnectionEstablishment)
newAutomaticConnectionEstablishment
- booleanpublic void setIMSModName(java.lang.String newIMSModName)
newIMSModName
- java.lang.Stringpublic void setIMSName(java.lang.String newIMSName)
newIMSName
- java.lang.Stringpublic void setInUse(boolean anInUse)
anInUse
- The new value for the property.getInUse()
public void setLTERM(java.lang.String newLTERM)
newLTERM
- java.lang.Stringpublic void setNumberOfResponseSegments(int newNumberOfResponseSegments)
newNumberOfResponseSegments
- intpublic void setReceiveBufferLength(int newReceiveBufferLength)
newReceiveBufferLength
- intpublic void setSAFgroupName(java.lang.String newSAFGroupName)
newSAFGroupName
- java.lang.Stringpublic void setSessionsNumber(int newSessionsNumber)
newSessionsNumber
- intpublic void setTpipePrefix(java.lang.String newTpipePrefix)
newTpipePrefix
- java.lang.Stringpublic void setTransaction(java.lang.String newTransaction)
newTransaction
- java.lang.Stringpublic void setUserId(java.lang.String newUserId)
newUserId
- java.lang.Stringpublic void setXCFGroupName(java.lang.String newGroupName)
newGroupName
- java.lang.Stringpublic void setXCFMemberName(java.lang.String newPartnerName)
newPartnerName
- java.lang.Stringpublic void terminate()
public java.lang.String toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |