com.ibm.cloud.objectstorage.protocol.json

Interface SdkStructuredJsonFactory

All Known Implementing Classes:

SdkStructuredJsonFactoryImpl

public interface SdkStructuredJsonFactory

Common interface for creating generators (writers) and protocol handlers for JSON like protocols. Current implementations include SdkStructuredPlainJsonFactory and SdkStructuredCborFactory

Method Summary

Modifier and Type	Method and Description
JsonErrorResponseHandler	createErrorResponseHandler(JsonErrorResponseMetadata jsonErrorResponseMetadata, List<com.ibm.cloud.objectstorage.transform.JsonErrorUnmarshaller> errorUnmarshallers)
JsonErrorResponseHandler	createErrorResponseHandler(List<com.ibm.cloud.objectstorage.transform.JsonErrorUnmarshaller> errorUnmarshallers, String customErrorCodeFieldName) Deprecated. Use SdkStructuredJsonFactory.createErrorResponseHandler(JsonErrorResponseMetadata, List) instead
<T> JsonResponseHandler<T>	createResponseHandler(JsonOperationMetadata operationMetadata, com.ibm.cloud.objectstorage.transform.Unmarshaller<T,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext> responseUnmarshaller) Returns the response handler to be used for handling a successfull response.
StructuredJsonGenerator	createWriter(String contentType) Returns the StructuredJsonGenerator to be used for marshalling the request.

Method Detail

createWriter

StructuredJsonGenerator createWriter(String contentType)

Returns the StructuredJsonGenerator to be used for marshalling the request.

Parameters:

contentType - Content type to send for requests.

createResponseHandler

<T> JsonResponseHandler<T> createResponseHandler(JsonOperationMetadata operationMetadata,
                                                 com.ibm.cloud.objectstorage.transform.Unmarshaller<T,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext> responseUnmarshaller)

Returns the response handler to be used for handling a successfull response.

Parameters:

operationMetadata - Additional context information about an operation to create the appropriate response handler.

createErrorResponseHandler

@Deprecated
JsonErrorResponseHandler createErrorResponseHandler(List<com.ibm.cloud.objectstorage.transform.JsonErrorUnmarshaller> errorUnmarshallers,
                                                                String customErrorCodeFieldName)

Deprecated. Use SdkStructuredJsonFactory.createErrorResponseHandler(JsonErrorResponseMetadata, List) instead

Returns the error response handler for handling a error response.

Parameters:

errorUnmarshallers - Response unmarshallers to unamrshall the error responses.

createErrorResponseHandler

JsonErrorResponseHandler createErrorResponseHandler(JsonErrorResponseMetadata jsonErrorResponseMetadata,
                                                    List<com.ibm.cloud.objectstorage.transform.JsonErrorUnmarshaller> errorUnmarshallers)