|
Sun Adapter for CICS API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.stc.eways.cics.AsyncCicsCall
public class AsyncCicsCall
The AsyncCicsCall
class represents
an asynchronous call to a CICS program either by
using CTG or SYBND CICS Listener;
In the ETD, a node AsyncCalls
is exposed
which is a list of AsyncCall instances each representing
an async call to a CICS program, the call might be pending
or finished, the status of the call can be checked
via method - isDone().
AsyncCalls
is the place where calls
are registered, and the underlying async response
handling mechanism will take the response information - be it
error code or the comm area return;
A call is registered by the collaboration issuing the
call and will be harvested and/or removed also by the same
collaboration, if there are collaborations subscribed
to the async response topic - _AsyncResponseTopic
- this is
indicated by a non empty value in
_AsyncResponseTopic
.
It is the responsibility of
the collaboration to indicate this by setting
ETD node AsyncResponseTopic
with the topic name
which the async response event will be published to before
the call is executed.
Note, the topic value must coincide with an event type
in the schema and there must be collaboration(s) subscribed
to the topic, in another words, these collaborations will
be notified when there are events published by the
async call handling mechanism when an async call returns
Field Summary |
---|
Constructor Summary | |
---|---|
AsyncCicsCall()
|
Method Summary | |
---|---|
void |
close()
|
void |
execute()
Issue an async call and proceed |
java.lang.Object |
getAsyncCallHandler()
|
byte[] |
getCommArea()
Getter for the CommArea - the CommArea used for passing data and get result from a program invoked; |
int |
getCommAreaLength()
Getter for the CommAreaLength - the CommAreaLength which specify the length of the CommArea used when the CICS program is called, note that the actual length of the byte array represented as CommArea is not
necessarily the length specified in
CommAreaLength ; |
boolean |
getDone()
|
boolean |
getEciExtend()
|
int |
getEciLuwToken()
|
boolean |
getEciSync()
|
boolean |
getEciTPN()
|
java.lang.String |
getJMSparam1()
Getter for user parameter 1; |
java.lang.String |
getJMSparam2()
Getter for user parameter 2; |
java.lang.String |
getJMSparam3()
Getter for user parameter 3; |
java.lang.String |
getJMSparam4()
Getter for user parameter 4; |
java.lang.String |
getJMSparam5()
Getter for user parameter 5; |
int |
getMessageQualifier()
|
int |
getNotifPort()
Getter for Async Response Notification server port; |
java.lang.String |
getNotifServer()
Getter for Async Response Notification server name; |
java.lang.String |
getPassword()
|
int |
getPort()
|
java.lang.String |
getProgram()
Getter for the name of the program invoked; |
void |
getResponse()
Read from the listener the result of the program call; |
int |
getReturnCode()
Getter for the return code for the program call; |
java.lang.String |
getReturnCodeStr()
Getter for the symbolic name for the return code for the program call; |
java.lang.String |
getReturnMessage()
Getter for the return message for the program call; |
long |
getReturnTime()
Getter for the return time of the program call; |
int |
getSecondaryReturnCode()
Getter for the secondary return code for the program call; |
java.lang.String |
getSecondaryReturnCodeStr()
Getter for the symbolic name for the secondary return code for the program call; |
java.lang.String |
getServer()
|
java.lang.String |
getSslClass()
|
java.lang.String |
getSslPassword()
|
long |
getStartTime()
Getter for the start time of the program call; |
java.lang.String |
getTopic()
Getter for Topic - the topic that the completion event of the program will be published to; |
java.lang.String |
getTransId()
|
java.lang.String |
getUrl()
|
java.lang.String |
getUserId()
|
boolean |
isDone()
|
void |
publish()
Publish the async call completion event - it includes information such as CommArea content and other properties of the event such as error code, error text, start time, return time program name, etc. |
boolean |
returnCodeIs(int returncode)
|
boolean |
secondaryReturnCodeIs(int secondaryreturncode)
|
void |
setAsyncCallHandler(java.lang.Object handler)
|
void |
setCommArea(byte[] byteArray)
Setter for the CommArea - the CommArea used for passing data and get result from a program invoked; |
void |
setCommAreaLength(int length)
Setter for the CommAreaLength; |
void |
setDone(boolean done)
|
void |
setEciExtend(boolean b)
|
void |
setEciLuwToken(int i)
|
void |
setEciSync(boolean b)
|
void |
setEciTPN(boolean b)
|
void |
setJMSparam1(java.lang.String jmsparam1)
Setter for user parameter 1; |
void |
setJMSparam2(java.lang.String jmsparam2)
Setter for user parameter 2; |
void |
setJMSparam3(java.lang.String jmsparam3)
Setter for user parameter 3; |
void |
setJMSparam4(java.lang.String jmsparam4)
Setter for user parameter 4; |
void |
setJMSparam5(java.lang.String jmsparam5)
Setter for user parameter 5; |
void |
setMessageQualifier(int i)
|
void |
setNotifPort(int port)
Setter for Async Response Notification server port; |
void |
setNotifServer(java.lang.String server)
Setter for Async Response Notification server name; |
void |
setPassword(java.lang.String s)
|
void |
setPort(int i)
|
void |
setProgram(java.lang.String program)
Setter for the name of the program invoked; |
void |
setReturnCode(int code)
Setter for the return code - the primary return code |
void |
setReturnMessage(java.lang.String msg)
Setter for the return message; |
void |
setReturnTime(long time)
Setter for the return time - the time when the program returned; |
void |
setSBYNDCicsProxyConfig(SBYNDCicsProxyConfig config)
|
void |
setSecondaryReturnCode(int code)
Setter for the secondary return code - the secondary return code |
void |
setServer(java.lang.String s)
|
void |
setSslClass(java.lang.String s)
|
void |
setSslPassword(java.lang.String s)
|
void |
setStartTime(long time)
Setter for the start time - the time when the program call is issued; |
void |
setTopic(java.lang.String topic)
Setter for Topic - the name of the topic that the completion event of the program will be published to; |
void |
setTransId(java.lang.String s)
|
void |
setUrl(java.lang.String s)
|
void |
setUserId(java.lang.String s)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AsyncCicsCall()
Method Detail |
---|
public void setSBYNDCicsProxyConfig(SBYNDCicsProxyConfig config)
public java.lang.String getUrl()
public void setUrl(java.lang.String s)
public java.lang.String getServer()
public void setServer(java.lang.String s)
public int getPort()
public void setPort(int i)
public java.lang.String getSslClass()
public void setSslClass(java.lang.String s)
public java.lang.String getSslPassword()
public void setSslPassword(java.lang.String s)
public boolean getEciSync()
public void setEciSync(boolean b)
public java.lang.String getUserId()
public void setUserId(java.lang.String s)
public java.lang.String getPassword()
public void setPassword(java.lang.String s)
public java.lang.String getTransId()
public void setTransId(java.lang.String s)
public boolean getEciTPN()
public void setEciTPN(boolean b)
public boolean getEciExtend()
public void setEciExtend(boolean b)
public int getEciLuwToken()
public void setEciLuwToken(int i)
public int getMessageQualifier()
public void setMessageQualifier(int i)
public java.lang.String getNotifServer()
public void setNotifServer(java.lang.String server)
server
- - the name of the server;public int getNotifPort()
public void setNotifPort(int port)
port
- - the port of the server;public java.lang.String getTopic()
public void setTopic(java.lang.String topic)
program
- - the name of the program;public java.lang.String getJMSparam1()
public void setJMSparam1(java.lang.String jmsparam1)
JMSparam1
- ;public java.lang.String getJMSparam2()
public void setJMSparam2(java.lang.String jmsparam2)
JMSparam2
- ;public java.lang.String getJMSparam3()
public void setJMSparam3(java.lang.String jmsparam3)
JMSparam3
- ;public java.lang.String getJMSparam4()
public void setJMSparam4(java.lang.String jmsparam4)
JMSparam4
- ;public java.lang.String getJMSparam5()
public void setJMSparam5(java.lang.String jmsparam5)
JMSparam5
- ;public java.lang.String getProgram()
public void setProgram(java.lang.String program)
program
- - the name of the program;public long getStartTime()
public void setStartTime(long time)
time
- - the time when the program call is issued;public long getReturnTime()
public void setReturnTime(long time)
time
- - the time when the program call returns;public byte[] getCommArea()
public void setCommArea(byte[] byteArray)
byteArray
- - the CommArea;public int getCommAreaLength()
CommArea
is not
necessarily the length specified in
CommAreaLength
;
public void setCommAreaLength(int length)
length
- - the length;public int getReturnCode()
public java.lang.String getReturnCodeStr()
public void setReturnCode(int code)
code
- - the code;public int getSecondaryReturnCode()
public java.lang.String getSecondaryReturnCodeStr()
public void setSecondaryReturnCode(int code)
code
- - the code;public java.lang.String getReturnMessage()
public void setReturnMessage(java.lang.String msg)
msg
- - the message text;public java.lang.Object getAsyncCallHandler()
public void setAsyncCallHandler(java.lang.Object handler)
public boolean isDone()
public boolean getDone()
public void setDone(boolean done)
public boolean returnCodeIs(int returncode)
public boolean secondaryReturnCodeIs(int secondaryreturncode)
public void getResponse() throws CicsClientException
CicsClientException
public void close() throws CicsClientException
CicsClientException
public void execute() throws CicsClientException
CicsClientException
public void publish()
public java.lang.String toString()
toString
in class java.lang.Object
|
Sun Adapter for CICS API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |