public enum RequestData extends java.lang.Enum<RequestData>
RequestExit
eventFired()
method.
See the package overview for details.
Most values are only used on flow-related RequestEvents
(RequestEntry
, RequestDetails
and ResponseExit
).
A full table of the data available for each of the RequestEvents is available in
the Programming Guide in the CICS Transaction Gateway information center.Enum Constant and Description |
---|
Channel
The channel information associated with the request.
|
CicsAbendCode
The CICS abend code on a response.
|
CicsCorrelator
The CICS network unit of work ID (z/OS only).
|
CicsReturnCode
The CICS return code on a response.
|
CicsServer
The CICS server that CICS Transaction Gateway sent the request to.
|
ClientCtgApplid
The APPLID of the client application.
|
ClientCtgApplidQualifier
The APPLID qualifier of the client application.
|
ClientCtgCorrelator
The correlator generated by the client application.
|
ClientLocation
The location of the Client application (IP address).
|
CommandData
The command data originating from a request monitor exit administration request.
|
CtgApplid
The CICS Transaction Gateway APPLID.
|
CtgApplidQualifier
The CICS Transaction Gateway APPLID qualifier.
|
CtgCorrelator
The CICS Transaction Gateway identifier used to track the request flow within the
CICS Transaction Gateway instance.
|
CtgReturnCode
The CICS Transaction Gateway return code on a response.
|
DistributedIdentity
The distributed identity associated with the transaction.
|
EwlmToken
Deprecated.
No longer supported and provided only for backwards compatibility.
|
FlowTopology
The CICS Transaction Gateway topology that the request exit is deployed in.
|
FlowType
The flow type of this request or response.
|
GatewayUrl
The URL of the Gateway that the client application is connecting to.
|
Location
The location of the monitoring request exit.
|
LuwToken
The CICS Transaction Gateway logical unit of work token.
|
OriginData
Data identifying the Client application that originated a CICS task and
that contains the APPLID and APPLID qualifier.
|
PayLoad
A copy of the COMMAREA for use in the exit.
|
Program
The CICS program name.
|
RequestReceived
The timestamp of request flow received in the Gateway classes or Gateway
daemon classes.
|
RequestSent
The timestamp of request flow sent from the client application or Gateway
daemon classes.
|
ResponseReceived
The timestamp of response flow received in the Gateway classes or Gateway daemon classes.
|
ResponseSent
The timestamp of response flow sent from the Gateway classes or Gateway daemon classes.
|
RetryCount
The number of times the Gateway daemon retried sending a request to CICS.
|
Server
The server specified in the request.
|
TpnName
The CICS TPN Name.
|
TranName
The CICS transaction ID.
|
Urid
The RRMS URID for XA transactions.
|
Userid
The CICS user ID.
|
WireSize
The number of bytes of data received from or about to be sent to the remote client.
|
WorkerWaitTime
The time in milliseconds that the Gateway daemon waited for a worker thread
to become available to process the request.
|
XaReturnCode
The XA return code on a response.
|
XctCurrent
The XCT current ID for this request.
|
XctParent
The XCT parent ID for this request.
|
XctRoot
The XCT request ID.
|
Xid
The XID for XA transactions.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DATA_TYPE_BYTE_ARRAY
It has a data type of array of
bytes . |
static java.lang.String |
DATA_TYPE_CHANNEL_INFO
It has a data type of
ChannelInfo . |
static java.lang.String |
DATA_TYPE_DISTRIBUTED_IDENTITY
It has a data type of
DistributedIdentity . |
static java.lang.String |
DATA_TYPE_FLOW_TOPOLOGY
It has a data type of enum of the
FlowTopology . |
static java.lang.String |
DATA_TYPE_FLOW_TYPE
It has a data type of enum of the
FlowType . |
static java.lang.String |
DATA_TYPE_INET_ADDRESS
It has a data type of
InetAddress . |
static java.lang.String |
DATA_TYPE_INTEGER
It has a data type of
Integer . |
static java.lang.String |
DATA_TYPE_LONG
It has a data type of
Long . |
static java.lang.String |
DATA_TYPE_ORIGIN_DATA
It has a data type of
OriginData . |
static java.lang.String |
DATA_TYPE_STRING
It has a data type of
String . |
static java.lang.String |
DATA_TYPE_TRANSIENT_PAYLOAD
It has a data type of
TransientPayLoad . |
static java.lang.String |
DATA_TYPE_XID
It has a data type of
Xid . |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDataType()
Returns the type of data for the request data.
|
static RequestData |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static RequestData[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final RequestData CtgApplid
FlowTopology
is Gateway
,
then this is the Gateway daemon APPLID, otherwise
it is the client application APPLID.
The CtgApplid is available for all
flow-related RequestEvents
in all FlowTopologies
.
It is a 1 to 8 character String
.
public static final RequestData CtgApplidQualifier
FlowTopology
is Gateway
,
then this is the Gateway daemon APPLID qualifier, otherwise
it is the client application APPLID qualifier.
The CtgApplidQualifier is available for all
flow-related RequestEvents
in all FlowTopologies
.
It is a 1 to 8 character String
.
public static final RequestData CtgCorrelator
The CtgCorrelator is available for all
flow-related RequestEvents
in all FlowTopologies
.
The CtgCorrelator is used to uniquely identify this flow within the given CICS Transaction Gateway instance.
It is an Integer
.
public static final RequestData RequestReceived
The RequestReceived timestamp is available for all
flow-related RequestEvents
in all FlowTopologies
.
This is the time the request was received by the client application
(LocalClient
or
RemoteClient
FlowTopology
)
or Gateway daemon
(Gateway
FlowTopology
) classes.
Timestamps are expressed as the number of milliseconds since
January 1, 1970, 00:00:00 GMT.
It is a Long
.
public static final RequestData RequestSent
The RequestSent timestamp is available for all
ResponseExit
flow-related RequestEvents
in all FlowTopologies
where the request was flowed on to either CICS or a Gateway daemon.
This is the time the request was sent on from the client application
(LocalClient
or
RemoteClient
FlowTopology
)
or Gateway daemon
(Gateway
FlowTopology
) classes.
Timestamps are expressed as the number of milliseconds since
January 1, 1970, 00:00:00 GMT.
It is a Long
.
public static final RequestData ResponseReceived
The ResponseReceived timestamp is available for all
ResponseExit
flow-related RequestEvents
in all FlowTopologies
where the request was flowed on to either CICS or a Gateway daemon.
This is the time the response was received by the client application
(LocalClient
or
RemoteClient
FlowTopology
)
or Gateway daemon
(Gateway
FlowTopology
) classes.
Timestamps are expressed as the number of milliseconds since
January 1, 1970, 00:00:00 GMT.
It is a Long
.
public static final RequestData ResponseSent
The ResponseSent timestamp is available for all
ResponseExit
flow-related RequestEvents
in all FlowTopologies
.
This is the time the response was returned from the client application
(LocalClient
or
RemoteClient
FlowTopology
)
or Gateway daemon
(Gateway
FlowTopology
) classes.
Timestamps are expressed as the number of milliseconds since
January 1, 1970, 00:00:00 GMT.
It is a Long
.
public static final RequestData WorkerWaitTime
This is available for all
ResponseExit
RequestEvents
in Gateway
FlowTopology
.
It is an Integer
.
public static final RequestData ClientCtgApplid
The ClientCtgApplid is available for all
flow-related RequestEvents
in the Gateway
FlowTopology
where
the client application is using at least version 7.1 of the CICS
Transaction Gateway Java client classes or is an application written
in C or .NET using at least version 8.1 of the appropriate CICS
Transaction Gateway API library.
It is a 1 to 8 character String
.
public static final RequestData ClientCtgApplidQualifier
The ClientCtgApplidQualifier is available for all
flow-related RequestEvents
in the Gateway
FlowTopology
where
the client application is using at least version 7.1 of the CICS
Transaction Gateway Java client classes or is an application written
in C or .NET using at least version 8.1 of the appropriate CICS
Transaction Gateway API library.
It is a 1 to 8 character String
.
public static final RequestData ClientCtgCorrelator
The ClientCtgCorrelator is available for all
flow-related RequestEvents
in the Gateway
FlowTopology
where
the client application is using at least version 7.1 of the CICS
Transaction Gateway Java client classes or is an application written
in C or .NET calling the appropriate CICS Transaction Gateway API.
It is an Integer
.
public static final RequestData FlowType
The FlowType is available for all
flow-related RequestEvents
in all FlowTopologies
.
It is an enum of the FlowType
of this request or response flow.
public static final RequestData Program
The Program is available for all flow-related
RequestEvents
for all ECI
FlowTypes
(EciSynconreturn
,
ExtendedModeEci
and
XaEci
)
in all FlowTopologies
.
It is a 1 to 8 character String
.
public static final RequestData TranName
The TranName is available for all flow-related
RequestEvents
for all ECI
FlowTypes
(EciSynconreturn
,
ExtendedModeEci
and
XaEci
)
in all FlowTopologies
.
It is a 1 to 4 character String
.
public static final RequestData TpnName
The TpnName is available for all flow-related
RequestEvents
for all ECI
FlowTypes
(EciSynconreturn
,
ExtendedModeEci
and
XaEci
)
in all FlowTopologies
.
It is a 1 to 4 character String
.
public static final RequestData Userid
The Userid is available for all flow-related
RequestEvents
for all
FlowTypes
in all FlowTopologies
.
It is a 1 to 16 character String
.
public static final RequestData Server
The Server is available for all flow-related
RequestEvents
for all
FlowTypes
involving a CICS server
in all FlowTopologies
.
This is the CICS server that was specified on the request. It can be blank or null.
It is a String
.
public static final RequestData GatewayUrl
The GatewayUrl is available for all flow-related
RequestEvents
for
RemoteClient
FlowTopology
.
This is the URL of the target Gateway daemon the client is connecting to.
It is a String
.
public static final RequestData Location
The Location is available for all flow-related
RequestEvents
for
RemoteClient
and
Gateway
FlowTopologies
.
It is an InetAddress
.
public static final RequestData ClientLocation
The ClientLocation is available for all flow-related
RequestEvents
for
Gateway
FlowTopology
.
It is an InetAddress
.
public static final RequestData LuwToken
The LuwToken is available for all flow-related
RequestEvents
for all extended
unit of work (LUW) FlowTypes
(ExtendedModeEci
,
ExtendedModeCommit
and
ExtendedModeRollback
) for all
FlowTopologies
.
The LUW Token is 0 on the first ExtendedModeEci
of an LUW. The Gateway generates a new LUW token when the first ExtendedModeEci
request is received with an LUW token of 0. The new LUW token is returned on the response flow. The LUW token is used
to identify all subsequent requests as part of the LUW, including
ExtendedModeCommit
and
ExtendedModeRollback
.
It is an Integer
.
public static final RequestData FlowTopology
The FlowTopology is available for all
flow-related RequestEvents
in all FlowTopologies
.
It is an enum of the FlowTopology
of the request flow.
@Deprecated public static final RequestData EwlmToken
public static final RequestData OriginData
The OriginData is available for all
RequestDetails
and
ResponseExit
RequestEvents
for IPIC transactions in all FlowTopologies
.
OriginData is the Point of Origin for this IPIC Transaction. This data is incorporated into the association data that is used by CICS for the duration of the transaction.
It is an OriginData
.
public static final RequestData PayLoad
The PayLoad is available for all flow-related
RequestEvents
for all ECI
FlowTypes
(EciSynconreturn
,
ExtendedModeEci
and
XaEci
) using COMMAREAs
in all FlowTopologies
.
This field is not available for flows using channels and containers.
The contents are only guaranteed for the duration of the
eventFired()
method.
It is a TransientPayLoad
.
public static final RequestData WireSize
The WireSize is available for all flow-related
RequestEvents
for
Gateway
FlowTopology
.
It is an Integer
.
public static final RequestData Xid
Xid request data is available for all flow-related
RequestEvents
for all
FlowTopologies
for all
XA FlowTypes
except
XaRecover
.
It is an Xid
.
public static final RequestData Urid
Urid request data is only available for a
ResponseExit
RequestEvent
for
XaStart
FlowType
for
Gateway
and
LocalClient
FlowTopologies
.
It is an array of 16 bytes.
public static final RequestData CtgReturnCode
CtgReturnCode request data is available for all
ResponseExit
RequestEvents
for all
FlowTopologies
.
CtgReturnCode request data is the CICS Transaction Gateway return code
returned to the client application by
GatewayRequest.getGatewayRc()
.
See GatewayReturnCodes
.
It is an Integer
.
public static final RequestData CicsReturnCode
CicsReturnCode request data is available for all
ResponseExit
RequestEvents
for all
FlowTypes
that interact with CICS for all
FlowTopologies
, and for all
RequestDetails
RequestEvents
for all FlowTypes
that are eligible for retries in Gateway
FlowTopology
.
CicsReturnCode request data is the CICS return code returned to the client
application by ECIRequest.getCicsRc()
.
For the RequestDetails
event, this field
will show the retryable error that caused the request to be retried using a
CICSRequestExit
or Dynamic Server
Selection (DSS) policy on z/OS. If the request has not been retried, this
field will be zero.
Retryable errors are:
See ECIReturnCodes
.
It is an Integer
.
public static final RequestData CicsAbendCode
CicsAbendCode request data is available for all
ResponseExit
RequestEvents
for all
FlowTypes
interacting with CICS for all
FlowTopologies
.
CicsAbendCode request data is the abend code returned to the client
application in ECIRequest.Abend_Code
.
It is a 4 character String
.
public static final RequestData XaReturnCode
XaReturnCode request data is available for all
ResponseExit
RequestEvents
for all FlowTopologies
for all XA FlowTypes
except XaEci
.
XaReturnCode request data is the XA return code that the application server receives.
It is an Integer
.
public static final RequestData CommandData
CommandData request data is only available for
Command
RequestEvents
.
CommandData request data is the command data originating from a request monitor exit administration request.
It is a String
.
public static final RequestData CicsServer
CicsServer request data is available for all
RequestDetails
and
ResponseExit
RequestEvents
for all
FlowTypes
that interact with
CICS in Gateway
FlowTopology
.
CicsServer might be different to Server
if one of the following conditions applies:
CICSRequestExit
and this changes the CICS server that work is being sent to.
Server
.
It is a String
.
public static final RequestData RetryCount
RetryCount request data is available for all
RequestDetails
and
ResponseExit
RequestEvents
for all
FlowTypes
that are eligible for
retries in Gateway
FlowTopology
.
If a request was retried because of one or more retryable errors when
using a CICSRequestExit
or Dynamic
Server Selection (DSS) policy on z/OS then this field will show how many
times the request was retried by the Gateway daemon.
Retryable errors are:
It is an Integer
.
public static final RequestData DistributedIdentity
DistributedIdentity request data is available for all flow-related
RequestEvents
for
flows using a JEE client with identity propagation configured and
EciSynconreturn
,
ExtendedModeEci
and
XaEci
FlowTypes
in all FlowTopologies
.
It is a DistributedIdentity
.
public static final RequestData CicsCorrelator
CicsCorrelator request data is available for all flow-related
RequestEvents
for
EciSynconreturn
FlowType
in LocalClient
and Gateway
FlowTopologies
.
The CicsCorrelator is included for requests on the z/OS platform if the protocol is EXCI. CICS sets this value as the NETUOWID field associated with the CICS mirror task.
It is byte array with a maximum size of 27.
public static final RequestData Channel
The Channel is available for all flow-related
RequestEvents
for all ECI FlowTypes
(EciSynconreturn
,
ExtendedModeEci
and
XaEci
) using channels and containers
in all FlowTopologies
.
It is a ChannelInfo
.
public static final RequestData XctRoot
This identifier is passed to CICS in the origin data.
It is a String
.
public static final RequestData XctParent
It is a String
.
public static final RequestData XctCurrent
This is the CICS TG XCT identifier that is passed to CICS in the origin data.
It is a String
.
public static final java.lang.String DATA_TYPE_BYTE_ARRAY
bytes
.public static final java.lang.String DATA_TYPE_DISTRIBUTED_IDENTITY
DistributedIdentity
.public static final java.lang.String DATA_TYPE_FLOW_TOPOLOGY
FlowTopology
.public static final java.lang.String DATA_TYPE_FLOW_TYPE
FlowType
.public static final java.lang.String DATA_TYPE_INET_ADDRESS
InetAddress
.public static final java.lang.String DATA_TYPE_INTEGER
Integer
.public static final java.lang.String DATA_TYPE_LONG
Long
.public static final java.lang.String DATA_TYPE_ORIGIN_DATA
OriginData
.public static final java.lang.String DATA_TYPE_STRING
String
.public static final java.lang.String DATA_TYPE_TRANSIENT_PAYLOAD
TransientPayLoad
.public static final java.lang.String DATA_TYPE_XID
Xid
.public static final java.lang.String DATA_TYPE_CHANNEL_INFO
ChannelInfo
.public static RequestData[] values()
for (RequestData c : RequestData.values()) System.out.println(c);
public static RequestData valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified namejava.lang.NullPointerException
- if the argument is nullpublic java.lang.String getDataType()
public void appendRequestData(StringBuffer message, RequestData requestData, Object object) { message.append(requestData); // toString() generates a readable string message.append(" = "); if (requestData.getDataType().equals(RequestData.DATA_TYPE_BYTE_ARRAY)) { // As basic toString() formatting of byte arrays is not // very readable, we use an internal method for request data // of that type. byte[] bytes = (byte[]) object; message.append(toHex(bytes)); } else { message.append(object); } }