DataRequester (z/OS Connect SPI)

```
public interface DataRequester
```
Defines the request specific API requester data available to interceptors. The documentation describes which data values are available to which interceptor methods. Some data values may also be available in other interceptor methods, depending on where a request fails. Data is available for OpenAPI 3 requests from V3.0.76.0.
The EarlyFailureInterceptorRequester Interface is supported only for OpenAPI 2, not for OpenAPI 3.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class DataRequester.RequestApplicationType
Enumeration for the application type of the originating request.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DataRequester.RequestApplicationType` Enumeration for the application type of the originating request.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`API_REQUESTER_DESCRIPTION` Constant for the key used in `getData(String)` for the description of the API requester associated with this request.
`static java.lang.String`	`API_REQUESTER_NAME` Constant for the key used in `getData(String)` for the name of the API requester associated with this request.
`static java.lang.String`	`API_REQUESTER_VERSION` Constant for the key used in `getData(String)` for the version of the API requester associated with this request.
`static java.lang.String`	`AUTHORIZATION_ADMIN_GROUP_NAMES` Constant for the key used in `getData(String)` for the configured administrator groups names to be used for authorization validation.
`static java.lang.String`	`AUTHORIZATION_INVOKE_GROUP_NAMES` Constant for the key used in `getData(String)` for the configured invoke group names to be used for authorization validation.
`static java.lang.String`	`AUTHORIZATION_OPERATIONS_GROUP_NAMES` Constant for the key used in `getData(String)` for the configured operations group names to be used for authorization validation.
`static java.lang.String`	`AUTHORIZATION_READER_GROUP_NAMES` Constant for the key used in `getData(String)` for the configured reader group names to be used for authorization validation.
`static java.lang.String`	`CICS_APPLID` Constant for the key used in `getData(String)` for the CICS APPLID of the region invoking this request.
`static java.lang.String`	`CICS_NETUOWID` Constant for the key used in `getData(String)` for the CICS network unit of work (UOW) ID of the task invoking this request.
`static java.lang.String`	`CICS_TASK_NUMBER` Constant for the key used in `getData(String)` for the CICS task number invoking this request.
`static java.lang.String`	`CICS_TRANSID` Constant for the key used in `getData(String)` for the CICS transid invoking this request.
`static java.lang.String`	`CICS_UOWID` Constant for the key used in `getData(String)` for the CICS unit of work (UOW) ID of the task invoking this request.
`static java.lang.String`	`copyright_notice`
`static java.lang.String`	`ENDPOINT_FULL_PATH` Constant for the key used in `getData(String)` for a string containing the full path of the resource invoked at the endpoint.
`static java.lang.String`	`ENDPOINT_HOST` Constant for the key used in `getData(String)` for a string containing the host value of the API endpoint.
`static java.lang.String`	`ENDPOINT_METHOD` Constant for the key used in `getData(String)` for the endpoint request method.
`static java.lang.String`	`ENDPOINT_PORT` Constant for the key used in `getData(String)` for a string containing the port value of the API endpoint.
`static java.lang.String`	`ENDPOINT_QUERY_STRING` Constant for the key used in `getData(String)` for a string containing information identifying the endpoint request query string.
`static java.lang.String`	`ENDPOINT_REFERENCE` Constant for the key used in `getData(String)` for the configured connection reference that identifies the connection to the API endpoint.
`static java.lang.String`	`HTTP_RESPONSE_CODE` Constant for the key used in `getData(String)` for the HTTP status code for the response from the API endpoint.
`static java.lang.String`	`IMS_APPNAME` Constant for the key used in `getData(String)` for the name of the IMS application program invoking this request.
`static java.lang.String`	`IMS_EXIT_DATA` Constant for the key used in `getData(String)` when the IMS INQY exit of the program invoking this request has populated the Exit Data with character data.
`static java.lang.String`	`IMS_EXIT_DATA_BYTES` Constant for the key used in `getData(String)` when the IMS INQY exit of the program invoking this request has populated the Exit Data with binary data.
`static java.lang.String`	`IMS_IDENTIFIER` Constant for the key used in `getData(String)` for the IMS identifier invoking this request.
`static java.lang.String`	`IMS_PSBNAME` Constant for the key used in `getData(String)` for the name of the IMS PSB currently allocated to the program invoking this request.
`static java.lang.String`	`IMS_RECOVERY_TOKEN` Deprecated.
`static java.lang.String`	`IMS_RECOVERY_TOKEN_BYTES` Constant for the key used in `getData(String)` for the IMS recovery token of the program invoking this request.
`static java.lang.String`	`IMS_REGION_ID` Constant for the key used in `getData(String)` for the IMS region identifier invoking this request.
`static java.lang.String`	`IMS_TRANSNAME` Constant for the key used in `getData(String)` for the name of the IMS transaction invoking this request.
`static java.lang.String`	`MVS_ASID` Constant for the key used in `getData(String)` for the address space identifier (ASID) of the MVS system invoking this request.
`static java.lang.String`	`MVS_JOBID` Constant for the key used in `getData(String)` for the ID of the MVS job invoking this request, taken from the IAZJSAB JOBID parameter.
`static java.lang.String`	`MVS_JOBNAME` Constant for the key used in `getData(String)` for the name of the MVS job invoking this request, taken from the IAZJSAB JOBNAME parameter.
`static java.lang.String`	`MVS_SID` Constant for the key used in `getData(String)` for the system identifier (SID) that is used in all SMF records of the MVS system invoking this request.
`static java.lang.String`	`MVS_SYSNAME` Constant for the key used in `getData(String)` for the name of the MVS system invoking this request, taken from the CVT CVTSNAME field.
`static java.lang.String`	`REQUEST_APPLICATION_TYPE` Constant for the key used in `getData(String)` for the request application type.
`static java.lang.String`	`REQUEST_ID` Constant for the key used in `getData(String)` for the unique identifier associated with this request.
`static java.lang.String`	`REQUEST_RETRY` Constant for the key used in `getData(String)` for an indicator that this request is the retry of a request that used one or more cached access tokens, following a 401 authentication failure response from the API endpoint.
`static java.lang.String`	`REQUEST_STATUS_CODE` Constant for the key used in `getData(String)` for the status code returned to the client application in the BAQ-STATUS-CODE field of the BAQ-RESPONSE-INFO structure for COBOL programs or the BAQ_STATUS_CODE field of the BAQ_RESPONSE_INFO for PL/I programs.
`static java.lang.String`	`TIME_ENDPOINT_RECEIVED` Constant for the key used in `getData(String)` for the timestamp of when this response was received from the API endpoint by the z/OS Connect EE server.
`static java.lang.String`	`TIME_ENDPOINT_SENT` Constant for the key used in `getData(String)` for the timestamp of when this request was sent to the API endpoint by the z/OS Connect EE server.
`static java.lang.String`	`TIME_STUB_SENT` Constant for the key used in `getData(String)` for the timestamp of when the communications stub sent this request.
`static java.lang.String`	`TIME_TOKEN_GET_FINISH` Constant for the key used in `getData(String)` for the timestamp for when the z/OS Connect EE server has completed acquiring the access token(s) for this request.
`static java.lang.String`	`TIME_TOKEN_GET_START` Constant for the key used in `getData(String)` for the timestamp for when the z/OS Connect EE server starts to acquire the access token(s) for this request.
`static java.lang.String`	`TIME_ZOS_CONNECT_ENTRY` Constant for the key used in `getData(String)` for the timestamp of when this request was received by the z/OS Connect EE server from the API requester communications stub.
`static java.lang.String`	`TIME_ZOS_CONNECT_EXIT` Constant for the key used in `getData(String)` for the timestamp of when this response was sent to the API requester communications stub by the z/OS Connect EE server.
`static java.lang.String`	`TRACKING_TOKEN` Constant for the key used in `getData(String)` for a byte array containing a tracking token.
`static java.lang.String`	`USER_NAME` Constant for the key used in `getData(String)` for the user identity associated with this request.
`static java.lang.String`	`USER_NAME_ASSERTED` Constant for the key used in `getData(String)` for the SAF asserted user ID associated with this request, if there is one.
`static java.lang.String`	`USER_NAME_MAPPED` Constant for the key used in `getData(String)` for the SAF mapped user ID associated with this request, if there is one.
`static java.lang.String`	`ZOS_CONNECT_FEATURE_VERSION` Constant for the key used in `getData(String)` indicating the z/OS Connect feature version this server is running.
`static java.lang.String`	`ZOS_CONNECT_FEATURE_VERSION_2_0` Constant String value 2.0 indicating z/OS Connect feature zosconnect-2.0 is in use.
`static java.lang.String`	`ZOS_CONNECT_FEATURE_VERSION_3_0` Constant String value 3.0 indicating z/OS Connect feature zosconnect-3.0 is in use.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getData(java.lang.String key)` Returns the specified data.
`java.lang.String`	`getInputPayload()` Returns a String representation of the input payload sent to the endpoint.
`boolean`	`getInterceptorPreInvokeFailed()` Returns a boolean value indicating that an exception was thrown by an interceptor.
`java.lang.String`	`getOutputPayload()` Returns a String representation of the output payload returned by the endpoint.
`java.lang.String`	`getRequestHeader(java.lang.String key)` Returns the value of the specified request header as a String.
`java.util.Enumeration<java.lang.String>`	`getRequestHeaderNames()` Returns an Enumeration of the names of all the request headers for this request.
`java.lang.String`	`getResponseHeader(java.lang.String key)` Returns the value of the specified response header as a String.
`java.util.Enumeration<java.lang.String>`	`getResponseHeaderNames()` Returns an Enumeration of the names of all the response headers for this request.

- Field Detail
  - copyright_notice
```
static final java.lang.String copyright_notice
```
    See Also:
    
    Constant Field Values
  - REQUEST_APPLICATION_TYPE
```
static final java.lang.String REQUEST_APPLICATION_TYPE
```
    Constant for the key used in getData(String) for the request application type. The value returned by getData(String) is of type DataRequester.RequestApplicationType
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces.
    
    See Also:
    
    Constant Field Values
  - REQUEST_ID
```
static final java.lang.String REQUEST_ID
```
    Constant for the key used in getData(String) for the unique identifier associated with this request. The value returned by getData(String) is a Long and is unique within the current server instance.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces.
    
    See Also:
    
    Constant Field Values
  - API_REQUESTER_NAME
```
static final java.lang.String API_REQUESTER_NAME
```
    Constant for the key used in getData(String) for the name of the API requester associated with this request. For an OpenAPI 2 API requester, it is the name of the API requester archive file. For an OpenAPI 3 API requester, it is the value of the name attribute on the webApplication element.The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces.
    
    See Also:
    
    Constant Field Values
  - API_REQUESTER_DESCRIPTION
```
static final java.lang.String API_REQUESTER_DESCRIPTION
```
    Constant for the key used in getData(String) for the description of the API requester associated with this request. The value returned by getData(String) is a String.
    This data is available in:
    See Also:
    
    Constant Field Values
  - API_REQUESTER_VERSION
```
static final java.lang.String API_REQUESTER_VERSION
```
    Constant for the key used in getData(String) for the version of the API requester associated with this request. The value returned by getData(String) is a String.
    This data is available in:
    See Also:
    
    Constant Field Values
  - AUTHORIZATION_ADMIN_GROUP_NAMES
```
static final java.lang.String AUTHORIZATION_ADMIN_GROUP_NAMES
```
    Constant for the key used in getData(String) for the configured administrator groups names to be used for authorization validation. The value returned by getData(String) is an array of String objects, null if not configured.
    This data is available in:
    See Also:
    
    Constant Field Values
  - AUTHORIZATION_OPERATIONS_GROUP_NAMES
```
static final java.lang.String AUTHORIZATION_OPERATIONS_GROUP_NAMES
```
    Constant for the key used in getData(String) for the configured operations group names to be used for authorization validation. The value returned by getData(String) is an array of String objects, null if not configured.
    This data is available in:
    See Also:
    
    Constant Field Values
  - AUTHORIZATION_INVOKE_GROUP_NAMES
```
static final java.lang.String AUTHORIZATION_INVOKE_GROUP_NAMES
```
    Constant for the key used in getData(String) for the configured invoke group names to be used for authorization validation. The value returned by getData(String) is an array of String objects, null if not configured.
    This data is available in:
    See Also:
    
    Constant Field Values
  - AUTHORIZATION_READER_GROUP_NAMES
```
static final java.lang.String AUTHORIZATION_READER_GROUP_NAMES
```
    Constant for the key used in getData(String) for the configured reader group names to be used for authorization validation. The value returned by getData(String) is an array of String objects, null if not configured.
    This data is available in:
    See Also:
    
    Constant Field Values
  - HTTP_RESPONSE_CODE
```
static final java.lang.String HTTP_RESPONSE_CODE
```
    Constant for the key used in getData(String) for the HTTP status code for the response from the API endpoint. The value returned by getData(String) is an Integer. If not set, a value of zero is returned.
    This data is available in:
    - InterceptorRequester.postInvokeRequester(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.DataRequester)
    - EndpointInterceptor.postEndpointInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.DataRequester)
    See Also:
    
    Constant Field Values
  - REQUEST_STATUS_CODE
```
static final java.lang.String REQUEST_STATUS_CODE
```
    Constant for the key used in getData(String) for the status code returned to the client application in the BAQ-STATUS-CODE field of the BAQ-RESPONSE-INFO structure for COBOL programs or the BAQ_STATUS_CODE field of the BAQ_RESPONSE_INFO for PL/I programs. The value returned by getData(String) is an Integer.
    This data is available in:
    - InterceptorRequester.postInvokeRequester(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.DataRequester)
    - For OpenAPI 2 only: EarlyFailureInterceptorRequester.earlyFailureRequester(com.ibm.zosconnect.spi.DataRequester)
    See Also:
    
    Constant Field Values
  - TIME_ZOS_CONNECT_ENTRY
```
static final java.lang.String TIME_ZOS_CONNECT_ENTRY
```
    Constant for the key used in getData(String) for the timestamp of when this request was received by the z/OS Connect EE server from the API requester communications stub. The value returned by getData(String) is an extended store clock in the form of a byte array. Refer to SA22-7832 z/Architecture Principles of Operations for more information.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces.
    
    See Also:
    
    Constant Field Values
  - TIME_ENDPOINT_SENT
```
static final java.lang.String TIME_ENDPOINT_SENT
```
    Constant for the key used in getData(String) for the timestamp of when this request was sent to the API endpoint by the z/OS Connect EE server. The value returned by getData(String) is an extended store clock in the form of a byte array. Refer to SA22-7832 z/Architecture Principles of Operations for more information.
    See "RequestRetry" for further information on the value of this timestamp.
    
    This data is available in:
    - InterceptorRequester.postInvokeRequester(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.DataRequester)
    - EndpointInterceptor.postEndpointInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.DataRequester)
    See Also:
    
    Constant Field Values
  - TIME_ENDPOINT_RECEIVED
```
static final java.lang.String TIME_ENDPOINT_RECEIVED
```
    Constant for the key used in getData(String) for the timestamp of when this response was received from the API endpoint by the z/OS Connect EE server. The value returned by getData(String) is an extended store clock in the form of a byte array. Refer to SA22-7832 z/Architecture Principles of Operations for more information. The value returned is null when a response has not been received from the API endpoint.
    See "RequestRetry" for further information on the value of this timestamp.
    This data is available in:
    - InterceptorRequester.postInvokeRequester(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.DataRequester)
    - EndpointInterceptor.postEndpointInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.DataRequester)
    See Also:
    
    Constant Field Values
  - TIME_ZOS_CONNECT_EXIT
```
static final java.lang.String TIME_ZOS_CONNECT_EXIT
```
    Constant for the key used in getData(String) for the timestamp of when this response was sent to the API requester communications stub by the z/OS Connect EE server. The value returned by getData(String) is an extended store clock in the form of a byte array. Refer to SA22-7832 z/Architecture Principles of Operations for more information.
    This data is available in:
    - InterceptorRequester.postInvokeRequester(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.DataRequester)
    - For OpenAPI 2 only: EarlyFailureInterceptorRequester.earlyFailureRequester(com.ibm.zosconnect.spi.DataRequester)
    See Also:
    
    Constant Field Values
  - TIME_TOKEN_GET_START
```
static final java.lang.String TIME_TOKEN_GET_START
```
    Constant for the key used in getData(String) for the timestamp for when the z/OS Connect EE server starts to acquire the access token(s) for this request. The access token(s) are retrieved either from the cache or the authorization server(s). This value is not set for the acquisition of access tokens on a request retry. The value returned by getData(String) is an extended store clock in the form of a byte array, it is null if no attempt to get a token was made. Refer to SA22-7832 z/Architecture Principles of Operations for more information.
    This data is available in:
    See Also:
    
    Constant Field Values
  - TIME_TOKEN_GET_FINISH
```
static final java.lang.String TIME_TOKEN_GET_FINISH
```
    Constant for the key used in getData(String) for the timestamp for when the z/OS Connect EE server has completed acquiring the access token(s) for this request. The access token(s) are retrieved either from the cache or the authorization server(s). This value is not set for the acquisition of access tokens on a request retry. The value returned by getData(String) is an extended store clock in the form of a byte array, it is null if no attempt to get a token was made. Refer to SA22-7832 z/Architecture Principles of Operations for more information.
    This data is available in:
    See Also:
    
    Constant Field Values
  - ENDPOINT_REFERENCE
```
static final java.lang.String ENDPOINT_REFERENCE
```
    Constant for the key used in getData(String) for the configured connection reference that identifies the connection to the API endpoint. It is the value of the id attribute of the zosconnect_endpointConnection element.
    This data is available in:
    See Also:
    
    Constant Field Values
  - ENDPOINT_HOST
```
static final java.lang.String ENDPOINT_HOST
```
    Constant for the key used in getData(String) for a string containing the host value of the API endpoint. The value returned by getData(String) is a String, it is null if the request fails before it is sent to the endpoint.
    This data is available in:
    See Also:
    
    Constant Field Values
  - ENDPOINT_PORT
```
static final java.lang.String ENDPOINT_PORT
```
    Constant for the key used in getData(String) for a string containing the port value of the API endpoint. The value returned by getData(String) is a Integer, it is null if the request fails before it is sent to the endpoint.
    This data is available in:
    See Also:
    
    Constant Field Values
  - ENDPOINT_FULL_PATH
```
static final java.lang.String ENDPOINT_FULL_PATH
```
    Constant for the key used in getData(String) for a string containing the full path of the resource invoked at the endpoint. The value returned by getData(String) is a String of the format /{domainBasePath}/{basePath}/{path}, null if the request fails before it is sent to the endpoint. This data is available in:
    See Also:
    
    Constant Field Values
  - ENDPOINT_METHOD
```
static final java.lang.String ENDPOINT_METHOD
```
    Constant for the key used in getData(String) for the endpoint request method. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces.
    
    See Also:
    
    Constant Field Values
  - ENDPOINT_QUERY_STRING
```
static final java.lang.String ENDPOINT_QUERY_STRING
```
    Constant for the key used in getData(String) for a string containing information identifying the endpoint request query string. The value returned by getData(String) is a String, null if the request fails before it is sent to the endpoint. This data is available in:
    See Also:
    
    Constant Field Values
  - REQUEST_RETRY
```
static final java.lang.String REQUEST_RETRY
```
    Constant for the key used in getData(String) for an indicator that this request is the retry of a request that used one or more cached access tokens, following a 401 authentication failure response from the API endpoint. A failed request is only retried once. The value returned by getData(String) is a Boolean and set to true if this request is a retry. If the value is true then "TimeEndpointSent" is the time the original request was sent to the endpoint and "TimeEndpointReceived" is the time the response is received from the request retry. This data is available in:
    See Also:
    
    Constant Field Values
  - TRACKING_TOKEN
```
static final java.lang.String TRACKING_TOKEN
```
    Constant for the key used in getData(String) for a byte array containing a tracking token.
    The value returned by getData(String) is in the form of a byte array that is a maximum of 64 bytes in length.
    This data is available in:
    - Interceptor.postInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    See Also:
    
    Constant Field Values
  - USER_NAME
```
static final java.lang.String USER_NAME
```
    Constant for the key used in getData(String) for the user identity associated with this request. The value returned by getData(String) is a String, containing one of the following:
    - The authenticated username.
    - From V3.0.58.0:
      
      For a request that fails basic authentication with the z/OS Connect server, with a 401 response code due to invalid credentials, the username from the credentials in the Authorization header.
      The unauthenticated username.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces.
    See Also:
    
    Constant Field Values
  - USER_NAME_ASSERTED
```
static final java.lang.String USER_NAME_ASSERTED
```
    Constant for the key used in getData(String) for the SAF asserted user ID associated with this request, if there is one. The value returned by getData(String) is a String.
    This data is available only for OpenAPI 2 in all methods of the InterceptorRequester interface and its subinterfaces.
    
    See Also:
    
    Constant Field Values
  - USER_NAME_MAPPED
```
static final java.lang.String USER_NAME_MAPPED
```
    Constant for the key used in getData(String) for the SAF mapped user ID associated with this request, if there is one. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces.
    
    See Also:
    
    Constant Field Values
  - TIME_STUB_SENT
```
static final java.lang.String TIME_STUB_SENT
```
    Constant for the key used in getData(String) for the timestamp of when the communications stub sent this request. The value returned by getData(String) is an extended store clock in the form of a byte array. Refer to SA22-7832 z/Architecture Principles of Operations for more information.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - MVS_JOBNAME
```
static final java.lang.String MVS_JOBNAME
```
    Constant for the key used in getData(String) for the name of the MVS job invoking this request, taken from the IAZJSAB JOBNAME parameter. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - MVS_JOBID
```
static final java.lang.String MVS_JOBID
```
    Constant for the key used in getData(String) for the ID of the MVS job invoking this request, taken from the IAZJSAB JOBID parameter. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - MVS_SYSNAME
```
static final java.lang.String MVS_SYSNAME
```
    Constant for the key used in getData(String) for the name of the MVS system invoking this request, taken from the CVT CVTSNAME field. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - MVS_ASID
```
static final java.lang.String MVS_ASID
```
    Constant for the key used in getData(String) for the address space identifier (ASID) of the MVS system invoking this request. The value returned by getData(String) is an Integer.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - MVS_SID
```
static final java.lang.String MVS_SID
```
    Constant for the key used in getData(String) for the system identifier (SID) that is used in all SMF records of the MVS system invoking this request. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - CICS_APPLID
```
static final java.lang.String CICS_APPLID
```
    Constant for the key used in getData(String) for the CICS APPLID of the region invoking this request. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - CICS_TASK_NUMBER
```
static final java.lang.String CICS_TASK_NUMBER
```
    Constant for the key used in getData(String) for the CICS task number invoking this request. The value returned by getData(String) is a Integer.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - CICS_TRANSID
```
static final java.lang.String CICS_TRANSID
```
    Constant for the key used in getData(String) for the CICS transid invoking this request. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - CICS_UOWID
```
static final java.lang.String CICS_UOWID
```
    Constant for the key used in getData(String) for the CICS unit of work (UOW) ID of the task invoking this request. The value returned by getData(String) is a byte array.
    This value is only available if the calling application is running in a CICS region with the z/OS Connect EE TRUE enabled. It is then available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - CICS_NETUOWID
```
static final java.lang.String CICS_NETUOWID
```
    Constant for the key used in getData(String) for the CICS network unit of work (UOW) ID of the task invoking this request. The value returned by getData(String) is a byte array.
    This value is only available if the calling application is running in a CICS region with the z/OS Connect EE TRUE enabled. It is then available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - IMS_IDENTIFIER
```
static final java.lang.String IMS_IDENTIFIER
```
    Constant for the key used in getData(String) for the IMS identifier invoking this request. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - IMS_REGION_ID
```
static final java.lang.String IMS_REGION_ID
```
    Constant for the key used in getData(String) for the IMS region identifier invoking this request. The value returned by getData(String) is a Integer.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - IMS_TRANSNAME
```
static final java.lang.String IMS_TRANSNAME
```
    Constant for the key used in getData(String) for the name of the IMS transaction invoking this request. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - IMS_APPNAME
```
static final java.lang.String IMS_APPNAME
```
    Constant for the key used in getData(String) for the name of the IMS application program invoking this request. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - IMS_PSBNAME
```
static final java.lang.String IMS_PSBNAME
```
    Constant for the key used in getData(String) for the name of the IMS PSB currently allocated to the program invoking this request. The value returned by getData(String) is a String.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.45.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - IMS_RECOVERY_TOKEN
```
@Deprecated
static final java.lang.String IMS_RECOVERY_TOKEN
```
    Deprecated.
    
    Use the IMS_RECOVERY_TOKEN_BYTES constant, available from V3.0.45.0, to obtain the valid IMS recovery token value.
    
    See Also:
    
    Constant Field Values
  - IMS_EXIT_DATA
```
static final java.lang.String IMS_EXIT_DATA
```
    Constant for the key used in getData(String) when the IMS INQY exit of the program invoking this request has populated the Exit Data with character data. The value returned by getData(String) is a String
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.39.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - IMS_RECOVERY_TOKEN_BYTES
```
static final java.lang.String IMS_RECOVERY_TOKEN_BYTES
```
    Constant for the key used in getData(String) for the IMS recovery token of the program invoking this request. The value returned by getData(String) is a byte array.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.45.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - IMS_EXIT_DATA_BYTES
```
static final java.lang.String IMS_EXIT_DATA_BYTES
```
    Constant for the key used in getData(String) when the IMS INQY exit of the program invoking this request has populated the Exit Data with binary data. The value returned by getData(String) is a byte array.
    This data is available in all methods of the InterceptorRequester interface and its supported subinterfaces, if the OpenAPI 2 communications stub is V3.0.45.0 or later, or the OpenAPI 3 Host API is V3.0.76.0 or later.
    
    See Also:
    
    Constant Field Values
  - ZOS_CONNECT_FEATURE_VERSION
```
static final java.lang.String ZOS_CONNECT_FEATURE_VERSION
```
    Constant for the key used in getData(String) indicating the z/OS Connect feature version this server is running. The value returned by getData(String) is a String set to ZOS_CONNECT_FEATURE_VERSION_2_0 for servers running the zosconnect-2.0 feature and ZOS_CONNECT_FEATURE_VERSION_3_0 for servers running the zosconnect-3.0 feature. This data is available from V3.0.74.0.
    
    See Also:
    
    Constant Field Values
  - ZOS_CONNECT_FEATURE_VERSION_2_0
```
static final java.lang.String ZOS_CONNECT_FEATURE_VERSION_2_0
```
    Constant String value 2.0 indicating z/OS Connect feature zosconnect-2.0 is in use.
    
    See Also:
    
    Constant Field Values
  - ZOS_CONNECT_FEATURE_VERSION_3_0
```
static final java.lang.String ZOS_CONNECT_FEATURE_VERSION_3_0
```
    Constant String value 3.0 indicating z/OS Connect feature zosconnect-3.0 is in use.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInputPayload
```
java.lang.String getInputPayload()
```
    Returns a String representation of the input payload sent to the endpoint.
    
    Returns:
    
    The String representation of the request payload, null if there is no payload.
  - getOutputPayload
```
java.lang.String getOutputPayload()
```
    Returns a String representation of the output payload returned by the endpoint.
    
    Returns:
    
    The String representation of the response payload, null if there is no payload.
  - getRequestHeader
```
java.lang.String getRequestHeader(java.lang.String key)
```
    Returns the value of the specified request header as a String. If the request did not include a header of the specified name, this method returns null.
    
    Parameters:
    
    key - A String specifying the request header name.
    
    Returns:
    
    A String containing the value of the specified request header.
  - getRequestHeaderNames
```
java.util.Enumeration<java.lang.String> getRequestHeaderNames()
```
    Returns an Enumeration of the names of all the request headers for this request. If there are no request headers, this method returns an empty Enumeration.
    
    Returns:
    
    An Enumeration with the names of all the request headers.
  - getResponseHeader
```
java.lang.String getResponseHeader(java.lang.String key)
```
    Returns the value of the specified response header as a String. If the response did not include a header of the specified name, this method returns null.
    
    Parameters:
    
    key - A String specifying the response header name.
    
    Returns:
    
    A String containing the value of the specified response header.
  - getResponseHeaderNames
```
java.util.Enumeration<java.lang.String> getResponseHeaderNames()
```
    Returns an Enumeration of the names of all the response headers for this request. If there are no response headers, this method returns an empty Enumeration.
    
    Returns:
    
    An Enumeration with the names of all the response headers.
  - getData
```
java.lang.Object getData(java.lang.String key)
```
    Returns the specified data. See the constants on the DataRequester interface for the valid keys.
    
    Parameters:
    
    key - The key for the value that is to be returned.
    
    Returns:
    
    The value for the specified key or null if there is no associated data for the specified key.
  - getInterceptorPreInvokeFailed
```
boolean getInterceptorPreInvokeFailed()
```
    Returns a boolean value indicating that an exception was thrown by an interceptor. The request has failed and immediately exits after postInvoke is driven on the interceptor that reported the error and those interceptors that successfully completed processing preInvoke.
    
    Returns:
    
    True if an exception was thrown by an interceptor during preInvoke.

copyright_notice

REQUEST_APPLICATION_TYPE

REQUEST_ID

API_REQUESTER_NAME

API_REQUESTER_DESCRIPTION

API_REQUESTER_VERSION

AUTHORIZATION_ADMIN_GROUP_NAMES

AUTHORIZATION_OPERATIONS_GROUP_NAMES

AUTHORIZATION_INVOKE_GROUP_NAMES

AUTHORIZATION_READER_GROUP_NAMES

HTTP_RESPONSE_CODE

REQUEST_STATUS_CODE

TIME_ZOS_CONNECT_ENTRY

TIME_ENDPOINT_SENT

TIME_ENDPOINT_RECEIVED

TIME_ZOS_CONNECT_EXIT

TIME_TOKEN_GET_START

TIME_TOKEN_GET_FINISH

ENDPOINT_REFERENCE

ENDPOINT_HOST

ENDPOINT_PORT

ENDPOINT_FULL_PATH

ENDPOINT_METHOD

ENDPOINT_QUERY_STRING

REQUEST_RETRY

TRACKING_TOKEN

USER_NAME

USER_NAME_ASSERTED

USER_NAME_MAPPED

TIME_STUB_SENT

MVS_JOBNAME

MVS_JOBID

MVS_SYSNAME

MVS_ASID

MVS_SID

CICS_APPLID

CICS_TASK_NUMBER

CICS_TRANSID

CICS_UOWID

CICS_NETUOWID

IMS_IDENTIFIER

IMS_REGION_ID

IMS_TRANSNAME

IMS_APPNAME

IMS_PSBNAME

IMS_RECOVERY_TOKEN

IMS_EXIT_DATA

IMS_RECOVERY_TOKEN_BYTES

IMS_EXIT_DATA_BYTES

ZOS_CONNECT_FEATURE_VERSION

ZOS_CONNECT_FEATURE_VERSION_2_0

ZOS_CONNECT_FEATURE_VERSION_3_0

getInputPayload

getOutputPayload

getRequestHeader

getRequestHeaderNames

getResponseHeader

getResponseHeaderNames

getData

getInterceptorPreInvokeFailed