|
Sun Adapter for CICS API | ||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||
AsyncCallReturnCodes class represents
all the primary return codes (error codes) for an async call,
currently, there are only two, CALL_OK, and CALL_ERROR.AsyncCicsCall class represents
an asynchronous call to a CICS program either by
using CTG or SYBND CICS Listener;AsyncCicsCallList class represents a
list of AsyncCicsCall instances registered by the
collaboration;
it is exposed in ETD as AsyncCalls;
the collaboration code can iterate through the list
by calling hasNext() and next();
or remove an instance by calling remove();CICSApplicationConnectionException without detail message.
CICSApplicationConnectionException with the specified
detail message.
CicsClient class represents
an OTD through which a collaboration can invoke transaction
programs on a CICS server;
nodes and methods are exposed so that collaboration can
conveniently prepare a request to a CICS program and
invoke the program and get result from the program;
in the current implementation, there are two underlying transport
mechanism can be used to achieve the remote invoking of CICS
programs:
(1) CTG - IBM's CICS Transaction Gateway
(2) SBYND CICS Listener - SeeBeyond CICS Listener - a light
weighted propritary protocol based on TCP/IP;
note that, the configuration parameters can be roughly categorized
into :
CTG specific;
SBYND CICS Listener specific;
Needed for both CTG and SBYND CICS Listener;
Also, the exposed CicsClient methods are categorized as:
CTG specific, such as getServerList();
SBYND CICS Listener specific, such as prepareAPCRecord(),
returnCodeIs(), returnOK(), getResponse(...) etc.;
Common to both CTG and SBYND CICS Listener, such as execute(),
execute(....), and sendRequest(...);CicsClient class represents
an OTD through which a collaboration can invoke transaction
programs on a CICS server;
nodes and methods are exposed so that collaboration can
conveniently prepare a request to a CICS program and
invoke the program and get result from the program;
in the current implementation, there are two underlying transport
mechanism can be used to achieve the remote invoking of CICS
programs:
(1) CTG - IBM's CICS Transaction Gateway
(2) SBYND CICS Listener - SeeBeyond CICS Listener - a light
weighted propritary protocol based on TCP/IP;
note that, the configuration parameters can be roughly categorized
into :
CTG specific;
SBYND CICS Listener specific;
Needed for both CTG and SBYND CICS Listener;
Also, the exposed CicsClient methods are categorized as:
CTG specific, such as getServerList();
SBYND CICS Listener specific, such as prepareAPCRecord(),
returnCodeIs(), returnOK(), getResponse(...) etc.;
Common to both CTG and SBYND CICS Listener, such as execute(),
execute(....), and sendRequest(...);Encoding as encoding;
Encoding as encoding;
Encoding as encoding;
Initialization Control Record
over to SBYND CICS Listener;
(3) get ACK from SBYND CICS Listener;
CTGCicsClientImpl class represents
an OTD through which a collaboration can invoke transaction
programs on a CICS server;
nodes and methods are exposed so that collaboration can
conveniently prepare a request to a CICS program and
invoke the program and get result from the program;
in the current implementation, there are two underlying transport
mechanism can be used to achieve the remote invoking of CICS
programs:
(1) CTG - IBM's CICS Transaction Gateway
(2) SBYND CICS Listener - SeeBeyond CICS Listener - a light
weighted propritary protocol based on TCP/IP;
note that, the configuration parameters can be roughly categorized
into :
CTG specific;
SBYND CICS Listener specific;
Needed for both CTG and SBYND CICS Listener;
Also, the exposed CicsClient methods are categorized as:
CTG specific, such as getServerList();
SBYND CICS Listener specific, such as prepareAPCRecord(),
returnCodeIs(), returnOK(), getResponse(...) etc.;
Common to both CTG and SBYND CICS Listener, such as execute(),
execute(....), and sendRequest(...);ECIErrorCodes class represents
all ECI error codes, it delegates all accessor
of error code;SBYND_LISTENER_REQCODE_REQ_SYNC
or SBYND_LISTENER_REQCODE_REQ_ASYNC depend on
parameter
eciSynCall
with byteArray as the payload;
the prepare APC record is in the outbound buffer in SBYNDCicsProxy
(2) send the request to SBYND CICS Listener;
(3) get response from SBYND CICS Listener;
(4) further get returned data from the program if it is a sync
call
(5) ACK or NACK accordingly
For CTG:
prepare an ECIRequest object with the data given via the
parameters, call method flow() to send the request and
get result (sync) or proceed (async);
SBYND_LISTENER_REQCODE_REQ_SYNC
or SBYND_LISTENER_REQCODE_REQ_ASYNC depend on
parameter
eciSynCall
with byteArray as the payload;
the prepare APC record is in the outbound buffer in SBYNDCicsProxy
(2) send the request to SBYND CICS Listener;
(3) get response from SBYND CICS Listener;
(4) further get returned data from the program if it is a sync
call
(5) ACK or NACK accordingly
For CTG:
prepare an ECIRequest object with the data given via the
parameters, call method flow() to send the request and
get result (sync) or proceed (async);
SBYND_LISTENER_REQCODE_REQ_SYNC
or SBYND_LISTENER_REQCODE_REQ_ASYNC depend on
parameter
eciSynCall
with byteArray as the payload;
the prepare APC record is in the outbound buffer in SBYNDCicsProxy
(2) send the request to SBYND CICS Listener;
(3) get response from SBYND CICS Listener;
(4) further get returned data from the program if it is a sync
call
(5) ACK or NACK accordingly
For CTG:
prepare an ECIRequest object with the data given via the
parameters, call method flow() to send the request and
get result (sync) or proceed (async);
SBYND_LISTENER_REQCODE_REQ_SYNC
or SBYND_LISTENER_REQCODE_REQ_ASYNC depend on
parameter
eciSynCall
with byteArray as the payload;
the prepare APC record is in the outbound buffer in SBYNDCicsProxy
(2) send the request to SBYND CICS Listener;
(3) get response from SBYND CICS Listener;
(4) further get returned data from the program if it is a sync
call
(5) ACK or NACK accordingly
For CTG:
prepare an ECIRequest object with the data given via the
parameters, call method flow() to send the request and
get result (sync) or proceed (async);
AsyncResponseTopic;
Return the current value in CicsClient node
AsyncResponseTopic, the topic is used
by async call handler to publish the program completion
information such as CommArea returned from
the called program, error code and error text if there
is any;
initial value is from the configuration parameter
Async Response Topic in section "CICS Client";
AsyncRspNotifPort;
Return the current value in CicsClient
AsyncRspNotifPort, the port is used
by async call handler to publish the program completion
information such as CommArea returned from
the called program, error code and error text if there
is any;
initial value is from the configuration parameter
Async Call JMS Server Port in section "CICS
Client";
AsyncRspNotifServer;
Return the current value in CicsClient node
AsyncRspNotifServer, the host name is used
by async call handler to publish the program completion
information such as CommArea returned from
the called program, error code and error text if there
is any;
initial value is from the configuration parameter
Async Call JMS Server Host in section "CICS
Client";
CommArea;
Return the CommArea
- i.e.
CommArea;
Return the CommArea
- i.e.
CommArea;
Return the CommArea
- i.e.
CommArea is not
necessarily the length specified in
CommAreaLength;
CommArea is not
necessarily the length specified in
CommAreaLength;
CommAreaLength;
Return the CommAreaLength
- i.e.
CommAreaLength;
Return the CommAreaLength
- i.e.
CommAreaLength;
Return the CommAreaLength
- i.e.
EciCallbackable;
ECIErrorCodes object;
this getter is for CicsClient ECIERRORS;
ECIErrorCodes object;
this getter is for CicsClient ECIERRORS;
ECIErrorCodes object;
this getter is for CicsClient ECIERRORS;
ECIErrorCodes object;
this getter is for CicsClient ECIERRORS;
EciExtend;
Return the EciExtend flag (refer to CTG doc for detailed
description of the flag)
- i.e.
EciExtend;
Return the EciExtend flag (refer to CTG doc for detailed
description of the flag)
- i.e.
EciExtend;
Return the EciExtend flag (refer to CTG doc for detailed
description of the flag)
- i.e.
EciLuwToken;
Return the ECI Luw token;
- i.e.
EciLuwToken;
Return the ECI Luw token;
- i.e.
EciLuwToken;
Return the ECI Luw token;
- i.e.
EciSync;
Return the ECI call type
- i.e.
EciSync;
Return the ECI call type
- i.e.
EciSync;
Return the ECI call type
- i.e.
eciTPN;
Return the ECI Transid type
CTG Only;
eciTPN;
Return the ECI Transid type
CTG Only;
eciTPN;
Return the ECI Transid type
CTG Only;
Encoding;
Return the encoding which can be used
to translate the data to and from the CICS
program - i.e.
Encoding;
Return the encoding which can be used
to translate the data to and from the CICS
program - i.e.
Encoding;
Return the encoding which can be used
to translate the data to and from the CICS
program - i.e.
Host;
Return Host pointing to the Listener to connect to
- i.e.
Host;
Return Host pointing to the Listener to connect to
- i.e.
Host;
Return Host pointing to the Listener to connect to
- i.e.
ListenerTimeout
initial value is from configuration parameter
Listener Timeout
in section "SeeBeyond CICS Listener";
ListenerTimeout
initial value is from configuration parameter
Listener Timeout
in section "SeeBeyond CICS Listener";
ListenerTimeout
initial value is from configuration parameter
Listener Timeout
in section "SeeBeyond CICS Listener";
ListenerTimeout
initial value is from configuration parameter
Listener Timeout
in section "SeeBeyond CICS Listener";
MessageQualifier;
Return the MessageQualifier for ECI call
- i.e.
MessageQualifier;
Return the MessageQualifier for ECI call
- i.e.
MessageQualifier;
Return the MessageQualifier for ECI call
- i.e.
PaddingCharacter
initial value is from configuration parameter
COMMAREA Padding Character
in section "SeeBeyond CICS Listener";
PaddingCharacter
initial value is from configuration parameter
COMMAREA Padding Character
in section "SeeBeyond CICS Listener";
PaddingCharacter
initial value is from configuration parameter
COMMAREA Padding Character
in section "SeeBeyond CICS Listener";
PaddingCharacter
initial value is from configuration parameter
COMMAREA Padding Character
in section "SeeBeyond CICS Listener";
Password;
Return the CICS user password
- i.e.
Password;
Return the CICS user password
- i.e.
Password;
Return the CICS user password
- i.e.
PollingRate
initial value is from configuration parameter
Polling Rate
in section "SeeBeyond CICS Listener";
PollingRate
initial value is from configuration parameter
Polling Rate
in section "SeeBeyond CICS Listener";
PollingRate
initial value is from configuration parameter
Polling Rate
in section "SeeBeyond CICS Listener";
PollingRate
initial value is from configuration parameter
Polling Rate
in section "SeeBeyond CICS Listener";
Port;
Return the port of the host where CTG
gateway or listener is to be connected to - i.e.
Port;
Return the port of the host where CTG
gateway is to be connected to - i.e.
Port;
Return the port of the host where CTG
gateway is to be connected to - i.e.
Program;
Return the CICS program name to be invoked;
- i.e.
Program;
Return the CICS program name to be invoked;
- i.e.
Program;
Return the CICS program name to be invoked;
- i.e.
SBYNDAppControlRecordRequestCodes object;
this getter is for CicsClient REQUESTCODES;
SBYNDAppControlRecordRequestCodes object;
this getter is for CicsClient REQUESTCODES;
SBYNDAppControlRecordRequestCodes object;
this getter is for CicsClient REQUESTCODES;
SBYNDAppControlRecordRequestCodes object;
this getter is for CicsClient REQUESTCODES;
SBYNDAppControlRecordReturnCodes object;
this getter is for CicsClient RETURNCODES;
SBYNDAppControlRecordReturnCodes object;
this getter is for CicsClient RETURNCODES;
SBYNDAppControlRecordReturnCodes object;
this getter is for CicsClient RETURNCODES;
SBYNDAppControlRecordReturnCodes object;
this getter is for CicsClient RETURNCODES;
SBYNDListenerTransID
initial value is from configuration parameter
SeeBeyond CICS Listener TransId
in section "SeeBeyond CICS Listener";
SBYNDListenerTransID
initial value is from configuration parameter
SeeBeyond CICS Listener TransId
in section "SeeBeyond CICS Listener";
SBYNDListenerTransID
initial value is from configuration parameter
SeeBeyond CICS Listener TransId
in section "SeeBeyond CICS Listener";
SBYNDListenerTransID
initial value is from configuration parameter
SeeBeyond CICS Listener TransId
in section "SeeBeyond CICS Listener";
Server;
Return CICS server name where the request is sent to
- i.e.
Server;
Return CICS server name where the request is sent to
- i.e.
Server;
Return CICS server name where the request is sent to
- i.e.
SslClass;
Return the SSL class for SSL authentication
- i.e.
SslClass;
Return the SSL class for SSL authentication
- i.e.
SslClass;
Return the SSL class for SSL authentication
- i.e.
SslPassword;
Return the PASSWORD for the encrypted KeyRing class;
- i.e.
SslPassword;
Return the PASSWORD for the encrypted KeyRing class;
- i.e.
SslPassword;
Return the PASSWORD for the encrypted KeyRing class;
- i.e.
StartDelay
initial value is from configuration parameter
Start Delay
in section "SeeBeyond CICS Listener";
StartDelay
initial value is from configuration parameter
Start Delay
in section "SeeBeyond CICS Listener";
StartDelay
initial value is from configuration parameter
Start Delay
in section "SeeBeyond CICS Listener";
StartDelay
initial value is from configuration parameter
Start Delay
in section "SeeBeyond CICS Listener";
StartType
initial value is from configuration parameter
Start Type
in section "SeeBeyond CICS Listener";
StartType
initial value is from configuration parameter
Start Type
in section "SeeBeyond CICS Listener";
StartType
initial value is from configuration parameter
Start Type
in section "SeeBeyond CICS Listener";
StartType
initial value is from configuration parameter
Start Type
in section "SeeBeyond CICS Listener";
TPTimeout
initial value is from configuration parameter
TP Timeout
in section "SeeBeyond CICS Listener";
TPTimeout
initial value is from configuration parameter
TP Timeout
in section "SeeBeyond CICS Listener";
TPTimeout
initial value is from configuration parameter
TP Timeout
in section "SeeBeyond CICS Listener";
TPTimeout
initial value is from configuration parameter
TP Timeout
in section "SeeBeyond CICS Listener";
TraceDumpOffset;
Return the trace dump offset for CTG client log;
- i.e.
TraceDumpOffset;
Return the trace dump offset for CTG client log;
- i.e.
TraceDumpOffset;
Return the trace dump offset for CTG client log;
- i.e.
TraceFilename;
Return the trace file name for CTG client log;
- i.e.
TraceFilename;
Return the trace file name for CTG client log;
- i.e.
TraceFilename;
Return the trace file name for CTG client log;
- i.e.
TraceLevel;
Return the trace level for CTG client log;
- i.e.
TraceLevel;
Return the trace level for CTG client log;
- i.e.
TraceLevel;
Return the trace level for CTG client log;
- i.e.
TraceTiming;
Return the trace timing (time stamp) in CTG client log;
- i.e.
TraceTiming;
Return the trace timing (time stamp) in CTG client log;
- i.e.
TraceTiming;
Return the trace timing (time stamp) in CTG client log;
- i.e.
TraceTruncationSize;
Return the trace truncation size for CTG client log;
- i.e.
TraceTruncationSize;
Return the trace truncation size for CTG client log;
- i.e.
TraceTruncationSize;
Return the trace truncation size for CTG client log;
- i.e.
TransId;
Return the CICS transId to be invoked;
- i.e.
TransId;
Return the CICS transId to be invoked;
- i.e.
TransId;
Return the CICS transId to be invoked;
- i.e.
TransportTimeout
initial value is from configuration parameter
Transport Timeout
in section "SeeBeyond CICS Listener";
TransportTimeout
initial value is from configuration parameter
Transport Timeout
in section "SeeBeyond CICS Listener";
TransportTimeout
initial value is from configuration parameter
Transport Timeout
in section "SeeBeyond CICS Listener";
TransportTimeout
initial value is from configuration parameter
Transport Timeout
in section "SeeBeyond CICS Listener";
Url;
Return URL pointing to the remote or local CICS transaction
gateway to connect to - i.e.
Url;
Return URL pointing to the remote or local CICS transaction
gateway to connect to - i.e.
Url;
Return URL pointing to the remote or local CICS transaction
gateway to connect to - i.e.
UserId;
Return the CICS user id
- i.e.
UserId;
Return the CICS user id
- i.e.
UserId;
Return the CICS user id
- i.e.
EciCallbackable node,
then implicitly, the async call will be registered in
the pool;
code;
code;
code;
code;
SBYND_LISTENER_RC_OK;
SBYND_LISTENER_RC_OK;
SBYND_LISTENER_RC_OK;
SBYND_LISTENER_RC_OK;
SBYNDAppControlRecordRequestCodes class represents
all the request codes in Application Control Record -
see CICS eWay (SBYND CICS Listener) for detailed
description for each of the code.SBYNDAppControlRecordReturnCodes class represents
all the return codes (error codes) in Application Control
Record - see CICS eWay (SBYND CICS Listener) for details.SBYNDCicsProxy class represents
a connection to the SBYND CICS Listener;
methods are implemented and exposed to
enable the caller to invoke CICS transaction programs on the host
(via SBYND CICS Listener), passing data to and get result from it;SBYNDCicsProxyConfig class represents
configuration information specific to SBYND CICS Listener.SBYNDCicsProxyConstants represents all constants
referenced in the ETD implementation;
it contains keys for localizable messages and names etc.SBYNDCicsProxyResource class represents
All localized resources such as error messages, trace messages,
configuration names etc.SBYNDCicsProxyTimeoutException class represents
timeout exception for socket IO on the TCP/IP connection;AsyncResponseTopic;
once is set, the value will be used by the
subsequent async call such as execute() until it
is set again to another value.
AsyncRspNotifPort;
once is set, the value will be used by the
subsequent async call such as execute() for publishing
async call completion event until it
is set again to another value.
AsyncRspNotifServer;
once is set, the value will be used by the
subsequent async call such as execute() for publishing
to the server with topic as indicated by the
value in AsyncResponseTopic until it
is set again to another value.
CommArea;
set the payload into CommArea usually used
by the subsequent program invoking;
CommArea;
set the payload into CommArea usually used
by the subsequent program invoking;
CommArea;
set the payload into CommArea usually used
by the subsequent program invoking;
CommAreaLength;
length of the CommArea;
initial value is from the configuration parameter:
COMMAREA Length;
CommAreaLength;
length of the CommArea;
initial value is from the configuration parameter:
COMMAREA Length;
CommAreaLength;
length of the CommArea;
initial value is from the configuration parameter:
COMMAREA Length;
EciCallbackable;
EciExtend;
Have effect for CTG only;
Ignored by SBYND Listener - not implemented;
EciExtend;
Have effect for CTG only;
Ignored by SBYND Listener - not implemented;
EciExtend;
Have effect for CTG only;
Ignored by SBYND Listener - not implemented;
EciLuwToken;
An integer identifying a LUW;
initial value is from the configuration parameter:
ECI LUW token in section "CICS Client";
CTG specific;
EciLuwToken;
An integer identifying a LUW;
initial value is from the configuration parameter:
ECI LUW token in section "CICS Client";
CTG specific;
EciLuwToken;
An integer identifying a LUW;
initial value is from the configuration parameter:
ECI LUW token in section "CICS Client";
CTG specific;
EciSync;
indicate if the call will be sync or async;
EciSync;
indicate if the call will be sync or async;
EciSync;
indicate if the call will be sync or async;
eciTPN;
indicate if the transid will be interpreted as ECI_TPN;
eciTPN;
indicate if the transid will be interpreted as ECI_TPN;
eciTPN;
indicate if the transid will be interpreted as ECI_TPN;
Encoding;
Encoding;
Encoding;
Host;
Set Host pointing to the Listener to connect to;
Listener specific;
Host;
Set Host pointing to the Listener to connect to;
Listener specific;
Host;
Set Host pointing to the Listener to connect to;
Listener specific;
ListenerTimeout
ListenerTimeout
ListenerTimeout
ListenerTimeout
MessageQualifier;
Have effect for CTG only;
Ignored by SBYND Listener - not implemented;
MessageQualifier;
Have effect for CTG only;
Ignored by SBYND Listener - not implemented;
MessageQualifier;
Have effect for CTG only;
Ignored by SBYND Listener - not implemented;
PaddingCharacter
PaddingCharacter
PaddingCharacter
PaddingCharacter
Password;
the CICS password needed to authenticate the user
when calling the CICS program;
Password;
the CICS password needed to authenticate the user
when calling the CICS program;
Password;
the CICS password needed to authenticate the user
when calling the CICS program;
PollingRate
PollingRate
PollingRate
PollingRate
Port;
Set port of the host where the CTG or listener is running;
Port;
Set port of the host where the CTG is running;
CTG specific;
Port;
Set port of the host where the CTG is running;
CTG specific;
Program;
the CICS program to be called;
Program;
the CICS program to be called;
Program;
the CICS program to be called;
SBYNDListenerTransID
SBYNDListenerTransID
SBYNDListenerTransID
SBYNDListenerTransID
Server;
Server;
Server;
SslClass;
CTG specific;
SslClass;
CTG specific;
SslClass;
CTG specific;
SslPassword;
the PASSWORD for the encrypted KeyRing class;
CTG specific;
SslPassword;
the PASSWORD for the encrypted KeyRing class;
CTG specific;
SslPassword;
the PASSWORD for the encrypted KeyRing class;
CTG specific;
StartDelay
StartDelay
StartDelay
StartDelay
StartType
StartType
StartType
StartType
TPTimeout
TPTimeout
TPTimeout
TPTimeout
TraceDumpOffset;
TraceDumpOffset;
TraceDumpOffset;
TraceFilename;
TraceFilename;
TraceFilename;
TraceLevel;
TraceLevel;
TraceLevel;
TraceTiming;
CTG only;
TraceTiming;
CTG only;
TraceTiming;
CTG only;
TraceTruncationSize;
TraceTruncationSize;
TraceTruncationSize;
Program;
the CICS program's trans ID to be called;
Program;
the CICS program's trans ID to be called;
Program;
the CICS program's trans ID to be called;
TransportTimeout
TransportTimeout
TransportTimeout
TransportTimeout
Url;
Set URL pointing to the remote or local CICS transaction
gateway to connect to;
CTG specific;
Url;
Set URL pointing to the remote or local CICS transaction
gateway to connect to;
CTG specific;
Url;
Set URL pointing to the remote or local CICS transaction
gateway to connect to;
CTG specific;
UserId;
UserId;
UserId;
Encoding as
the encoding;
enc;
Encoding as
the encoding;
enc;
Encoding as
the encoding;
enc;
zoned to a String using current value
of CicsClient Encoding as encoding;
zoned to a String using
the specified encoding enc;
zoned to a String using current value
of CicsClient Encoding as encoding;
zoned to a String using
the specified encoding enc;
zoned to a String using current value
of CicsClient Encoding as encoding;
zoned to a String using
the specified encoding enc;
|
Sun Adapter for CICS API | ||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||