CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.ctg.monitoring
Enum RequestData

java.lang.Object
  extended by java.lang.Enum<RequestData>
      extended by com.ibm.ctg.monitoring.RequestData
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<RequestData>

public enum RequestData
extends java.lang.Enum<RequestData>

This enumeration defines the data passed to the RequestExit eventFired() method.


Enum Constant Summary
CicsAbendCode
          CICS Abend code on a response is a 4 character String.
CicsCorrelator
          The CicsCorrelator is included for requests with a FlowType of EciSynconreturn on the z/OS platform if the protocol is EXCI.
CicsReturnCode
          CICS return code on a response is an Integer.
CicsServer
          The CICS server the Gateway daemon attempted to send the work to.
ClientCtgApplid
          CICS TG Applid of the Java client classes calling these Gateway daemon classes.
ClientCtgApplidQualifier
          CICS TG Applid High-level Qualifier of the Java client classes calling these Gateway daemon classes.
ClientCtgCorrelator
          CICS TG Correlator of the Java client classes calling these Gateway daemon classes.
ClientLocation
          Location of client Gateway classes.
CommandData
          Command data originating from a request monitor exit administration request is a String.
CtgApplid
          CICS TG Applid is a 1 to 8 character String.
CtgApplidQualifier
          CICS TG Applid High-level Qualifier is a 1 to 8 character String.
CtgCorrelator
          CICS TG Correlator is an Integer used to uniquely identify this flow within the given CICS TG instance.
CtgReturnCode
          CICS TG return code on a response is an Integer.
DistributedIdentity
          The DistributedIdentity associated with this transaction.
EwlmToken
          Deprecated. WebSphere's eWLM token for this transaction. This is an array of bytes.
FlowTopology
          Topology of request flow (gateway, remote or local).
FlowType
          An enum of the FlowType of this request / response.
GatewayUrl
          URL of the Gateway daemon the client is connecting to is a String.
Location
          Location of this monitor.
LuwToken
          CICS TG Logical Unit of Work Token is an Integer.
OriginData
          IPIC's origin data.
PayLoad
          Payload - temporary access to commarea.
Program
          Program name is a 1 to 8 character String.
RequestReceived
          Timestamp of request flow received in the Java client or Gateway daemon classes - number of milliseconds since January 1, 1970, 00:00:00 GMT.
RequestSent
          Timestamp of request flow sent from the Java client or Gateway daemon classes - number of milliseconds since January 1, 1970, 00:00:00 GMT.
ResponseReceived
          Timestamp of response flow received in the Java client or Gateway daemon classes - number of milliseconds since January 1, 1970, 00:00:00 GMT.
ResponseSent
          Timestamp of response flow sent from the Java client or Gateway daemon classes - number of milliseconds since January 1, 1970, 00:00:00 GMT.
RetryCount
          If a request was retried because of one or more retryable errors when using a CICSRequestExit then this field will show how many times the request was retried by the Gateway daemon.
Server
          The CICS server that the request specified the work should be sent to.
TpnName
          TPN Name is a 1 to 4 character String.
TranName
          Transaction ID is a 1 to 4 character String.
Urid
          The RRMS URID for this XA transaction.
Userid
          UserID is a 1 to 16 character String.
WireSize
          The number of bytes of data received from or about to be sent to the Java client.
WorkerWaitTime
          The time in milliseconds that the Gateway daemon had to wait for a Worker to accept this flow.
XaReturnCode
          XA return code on a response is an Integer.
Xid
          An Xid for this XA transaction.
 
Method Summary
 java.lang.String getDataType()
           
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're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

CtgApplid

public static final RequestData CtgApplid
CICS TG Applid is a 1 to 8 character String.


CtgApplidQualifier

public static final RequestData CtgApplidQualifier
CICS TG Applid High-level Qualifier is a 1 to 8 character String.


CtgCorrelator

public static final RequestData CtgCorrelator
CICS TG Correlator is an Integer used to uniquely identify this flow within the given CICS TG instance.


RequestReceived

public static final RequestData RequestReceived
Timestamp of request flow received in the Java client or Gateway daemon classes - number of milliseconds since January 1, 1970, 00:00:00 GMT. This is a Long.


RequestSent

public static final RequestData RequestSent
Timestamp of request flow sent from the Java client or Gateway daemon classes - number of milliseconds since January 1, 1970, 00:00:00 GMT. This is a Long.


ResponseReceived

public static final RequestData ResponseReceived
Timestamp of response flow received in the Java client or Gateway daemon classes - number of milliseconds since January 1, 1970, 00:00:00 GMT. This is a Long.


ResponseSent

public static final RequestData ResponseSent
Timestamp of response flow sent from the Java client or Gateway daemon classes - number of milliseconds since January 1, 1970, 00:00:00 GMT. This is a Long.


WorkerWaitTime

public static final RequestData WorkerWaitTime
The time in milliseconds that the Gateway daemon had to wait for a Worker to accept this flow. This is an Integer.


ClientCtgApplid

public static final RequestData ClientCtgApplid
CICS TG Applid of the Java client classes calling these Gateway daemon classes. It is a 1 to 8 character String.


ClientCtgApplidQualifier

public static final RequestData ClientCtgApplidQualifier
CICS TG Applid High-level Qualifier of the Java client classes calling these Gateway daemon classes. It is a 1 to 8 character String.


ClientCtgCorrelator

public static final RequestData ClientCtgCorrelator
CICS TG Correlator of the Java client classes calling these Gateway daemon classes. This is an Integer.


FlowType

public static final RequestData FlowType
An enum of the FlowType of this request / response.


Program

public static final RequestData Program
Program name is a 1 to 8 character String.


TranName

public static final RequestData TranName
Transaction ID is a 1 to 4 character String.


TpnName

public static final RequestData TpnName
TPN Name is a 1 to 4 character String.


Userid

public static final RequestData Userid
UserID is a 1 to 16 character String.


Server

public static final RequestData Server
The CICS server that the request specified the work should be sent to. Server name is a String.


GatewayUrl

public static final RequestData GatewayUrl
URL of the Gateway daemon the client is connecting to is a String.


Location

public static final RequestData Location
Location of this monitor. This is an InetAddress.


ClientLocation

public static final RequestData ClientLocation
Location of client Gateway classes. This is an InetAddress.


LuwToken

public static final RequestData LuwToken
CICS TG Logical Unit of Work Token is an Integer. This is set to 0 when a request is issued to start an extended unit of work (UOW). The CICS TG generates an LUW token which is used to identify the UOW. The response to the start request contains the LUW token. All subsequent requests in the UOW, including commit and backout, contain the same LUW token.


FlowTopology

public static final RequestData FlowTopology
Topology of request flow (gateway, remote or local). This is a FlowTopology.


EwlmToken

@Deprecated
public static final RequestData EwlmToken
Deprecated. WebSphere's eWLM token for this transaction. This is an array of bytes.

OriginData

public static final RequestData OriginData
IPIC's origin data. This is an OriginData.


PayLoad

public static final RequestData PayLoad
Payload - temporary access to commarea. This is a TransientPayLoad.


WireSize

public static final RequestData WireSize
The number of bytes of data received from or about to be sent to the Java client. This is an Integer.


Xid

public static final RequestData Xid
An Xid for this XA transaction.


Urid

public static final RequestData Urid
The RRMS URID for this XA transaction. Only available for XA transactions on z/OS. This is an array of 16 bytes.


CtgReturnCode

public static final RequestData CtgReturnCode
CICS TG return code on a response is an Integer.


CicsReturnCode

public static final RequestData CicsReturnCode
CICS return code on a response is an Integer.


CicsAbendCode

public static final RequestData CicsAbendCode
CICS Abend code on a response is a 4 character String.


XaReturnCode

public static final RequestData XaReturnCode
XA return code on a response is an Integer.


CommandData

public static final RequestData CommandData
Command data originating from a request monitor exit administration request is a String.


CicsServer

public static final RequestData CicsServer
The CICS server the Gateway daemon attempted to send the work to. This will be different to Server if the Gateway daemon is using a CICSRequestExit and this changes the server to send the work to, if the Java client application specified a logical CICS server, or if the default server was used. Otherwise this will be the same as Server. CicsServer is a String.


RetryCount

public static final RequestData RetryCount
If a request was retried because of one or more retryable errors when using a CICSRequestExit then this field will show how many times the request was retried by the Gateway daemon. RetryCount is an Integer.


DistributedIdentity

public static final RequestData DistributedIdentity
The DistributedIdentity associated with this transaction. This is a DistributedIdentity


CicsCorrelator

public static final RequestData CicsCorrelator
The CicsCorrelator is included for requests with a FlowType of EciSynconreturn on the z/OS platform if the protocol is EXCI. CICS sets this value as the NETUOWID field associated with the CICS mirror task. CicsCorrelator is byte array with a maximum size of 27.

Method Detail

values

public static final RequestData[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(RequestData c : RequestData.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static RequestData valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getDataType

public java.lang.String getDataType()
Returns:
A string defining the data type of the entry.

©Copyright IBM Corp. 1994, 2014
Legal