CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.ctg.ha
Enum RequestDetails

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

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

The RequestDetails enum contains the definitions of the data that is passed through to the CICSRequestExit getCICSServer() method. The values are the keys in the Map parameter which then have a value of the type specified by the data type.


Enum Constant Summary
DefaultServer
          The CICS server that is configured as the default in the configuration file.
LastError
          If the exit is being retried due to a retryable error then this field will contain the return code from the failed call.
LastServer
          If the exit is being retried due to a retryable error then this field will contain the last server the request was sent to.
PayloadType
          For ECI requests, the type of payload specified on the request.
Program
          For ECI requests, the CICS program specified on the request.
RequestType
          The type of request that is being changed by this exit.
RetryCount
          The number of times the exit has been called after a request has failed with a retryable error.
Server
          The CICS server originally specified on the request.
SystemName
          The name of the system where this Gateway daemon is running.
Transid
          For ECI requests, the transaction ID specified on the request.
Userid
          The user ID specified on the request.
 
Method Summary
 java.lang.String getDataType()
           
static RequestDetails valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static RequestDetails[] 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

Server

public static final RequestDetails Server
The CICS server originally specified on the request.


DefaultServer

public static final RequestDetails DefaultServer
The CICS server that is configured as the default in the configuration file.


Userid

public static final RequestDetails Userid
The user ID specified on the request.


Transid

public static final RequestDetails Transid
For ECI requests, the transaction ID specified on the request.


Program

public static final RequestDetails Program
For ECI requests, the CICS program specified on the request.


SystemName

public static final RequestDetails SystemName
The name of the system where this Gateway daemon is running.


RetryCount

public static final RequestDetails RetryCount
The number of times the exit has been called after a request has failed with a retryable error.


LastError

public static final RequestDetails LastError
If the exit is being retried due to a retryable error then this field will contain the return code from the failed call.


LastServer

public static final RequestDetails LastServer
If the exit is being retried due to a retryable error then this field will contain the last server the request was sent to.


RequestType

public static final RequestDetails RequestType
The type of request that is being changed by this exit.

See Also:
RequestCallType

PayloadType

public static final RequestDetails PayloadType
For ECI requests, the type of payload specified on the request.

See Also:
RequestPayloadType
Method Detail

values

public static final RequestDetails[] 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(RequestDetails c : RequestDetails.values())
        System.out.println(c);

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

valueOf

public static RequestDetails 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()

©Copyright IBM Corp. 1994, 2014
Legal