RequestData (z/OS Connect SPI)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

Data
```
public interface RequestData
extends Data
```
Defines an object that holds data associated to a specific request.
Operations that dynamically process data conversion expect a data transformation service to have been configured. If one is not present, a DataXformException is raised.
This interface is implemented by z/OS Connect.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.ibm.zosconnect.spi.Data
  Data.RequestType

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String copyright_notice
- Fields inherited from interface com.ibm.zosconnect.spi.Data
  API_DESCRIPTION, API_NAME, API_OPERATION, API_REQUESTER_DESCRIPTION, API_REQUESTER_NAME, API_REQUESTER_VERSION, API_VERSION, AUTHORIZATION_ADMIN_GROUP_NAMES, AUTHORIZATION_INVOKE_GROUP_NAMES, AUTHORIZATION_OPERATIONS_GROUP_NAMES, AUTHORIZATION_READER_GROUP_NAMES, CORRELATOR, HTTP_RESPONSE_CODE, REQUEST_ID, REQUEST_TIMED_OUT, SERVICE_DESCRIPTION, SERVICE_NAME, SERVICE_PROVIDER_NAME, SERVICE_VERSION, SOR_IDENTIFIER, SOR_REFERENCE, SOR_RESOURCE, TIME_SOR_RECEIVED, TIME_SOR_SENT, TIME_ZOS_CONNECT_ENTRY, TIME_ZOS_CONNECT_EXIT, TRACKING_TOKEN, USER_NAME, USER_NAME_MAPPED

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`byte[]`	`getBytes()` Dynamically converts an available JSON payload to a byte array.
`com.ibm.json.java.JSONObject`	`getJSON()` Retrieves the JSONObject associated with the inbound HTTP request.
`java.lang.Long`	`getPayloadDataSize()` Returns the size of the data in the request payload.

- Field Detail
  - copyright_notice
```
static final java.lang.String copyright_notice
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getJSON
```
com.ibm.json.java.JSONObject getJSON()
```
    Retrieves the JSONObject associated with the inbound HTTP request.
    
    Returns:
    
    The JSONObject. Null if the request has no payload.
  - getBytes
```
byte[] getBytes()
         throws DataXformException
```
    Dynamically converts an available JSON payload to a byte array. The payload is converted using the configured data transformation service.
    
    Returns:
    
    A byte representation of the JSONObject payload. Null if there is no payload.
    
    Throws:
    
    DataXformException - If there was an error while dynamically transforming the JSONObject payload to a byteArray or if a data transformation service is not available to convert the payload.
  - getPayloadDataSize
```
java.lang.Long getPayloadDataSize()
                           throws DataXformException
```
    Returns the size of the data in the request payload.
    
    Returns:
    
    The size of the data in the request payload.
    
    Throws:
    
    DataXformException - If there is a processing error.