com.ibm.zosconnect.spi

Interface DataXformExt

All Superinterfaces:

DataXform

All Known Implementing Classes:

com.ibm.zosconnect.internal.xform.DataXformImpl, SarDataXform

public interface DataXformExt
extends DataXform

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	copyright_notice

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes(java.lang.String serviceName, java.lang.String payload) Transforms the input JSON string to byte array.
java.lang.String	getEncoding(java.lang.String ServiceName) Gets the Encoding Information of the given service name.
java.lang.String	getJSONString(java.lang.String serviceName, byte[] bytes) Transforms a byte array to a JSON string.
java.lang.String	getRequestSchemaString(java.lang.String serviceName) Returns the request schema in string form.
java.lang.String	getResponseSchemaString(java.lang.String serviceName) Returns the response schema in string form.
void	setPreserveJSONObjectPayloadOrder(boolean preserveJSONObjectOder) Sets the indicator that tells the data transformer if the order of entries in JSON object payloads should be preserved.
void	setPreserveJsonPayloadCharFormat(boolean preserveJsonPayloadCharFormat) Sets the indicator that tells the data transformer if the JSON payload's characters should flow unchanged through z/OS Connect during a service invocation and schema retrievals.

Methods inherited from interface com.ibm.zosconnect.spi.DataXform

getBytes, getJSON, getProviderName, getRequestPayloadDataSize, getRequestSchema, getResponsePayloadDataSize, getResponseSchema

Field Detail

copyright_notice

static final java.lang.String copyright_notice

See Also:

Constant Field Values

Method Detail

getEncoding

java.lang.String getEncoding(java.lang.String ServiceName)

Gets the Encoding Information of the given service name.

Parameters:

ServiceName - ServiceName - the service name of the DataXform Service

Returns:

Encoding info provided by the DataXform Service

setPreserveJSONObjectPayloadOrder

void setPreserveJSONObjectPayloadOrder(boolean preserveJSONObjectOder)

Sets the indicator that tells the data transformer if the order of entries in JSON object payloads should be preserved.

Parameters:

preserveJSONObjectOder - Indicates if the order of entries in JSON object payloads should be preserved.

setPreserveJsonPayloadCharFormat

void setPreserveJsonPayloadCharFormat(boolean preserveJsonPayloadCharFormat)

Sets the indicator that tells the data transformer if the JSON payload's characters should flow unchanged through z/OS Connect during a service invocation and schema retrievals. In order for this attribute to take effect, attribute definition preserveJsonObjectPayloadOrder must also configured and set to true. When set to false, UTF-8 encoded characters might be converted to its respective escaped unicode representation.

Parameters:

preserveJsonPayloadCharFormat - True to set the indicator that tells the data transformer if the JSON payload's characters should flow unchanged through z/OS Connect during a service invocation. False otherwise

getBytes

byte[] getBytes(java.lang.String serviceName,
                java.lang.String payload)
         throws DataXformException

Transforms the input JSON string to byte array.

Parameters:

serviceName - The service name associated to the request requesting the payload to be transformed to bytes.

payload - The JSON string to be transformed.

Returns:

The byte array representation of the JSON string.

Throws:

DataXformException - If an error occurred during the data transformation.

getRequestSchemaString

java.lang.String getRequestSchemaString(java.lang.String serviceName)
                                 throws DataXformException

Returns the request schema in string form.

Parameters:

serviceName - The name of the service.

Returns:

The JSON schema as a string.

Throws:

DataXformException - If an error occurred during the data transformation.

getResponseSchemaString

java.lang.String getResponseSchemaString(java.lang.String serviceName)
                                  throws DataXformException

Returns the response schema in string form.

Parameters:

serviceName - The name of the service.

Returns:

The JSON schema as a string.

Throws:

DataXformException - If an error occurred during the data transformation.

getJSONString

java.lang.String getJSONString(java.lang.String serviceName,
                               byte[] bytes)
                        throws DataXformException

Transforms a byte array to a JSON string.

Parameters:

serviceName - The name of the service

bytes - The bytes to be transformed.

Returns:

The JSON string representation of the byte array.

Throws:

DataXformException - If an error occurred during the data transformation.