CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.ctg.ha
Enum RequestPayloadType

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

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

An enumeration of the ECI payload types. Payload types represent the method used to transfer data between CICS TG and CICS programs. This enumeration is used by CICS request exit applications. The payload type allows a request exit to select a CICS server based on the payload of an ECI request. For example, in a configuration where only a subset of the available CICS servers are configured to process channels and containers, a request exit might use the payload information to redirect requests to a server that has the capability to process the request. The default payload type is COMMAREA.

See Also:
RequestDetails, CICSRequestExit

Enum Constant Summary
CHANNEL
          The payload type is channels and containers.
COMMAREA
          The payload type is COMMAREA.
 
Method Summary
static RequestPayloadType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static RequestPayloadType[] 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

CHANNEL

public static final RequestPayloadType CHANNEL
The payload type is channels and containers.


COMMAREA

public static final RequestPayloadType COMMAREA
The payload type is COMMAREA.

Method Detail

values

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

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

valueOf

public static RequestPayloadType 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

©Copyright IBM Corp. 1994, 2014
Legal