Data (z/OS Connect SPI)

All Known Subinterfaces:

RequestData, ResponseData
```
public interface Data
```
Defines the request specific API provider data available to interceptors and service providers. The documentation describes the data values and sspecifies which interceptor methods they are available in. Some data values may also be available in other interceptor methods, depending on where a request fails or the specific service provider implementation.
This interface is implemented by z/OS Connect. Data is available for OpenAPI 3 requests from V3.0.74.0.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Data.RequestType
Enumeration for the type of the REST request.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Data.RequestType` Enumeration for the type of the REST request.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`API_DESCRIPTION` Constant for the key used in `getData(String)` for the description of the API associated with this request.
`static java.lang.String`	`API_NAME` Constant for the key used in `getData(String)` for the name of the API associated with this request.
`static java.lang.String`	`API_OPERATION` Constant for the key used in `getData(String)` for the operation in the API associated with this request.
`static java.lang.String`	`API_REQUESTER_DESCRIPTION` Constant for the key used in `getData(String)` for the description of any API requester associated with this OpenAPI 2 server administration request.
`static java.lang.String`	`API_REQUESTER_NAME` Constant for the key used in `getData(String)` for the name of any API requester associated with this OpenAPI 2 server administration request.
`static java.lang.String`	`API_REQUESTER_VERSION` Constant for the key used in `getData(String)` for the version of any API requester associated with this OpenAPI 2 server administration request.
`static java.lang.String`	`API_VERSION` Constant for the key used in `getData(String)` for the version of the API 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 in OpenAPI 2 servers.
`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 in OpenAPI 2 servers.
`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 in OpenAPI 2 servers.
`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 in OpenAPI 2 servers.
`static java.lang.String`	`copyright_notice`
`static java.lang.String`	`CORRELATOR` Constant for the key used in `getData(String)` for a byte array containing a system wide unique correlator.
`static java.lang.String`	`HTTP_RESPONSE_CODE` Constant for the key used in `getData(String)` for the HTTP status code for the response.
`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_TIMED_OUT` Constant for the key used in `getData(String)` for a flag indicating whether this request has been timed out.
`static java.lang.String`	`SERVICE_DESCRIPTION` Constant for the key used in `getData(String)` for the description of the OpenAPI 2 service, or OpenAPI 3 z/OS asset, associated with this request.
`static java.lang.String`	`SERVICE_NAME` Constant for the key used in `getData(String)` for the name of the OpenAPI 2 service, or OpenAPI 3 z/OS asset, associated with this request.
`static java.lang.String`	`SERVICE_PROVIDER_NAME` Constant for the key used in `getData(String)` for the name of the OpenAPI 2 service provider, or Open API 3 type of z/OS asset, which is processing this request.
`static java.lang.String`	`SERVICE_VERSION` Constant for the key used in `getData(String)` for the version of the OpenAPI 2 service, or OpenAPI 3 z/OS asset, associated with this request.
`static java.lang.String`	`SOR_IDENTIFIER` Constant for the key used in `getData(String)` for a string identifying the system of record.
`static java.lang.String`	`SOR_REFERENCE` Constant for the key used in `getData(String)` for the configured connection reference that identifies the connection to the system of record.The value returned by `getData(String)` is a `String`, null when the request type is `Data.RequestType.ADMIN`, or if the request fails before the service provider or z/OS asset determines the reference, or if the service provider does not support setting this value.
`static java.lang.String`	`SOR_RESOURCE` Constant for the key used in `getData(String)` for a string containing information identifying the resource invoked on the system of record.
`static java.lang.String`	`TIME_SOR_RECEIVED` Constant for the key used in `getData(String)` for the timestamp of when this response was received from the system of record by the z/OS Connect server.
`static java.lang.String`	`TIME_SOR_SENT` Constant for the key used in `getData(String)` for the timestamp of when this request was sent to the system of record by the z/OS Connect server.
`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 server from the HTTP client.
`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 HTTP client by the z/OS Connect server.
`static java.lang.String`	`TRACKING_TOKEN` Constant for the key used in `getData(String)` for a byte array containing the tracking token that is passed to the system of record by some service providers and can be used to track this request, @see Tracking requests for information on the format of the tracking token.
`static java.lang.String`	`USER_NAME` For OpenAPI 2, available from V3.0.58.0 and for OpenAPI 3 available from V3.0.74.0.
`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 Deprecated Methods
Modifier and Type	Method and Description
`void`	`addStakeholderToken(char stakeholderIdentifier)` This method is applicable only when implementing the TrackingInterceptor interface.
`java.lang.String`	`getAuthorizationAdminGroupName()` Deprecated. Replaced by `getData(String)` with key value "AuthorizationAdminGroupNames".
`java.lang.String[]`	`getAuthorizationAdminGroupNames()` Deprecated. Replaced by `getData(String)` with key value "AuthorizationAdminGroupNames".
`java.lang.String`	`getAuthorizationInvokeGroupName()` Deprecated. Replaced by `getData(String)` with key value "AuthorizationInvokeGroupNames".
`java.lang.String`	`getAuthorizationOperationsGroupName()` Deprecated. Replaced by `getData(String)` with key value "AuthorizationOperationsGroupNames".
`java.lang.String`	`getAuthorizationReaderGroupName()` Deprecated. Replaced by `getData(String)` with key value "AuthorizationReaderGroupNames".
`java.lang.Object`	`getData(java.lang.String key)` Returns the specified data.
`java.lang.String`	`getInputPayload()` Returns a String representation of the input payload.
`boolean`	`getInterceptorPreInvokeFailed()` Returns a boolean value indicating that an exception was thrown by an interceptor.
`java.lang.String`	`getMappedResponseHeader(java.lang.String key)` Returns the value of the specified mapped response header as a String.
`java.util.Enumeration<java.lang.String>`	`getMappedResponseHeaderNames()` Returns an Enumeration of the names of all the response headers for this request that resulted from the API mapping.
`java.lang.String`	`getOutputPayload()` Returns a String representation of the output payload.
`byte[]`	`getRequestID()` Deprecated. Replaced by `getData(String)` with key value "RequestId".
`Data.RequestType`	`getRequestType()` Returns the request type.
`java.lang.String`	`getServiceDescription()` Deprecated. Replaced by `getData(String)` with key value "ServiceDescription".
`java.lang.String`	`getServiceGroupingName()` Deprecated. This has been deprecated as APIs are now used to logically group services and this function is not available for services defined by a service archive file.
`java.lang.String`	`getServiceName()` Deprecated. Replaced by `getData(String)` with key value "ServiceName" for service requests or with key value "ApiName" for API requests.
`boolean`	`isDataTranformationAvailable()` Deprecated. This data is not relevant for implementations of `Interceptor`.

- Field Detail
  - copyright_notice
```
static final java.lang.String copyright_notice
```
    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:
    See Also:
    
    Constant Field Values
  - API_NAME
```
static final java.lang.String API_NAME
```
    Constant for the key used in getData(String) for the name of the API associated with this request. For an OpenAPI 2 API, it is the name of the API archive file. For an OpenAPI 3 API, it is the value of the name attribute on the webApplication element. The value returned by getData(String) is a String, it may be null when the request type is Data.RequestType.ADMIN and is always null when the request type is Data.RequestType.SERVICE.
    This data is available in:
    See Also:
    
    Constant Field Values
  - API_DESCRIPTION
```
static final java.lang.String API_DESCRIPTION
```
    Constant for the key used in getData(String) for the description of the API associated with this request. The value returned by getData(String) is a String, it may be null when the request type is Data.RequestType.ADMIN and is always null when the request type is Data.RequestType.SERVICE.
    This data is available in:
    See Also:
    
    Constant Field Values
  - API_VERSION
```
static final java.lang.String API_VERSION
```
    Constant for the key used in getData(String) for the version of the API associated with this request. The value returned by getData(String) is a String, it may be null when the request type is Data.RequestType.ADMIN and is always null when the request type is Data.RequestType.SERVICE.
    This data is available in:
    See Also:
    
    Constant Field Values
  - API_OPERATION
```
static final java.lang.String API_OPERATION
```
    Constant for the key used in getData(String) for the operation in the API associated with this request. The value returned by getData(String) is a String, it may be null when the request type is Data.RequestType.ADMIN and is always null when the request type is Data.RequestType.SERVICE.
    This data is available in:
    See Also:
    
    Constant Field Values
  - SERVICE_NAME
```
static final java.lang.String SERVICE_NAME
```
    Constant for the key used in getData(String) for the name of the OpenAPI 2 service, or OpenAPI 3 z/OS asset, associated with this request. The value returned by getData(String) is a String, it may be null when the request type is Data.RequestType.ADMIN.
    This data is available in:
    See Also:
    
    Constant Field Values
  - SERVICE_DESCRIPTION
```
static final java.lang.String SERVICE_DESCRIPTION
```
    Constant for the key used in getData(String) for the description of the OpenAPI 2 service, or OpenAPI 3 z/OS asset, associated with this request. The value returned by getData(String) is a String, it may be null when the request type is Data.RequestType.ADMIN.
    This data is available in:
    See Also:
    
    Constant Field Values
  - SERVICE_VERSION
```
static final java.lang.String SERVICE_VERSION
```
    Constant for the key used in getData(String) for the version of the OpenAPI 2 service, or OpenAPI 3 z/OS asset, associated with this request. The value returned by getData(String) is a String, it may be null when the request type is Data.RequestType.ADMIN.
    This data is available in:
    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 any API requester associated with this OpenAPI 2 server administration request. The value returned by getData(String) is a String. It is always null when the request type is Data.RequestType.API or Data.RequestType.SERVICE.
    This data is available in:
    - Interceptor.preInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    - 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
  - API_REQUESTER_DESCRIPTION
```
static final java.lang.String API_REQUESTER_DESCRIPTION
```
    Constant for the key used in getData(String) for the description of any API requester associated with this OpenAPI 2 server administration request. The value returned by getData(String) is a String. It is always null when the request type is Data.RequestType.API or Data.RequestType.SERVICE.
    This data is available in:
    - Interceptor.preInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    - 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
  - API_REQUESTER_VERSION
```
static final java.lang.String API_REQUESTER_VERSION
```
    Constant for the key used in getData(String) for the version of any API requester associated with this OpenAPI 2 server administration request. The value returned by getData(String) is a String. It is always null when the request type is Data.RequestType.API or Data.RequestType.SERVICE.
    This data is available in:
    - Interceptor.preInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    - 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
  - 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 in OpenAPI 2 servers. 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 in OpenAPI 2 servers. 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 in OpenAPI 2 servers. 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 in OpenAPI 2 servers. 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. If the request has timed out due to expiry of the asyncRequestTimeout, the value returned for HTTP_RESPONSE_CODE is the response for the processing of the request by z/OS Connect, but the HTTP client receives an HTTP status code of 503 as part of standard z/OS Connect asynchronous timeout processing. See REQUEST_TIMED_OUT for further details. The value returned by getData(String) is an Integer.
    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)
    - EarlyFailureInterceptor.earlyFailure(com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    See Also:
    
    Constant Field Values
  - SERVICE_PROVIDER_NAME
```
static final java.lang.String SERVICE_PROVIDER_NAME
```
    Constant for the key used in getData(String) for the name of the OpenAPI 2 service provider, or Open API 3 type of z/OS asset, which is processing this request. The value returned by getData(String) is a String, it may be null when the request type is Data.RequestType.ADMIN or Data.RequestType.API.
    This data is available in:
    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 server from the HTTP client. 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:
    See Also:
    
    Constant Field Values
  - TIME_SOR_SENT
```
static final java.lang.String TIME_SOR_SENT
```
    Constant for the key used in getData(String) for the timestamp of when this request was sent to the system of record by the z/OS Connect 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 the request type is Data.RequestType.ADMIN, or when the request has not been sent to the system of record, or if the OpenAPI 2 service provider does not support setting this value.
    This data is available for OpenAPI 2 requests using the CICS, IMS, REST client, MQ or WOLA service provider, and for OpenAPI 3 requests using a CICS, IMS or Db2 z/OS asset, in:
    - Interceptor.postInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    - ServiceProviderInterceptor.postSorInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    .
    See Also:
    
    Constant Field Values
  - TIME_SOR_RECEIVED
```
static final java.lang.String TIME_SOR_RECEIVED
```
    Constant for the key used in getData(String) for the timestamp of when this response was received from the system of record by the z/OS Connect 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 the request type is Data.RequestType.ADMIN, or when a response has not been received from the system of record, or if the service provider does not support setting this value.
    This data is available for OpenAPI 2 requests using the CICS, IMS, REST client, MQ or WOLA service provider, and for OpenAPI 3 requests using a CICS, IMS or Db2 z/OS asset, in:
    - Interceptor.postInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    - ServiceProviderInterceptor.postSorInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    .
    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 HTTP client by the z/OS Connect 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:
    - Interceptor.postInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    - EarlyFailureInterceptor.earlyFailure(com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    See Also:
    
    Constant Field Values
  - SOR_REFERENCE
```
static final java.lang.String SOR_REFERENCE
```
    Constant for the key used in getData(String) for the configured connection reference that identifies the connection to the system of record.The value returned by getData(String) is a String, null when the request type is Data.RequestType.ADMIN, or if the request fails before the service provider or z/OS asset determines the reference, or if the service provider does not support setting this value.
    For OpenAPI 2, this is either the value set in the associated service archive file, or is the value specified in a policy override that applies to this request.
    - For the CICS service provider, it is the value of the id attribute of the zosconnect_cicsIpicConnection element.
    - For the IMS service provider, it is the value of the id attribute of the imsmobile_imsConnection element.
    - For the REST client service provider, it is the value of the id attribute of the zosconnect_zosConnectServiceRestClientConnection element, otherwise if that is not defined for a server.xml defined service, it is the value of the id attribute of the zosconnect_zosConnectServiceRestClient element.
    - For the MQ service provider, it is the value of the jndiName attribute of the jmsConnectionFactory element.
    - For the WOLA service provider, it is the value of the id attribute of the connectionFactory element.
    For OpenAPI 3, this is the connection specified in the z/OS asset.
    - For a CICS z/OS asset, it is the value of the id attribute of the zosconnect_cicsIpicConnection element.
    - For a Db2 z/OS asset, it is the value of the id attribute of the zosconnect_db2Connection element.
    - For an IMS z/OS asset, it is the value of the id attribute of the zosconnect_imsConnection element.
    This data is available in:
    See Also:
    
    Constant Field Values
  - SOR_IDENTIFIER
```
static final java.lang.String SOR_IDENTIFIER
```
    Constant for the key used in getData(String) for a string identifying the system of record.
    - For the CICS service provider or z/OS asset, it is the fully qualified APPLID.
    - For the IMS service provider or z/OS asset, it is the datastore name.
    - For the REST client service provider or Db2 z/OS asset, it is the host and port values of the target system, in the format "<host>:<port>". If the target system is a Db2 database, the format is "<location>,<host>:<port>", where location is the Db2 LOCATION NAME.
    - For the MQ service provider, it is the queue manager name.
    - For the WOLA service provider, it is the name of the WOLA target register.
    The value returned by getData(String) is a String, it is null when the request type is Data.RequestType.ADMIN, or if the request fails before the service provider or z/OS asset determines the identifier, or if the service provider does not support setting this value.
    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)
    - ServiceProviderInterceptor.preSorInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data) Note, for Db2, the LOCATION NAME is not available at this point, the value is just "<host>:<port>".
    - ServiceProviderInterceptor.postSorInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    See Also:
    
    Constant Field Values
  - SOR_RESOURCE
```
static final java.lang.String SOR_RESOURCE
```
    Constant for the key used in getData(String) for a string containing information identifying the resource invoked on the system of record.
    - For the CICS service provider or z/OS asset, it is in the format "<transid>,<program>".
    - For the IMS service provider or z/OS asset, it is the transaction code.
    - For the REST client service provider or Db2 z/OS asset, it is the value of the REST client service URI.
    - For the MQ service provider, it is in the format of "(S)<destination>" for One-Way Services for Sending messages and is in the format of "(R)<destination>" for One-Way Services for Receiving messages and in the format of "(SR)<destination>,<replyDestination>" for Two-Way Services.
    - For the WOLA service provider it is in the format "<serviceName>[,<tranId>]", where serviceName is the name of the WOLA target service and tranId is the name of the WOLA CICS Link Server link invocation task transaction ID, if specified.
    The value returned by getData(String) is a String, null when the request type is Data.RequestType.ADMIN, or if the request fails before the service provider or z/OS asset determines the resource, or if the service provider does not support setting this value.
    This data is available in:
    See Also:
    
    Constant Field Values
  - CORRELATOR
```
static final java.lang.String CORRELATOR
```
    Constant for the key used in getData(String) for a byte array containing a system wide unique correlator. It is embedded in a tracking token and sent to the system of record by some service providers and z/OS assets, @see Tracking requests for information on the format of the tracking token.
    - The CICS service provider and CICS z/OS assets send the tracking token over IPIC and it is available in the CICS user correlation data.
    - The IMS service provider and IMS z/OS assets make the tracking token available in the IMS OTMA.
    - The REST client service provider and Db2 z/OS assets send the tracking token in the "X-Correlation-ID" HTTP header to the endpoint.
    - The WOLA and MQ service providers do not send tracking tokens, although correlators are generated for requests using them.
    The value returned by getData(String) is in the form of a byte array or null when the request type is Data.RequestType.ADMIN.
    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 the tracking token that is passed to the system of record by some service providers and can be used to track this request, @see Tracking requests for information on the format of the tracking token.
    - The CICS service provider and CICS z/OS assets send the tracking token over IPIC and it is available in the CICS user correlation data.
    - The IMS service provider and IMS z/OS assets make the tracking token available in the IMS OTMA.
    - The REST client service provider and Db2 z/OS assets send the tracking token in the "X-Correlation-ID" HTTP header to the endpoint.
    The value returned by getData(String) is in the form of a byte array that is a maximum of 64 bytes in length or null when the request type is Data.RequestType.ADMIN.
    This 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
  - REQUEST_TIMED_OUT
```
static final java.lang.String REQUEST_TIMED_OUT
```
    Constant for the key used in getData(String) for a flag indicating whether this request has been timed out. When this is true the HTTP client has already been sent a response and the other values returned in getData(String) are correct for how the request was processed by z/OS Connect but does not reflect the response the HTTP client received. For example, calling getData(String) with a key value of "HttpResponseCode" may return 200 as the work completed successfully in the system of record, but if the asynchronous request timeout expired before the request had finished processing, the HTTP client will have received the HTTP status code 503. The value returned by getData(String) is a Boolean, true if the request has been timed out.
    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)
    - EarlyFailureInterceptor.earlyFailure(com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
    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. This is the case when the user identity returned by HttpZosConnectRequest.getUserPrincipal() is a distributed identity, the mapDistributedIdentities attribute is set on the safCredentials element in server.xml, and the distributed identity is mapped to a SAF identity in the SAF registry. The value returned is null if the user principal returned by HttpZosConnectRequest.getUserPrincipal() is a SAF identity or is a distributed identity that has not been mapped.
    This data is available in:
    See Also:
    
    Constant Field Values
  - USER_NAME
```
static final java.lang.String USER_NAME
```
    For OpenAPI 2, available from V3.0.58.0 and for OpenAPI 3 available from V3.0.74.0. 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.
    - 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.
    - For a request that fails JWS authentication with the z/OS Connect server, with a 401 response code, the value of the "sub" claim in the JWS.
    - The unauthenticated username.
    This data is available in all methods of the Interceptor interface and its subinterfaces.
    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. The input payload is not available when the request type is Data.RequestType.ADMIN.
    
    Returns:
    
    The String representation of the request payload, null if there is no payload or if a java.io.IOException was thrown while processing the payload.
  - getOutputPayload
```
java.lang.String getOutputPayload()
```
    Returns a String representation of the output payload.
    
    Returns:
    
    The String representation of the response payload, null if there is no payload or if a java.io.IOException was thrown while processing the payload.
  - getMappedResponseHeader
```
java.lang.String getMappedResponseHeader(java.lang.String key)
```
    Returns the value of the specified mapped response header as a String. If API response mapping did not specify a header of the specified name, this method returns null. When the request type is Data.RequestType.ADMIN, this method returns null.
    
    Parameters:
    
    key - A String specifying the mapped response header name.
    
    Returns:
    
    A String containing the value of the specified mapped response header.
  - getMappedResponseHeaderNames
```
java.util.Enumeration<java.lang.String> getMappedResponseHeaderNames()
```
    Returns an Enumeration of the names of all the response headers for this request that resulted from the API mapping. If no response headers resulted from the API mapping, this method returns an empty Enumeration. When the request type is Data.RequestType.ADMIN, this method returns null.
    
    Returns:
    
    An Enumeration with the names of all the mapped response headers.
  - getRequestType
```
Data.RequestType getRequestType()
```
    Returns the request type.
    
    Returns:
    
    The request type.
  - getData
```
java.lang.Object getData(java.lang.String key)
```
    Returns the specified data. See the constants on the Data 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.
  - getServiceName
```
@Deprecated
java.lang.String getServiceName()
```
    Deprecated. Replaced by getData(String) with key value "ServiceName" for service requests or with key value "ApiName" for API requests.
    
    Returns the name associated with the request. If called from an interceptor for an API request, the API name is returned, otherwise the service name is returned.
    
    Returns:
    
    The API or service name associated with the request.
  - getServiceDescription
```
@Deprecated
java.lang.String getServiceDescription()
```
    Deprecated. Replaced by getData(String) with key value "ServiceDescription".
    
    Returns the configured description of the service associated with the request.
    
    Returns:
    
    The description of the service associated with the request. Null, if not configured.
  - getServiceGroupingName
```
@Deprecated
java.lang.String getServiceGroupingName()
```
    Deprecated. This has been deprecated as APIs are now used to logically group services and this function is not available for services defined by a service archive file.
    
    Returns the configured grouping name that can be used to associate a set of services together.
    
    Returns:
    
    The grouping name that can be used to associate a set of services together. Null, if not configured.
  - getAuthorizationAdminGroupName
```
@Deprecated
java.lang.String getAuthorizationAdminGroupName()
```
    Deprecated. Replaced by getData(String) with key value "AuthorizationAdminGroupNames".
    
    Returns the configured administrator group name to be used for authorization validation. If multiple groups have been configured, this method only returns the first item.
    
    Returns:
    
    The first administrator group name. Null if not configured.
  - getAuthorizationAdminGroupNames
```
@Deprecated
java.lang.String[] getAuthorizationAdminGroupNames()
```
    Deprecated. Replaced by getData(String) with key value "AuthorizationAdminGroupNames".
    
    Returns the configured administrator groups names to be used for authorization validation.
    
    Returns:
    
    The administrator groups names. Null if not configured.
  - getAuthorizationOperationsGroupName
```
@Deprecated
java.lang.String getAuthorizationOperationsGroupName()
```
    Deprecated. Replaced by getData(String) with key value "AuthorizationOperationsGroupNames".
    
    Returns the configured operations group name to be used for authorization validation.
    
    Returns:
    
    The operations group name. Null if not configured.
  - getAuthorizationInvokeGroupName
```
@Deprecated
java.lang.String getAuthorizationInvokeGroupName()
```
    Deprecated. Replaced by getData(String) with key value "AuthorizationInvokeGroupNames".
    
    Returns the configured invoke group name to be used for authorization validation.
    
    Returns:
    
    The invoke group name. Null if not configured.
  - getAuthorizationReaderGroupName
```
@Deprecated
java.lang.String getAuthorizationReaderGroupName()
```
    Deprecated. Replaced by getData(String) with key value "AuthorizationReaderGroupNames".
    
    Returns the configured reader group name to be used for authorization validation.
    
    Returns:
    
    The reader group name. Null if not configured.
  - 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.
  - isDataTranformationAvailable
```
@Deprecated
boolean isDataTranformationAvailable()
```
    Deprecated. This data is not relevant for implementations of Interceptor.
    
    Returns a boolean value indicating that a data transformation service is available for the request.
    
    Returns:
    
    True if a data transformation service is available. False, otherwise.
  - getRequestID
```
@Deprecated
byte[] getRequestID()
```
    Deprecated. Replaced by getData(String) with key value "RequestId".
    
    Returns a 23 byte request ID.
    
    Returns:
    
    A 23 byte request ID.
  - addStakeholderToken
```
void addStakeholderToken(char stakeholderIdentifier)
                  throws TrackingCapacityException,
                         java.lang.IllegalArgumentException,
                         java.io.UnsupportedEncodingException,
                         java.lang.UnsupportedOperationException
```
    This method is applicable only when implementing the TrackingInterceptor interface.
    When called during Interceptor.preInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data), it adds a stakeholder token to the tracking token passed to the system of record with the current request. Any stakeholder token added to the request during the Interceptor.postInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data) method is ignored.
    The stakeholder identifier must be the identifier returned by TrackingInterceptor.getStakeholderIdentifier().
    
    Parameters:
    
    stakeholderIdentifier - The registered identifier of the stakeholder.
    
    Throws:
    
    TrackingCapacityException - If there is insufficient space to include this stakeholder token in the tracking token.
    
    java.lang.IllegalArgumentException - If stakeholderIdentifier is not in the range A-Z or a-z.
    
    java.io.UnsupportedEncodingException - If there is an error encoding the stakeholderIdentifier in the code page required by the system of record.
    
    java.lang.UnsupportedOperationException - If this method is called for an Interceptor that has not implemented the TrackingInterceptor interface, or if this method is called for a request of type Data.RequestType.ADMIN.

copyright_notice

REQUEST_ID

API_NAME

API_DESCRIPTION

API_VERSION

API_OPERATION

SERVICE_NAME

SERVICE_DESCRIPTION

SERVICE_VERSION

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

SERVICE_PROVIDER_NAME

TIME_ZOS_CONNECT_ENTRY

TIME_SOR_SENT

TIME_SOR_RECEIVED

TIME_ZOS_CONNECT_EXIT

SOR_REFERENCE

SOR_IDENTIFIER

SOR_RESOURCE

CORRELATOR

TRACKING_TOKEN

REQUEST_TIMED_OUT

USER_NAME_MAPPED

USER_NAME

ZOS_CONNECT_FEATURE_VERSION

ZOS_CONNECT_FEATURE_VERSION_2_0

ZOS_CONNECT_FEATURE_VERSION_3_0

getInputPayload

getOutputPayload

getMappedResponseHeader

getMappedResponseHeaderNames

getRequestType

getData

getServiceName

getServiceDescription

getServiceGroupingName

getAuthorizationAdminGroupName

getAuthorizationAdminGroupNames

getAuthorizationOperationsGroupName

getAuthorizationInvokeGroupName

getAuthorizationReaderGroupName

getInterceptorPreInvokeFailed

isDataTranformationAvailable

getRequestID

addStakeholderToken