com.ibm.cloud.objectstorage.protocol.json

Class SdkStructuredJsonFactoryImpl

java.lang.Object

com.ibm.cloud.objectstorage.protocol.json.SdkStructuredJsonFactoryImpl

All Implemented Interfaces:

SdkStructuredJsonFactory

public abstract class SdkStructuredJsonFactoryImpl
extends Object
implements SdkStructuredJsonFactory

Generic implementation of a structured JSON factory that is pluggable for different variants of JSON. See SdkStructuredPlainJsonFactory.SDK_JSON_FACTORY and SdkStructuredCborFactory.SDK_CBOR_FACTORY.

Constructor Summary

Constructors

Constructor and Description

SdkStructuredJsonFactoryImpl(com.fasterxml.jackson.core.JsonFactory jsonFactory, Map<Class<?>,com.ibm.cloud.objectstorage.transform.Unmarshaller<?,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext>> unmarshallers, Map<com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext.UnmarshallerType,com.ibm.cloud.objectstorage.transform.Unmarshaller<?,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext>> customTypeUnmarshallers)

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) Returns the error response handler for handling a error response.
<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.
protected abstract StructuredJsonGenerator	createWriter(com.fasterxml.jackson.core.JsonFactory jsonFactory, String contentType)
StructuredJsonGenerator	createWriter(String contentType) Returns the StructuredJsonGenerator to be used for marshalling the request.
protected ErrorCodeParser	getErrorCodeParser(String customErrorCodeFieldName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SdkStructuredJsonFactoryImpl

public SdkStructuredJsonFactoryImpl(com.fasterxml.jackson.core.JsonFactory jsonFactory,
                                    Map<Class<?>,com.ibm.cloud.objectstorage.transform.Unmarshaller<?,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext>> unmarshallers,
                                    Map<com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext.UnmarshallerType,com.ibm.cloud.objectstorage.transform.Unmarshaller<?,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext>> customTypeUnmarshallers)

Method Detail

createWriter

public StructuredJsonGenerator createWriter(String contentType)

Description copied from interface: SdkStructuredJsonFactory

Returns the StructuredJsonGenerator to be used for marshalling the request.

Specified by:

createWriter in interface SdkStructuredJsonFactory

Parameters:

contentType - Content type to send for requests.

createWriter

protected abstract StructuredJsonGenerator createWriter(com.fasterxml.jackson.core.JsonFactory jsonFactory,
                                                        String contentType)

createResponseHandler

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

Description copied from interface: SdkStructuredJsonFactory

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

Specified by:

createResponseHandler in interface SdkStructuredJsonFactory

Parameters:

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

createErrorResponseHandler

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

Specified by:

createErrorResponseHandler in interface SdkStructuredJsonFactory

createErrorResponseHandler

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

Description copied from interface: SdkStructuredJsonFactory

Returns the error response handler for handling a error response.

Specified by:

createErrorResponseHandler in interface SdkStructuredJsonFactory

Parameters:

errorUnmarshallers - Response unmarshallers to unamrshall the error responses.

getErrorCodeParser

protected ErrorCodeParser getErrorCodeParser(String customErrorCodeFieldName)