com.ibm.ctg.monitoring

Enum RequestData

  • java.lang.Object
    • java.lang.Enum<RequestData>
      • 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. 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 Summary

      Enum Constants 
      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.
    • Method Summary

      Methods 
      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.
      • 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
        The CICS Transaction Gateway APPLID. If the 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.

      • CtgApplidQualifier

        public static final RequestData CtgApplidQualifier
        The CICS Transaction Gateway APPLID qualifier. If the 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.

      • CtgCorrelator

        public static final RequestData CtgCorrelator
        The CICS Transaction Gateway identifier used to track the request flow within the CICS Transaction Gateway instance.

        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.

      • RequestReceived

        public static final RequestData RequestReceived
        The timestamp of request flow received in the Gateway classes or Gateway daemon classes.

        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.

      • RequestSent

        public static final RequestData RequestSent
        The timestamp of request flow sent from the client application or Gateway daemon classes.

        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.

      • ResponseReceived

        public static final RequestData ResponseReceived
        The timestamp of response flow received in the Gateway classes or Gateway daemon classes.

        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.

      • ResponseSent

        public static final RequestData ResponseSent
        The timestamp of response flow sent from the Gateway classes or Gateway daemon classes.

        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.

      • WorkerWaitTime

        public static final RequestData WorkerWaitTime
        The time in milliseconds that the Gateway daemon waited for a worker thread to become available to process the request. If the Gateway daemon times out waiting for a worker thread to become free, this value contains the time in milliseconds that the Gateway daemon waited before the timeout occurred.

        This is available for all ResponseExit RequestEvents in Gateway FlowTopology.

        It is an Integer.

      • ClientCtgApplid

        public static final RequestData ClientCtgApplid
        The APPLID of the client application.

        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.

      • ClientCtgApplidQualifier

        public static final RequestData ClientCtgApplidQualifier
        The APPLID qualifier of the client application.

        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.

      • ClientCtgCorrelator

        public static final RequestData ClientCtgCorrelator
        The correlator generated by the client application.

        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.

      • FlowType

        public static final RequestData FlowType
        The flow type of this request or response.

        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.

      • Server

        public static final RequestData Server
        The server specified in the request.

        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.

      • GatewayUrl

        public static final RequestData GatewayUrl
        The URL of the Gateway that the client application is connecting to.

        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.

      • ClientLocation

        public static final RequestData ClientLocation
        The location of the Client application (IP address).

        The ClientLocation is available for all flow-related RequestEvents for Gateway FlowTopology.

        It is an InetAddress.

      • FlowTopology

        public static final RequestData FlowTopology
        The CICS Transaction Gateway topology that the request exit is deployed in.

        The FlowTopology is available for all flow-related RequestEvents in all FlowTopologies.

        It is an enum of the FlowTopology of the request flow.

      • EwlmToken

        @Deprecated
        public static final RequestData EwlmToken
        Deprecated. No longer supported and provided only for backwards compatibility.
      • OriginData

        public static final RequestData OriginData
        Data identifying the Client application that originated a CICS task and that contains the APPLID and APPLID qualifier. This is available only when using the IPIC protocol.

        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.

      • WireSize

        public static final RequestData WireSize
        The number of bytes of data received from or about to be sent to the remote client.

        The WireSize is available for all flow-related RequestEvents for Gateway FlowTopology.

        It is an Integer.

      • XaReturnCode

        public static final RequestData XaReturnCode
        The XA return code on a response.

        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.

      • CommandData

        public static final RequestData CommandData
        The command data originating from a request monitor exit administration request.

        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.

      • CicsServer

        public static final RequestData CicsServer
        The CICS server that CICS Transaction Gateway sent the request to.

        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:

        • The Gateway daemon is using a CICSRequestExit and this changes the CICS server that work is being sent to.
        • The Gateway daemon is configured with a Dynamic Server Selection (DSS) policy and this changes the CICS server that work is being sent to.
        • The remote client application specified a logical CICS server.
        • The default CICS server was used.
        Otherwise CicsServer will be the same as Server.

        It is a String.

      • CicsCorrelator

        public static final RequestData CicsCorrelator
        The CICS network unit of work ID (z/OS only).

        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.

      • XctRoot

        public static final RequestData XctRoot
        The XCT request ID.

        This identifier is passed to CICS in the origin data.

        It is a String.

      • XctParent

        public static final RequestData XctParent
        The XCT parent ID for this request.

        It is a String.

      • XctCurrent

        public static final RequestData XctCurrent
        The XCT current ID for this request.

        This is the CICS TG XCT identifier that is passed to CICS in the origin data.

        It is a String.

    • Field Detail

      • DATA_TYPE_BYTE_ARRAY

        public static final java.lang.String DATA_TYPE_BYTE_ARRAY
        It has a data type of array of bytes.
        See Also:
        Constant Field Values
      • DATA_TYPE_FLOW_TOPOLOGY

        public static final java.lang.String DATA_TYPE_FLOW_TOPOLOGY
        It has a data type of enum of the FlowTopology.
        See Also:
        Constant Field Values
      • DATA_TYPE_FLOW_TYPE

        public static final java.lang.String DATA_TYPE_FLOW_TYPE
        It has a data type of enum of the FlowType.
        See Also:
        Constant Field Values
      • DATA_TYPE_INET_ADDRESS

        public static final java.lang.String DATA_TYPE_INET_ADDRESS
        It has a data type of InetAddress.
        See Also:
        Constant Field Values
      • DATA_TYPE_INTEGER

        public static final java.lang.String DATA_TYPE_INTEGER
        It has a data type of Integer.
        See Also:
        Constant Field Values
      • DATA_TYPE_LONG

        public static final java.lang.String DATA_TYPE_LONG
        It has a data type of Long.
        See Also:
        Constant Field Values
      • DATA_TYPE_STRING

        public static final java.lang.String DATA_TYPE_STRING
        It has a data type of String.
        See Also:
        Constant Field Values
      • DATA_TYPE_XID

        public static final java.lang.String DATA_TYPE_XID
        It has a data type of Xid.
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static RequestData[] values()
        Returns an array containing the constants of this enum type, in the order they are 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 are 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
        java.lang.NullPointerException - if the argument is null
      • getDataType

        public java.lang.String getDataType()
        Returns the type of data for the request data. The strings used to represent data types are defined as static final Strings with prefix DATA_TYPE_ in this enumeration. The following code is an example of how to use the getDataType() method and is taken from the BasicMonitor sample that ships with CICS Transaction Gateway:
         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);
            }
         }
         
        Returns:
        A string defining the data type of the entry.
©Copyright IBM Corp. 1994, 2012
Legal