com.ibm.cloud.objectstorage.http

Class JsonResponseHandler<T>

java.lang.Object

com.ibm.cloud.objectstorage.http.JsonResponseHandler<T>

Type Parameters:

T - Indicates the type being unmarshalled by this response handler.

All Implemented Interfaces:

HttpResponseHandler<AmazonWebServiceResponse<T>>

public class JsonResponseHandler<T>
extends Object
implements HttpResponseHandler<AmazonWebServiceResponse<T>>

Default implementation of HttpResponseHandler that handles a successful response from an AWS service and unmarshalls the result using a JSON unmarshaller.

Field Summary

Fields inherited from interface com.ibm.cloud.objectstorage.http.HttpResponseHandler

X_AMZ_REQUEST_ID_ALTERNATIVE_HEADER, X_AMZN_EXTENDED_REQUEST_ID_HEADER, X_AMZN_QUERY_ERROR, X_AMZN_REQUEST_ID_HEADER

Constructor Summary

Constructors

Constructor and Description

JsonResponseHandler(com.ibm.cloud.objectstorage.transform.Unmarshaller<T,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext> responseUnmarshaller, Map<Class<?>,com.ibm.cloud.objectstorage.transform.Unmarshaller<?,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext>> simpleTypeUnmarshallers, Map<com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext.UnmarshallerType,com.ibm.cloud.objectstorage.transform.Unmarshaller<?,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext>> customTypeMarshallers, com.fasterxml.jackson.core.JsonFactory jsonFactory, boolean needsConnectionLeftOpen, boolean isPayloadJson) Constructs a new response handler that will use the specified JSON unmarshaller to unmarshall the service response and uses the specified response element path to find the root of the business data in the service's response.

Method Summary

Modifier and Type	Method and Description
AmazonWebServiceResponse<T>	handle(HttpResponse response) Accepts an HTTP response object, and returns an object of type T.
boolean	needsConnectionLeftOpen() Indicates if this response handler requires that the underlying HTTP connection not be closed automatically after the response is handled.
protected void	registerAdditionalMetadataExpressions(com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext unmarshallerContext) Hook for subclasses to override in order to collect additional metadata from service responses.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonResponseHandler

public JsonResponseHandler(com.ibm.cloud.objectstorage.transform.Unmarshaller<T,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext> responseUnmarshaller,
                           Map<Class<?>,com.ibm.cloud.objectstorage.transform.Unmarshaller<?,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext>> simpleTypeUnmarshallers,
                           Map<com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext.UnmarshallerType,com.ibm.cloud.objectstorage.transform.Unmarshaller<?,com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext>> customTypeMarshallers,
                           com.fasterxml.jackson.core.JsonFactory jsonFactory,
                           boolean needsConnectionLeftOpen,
                           boolean isPayloadJson)

Constructs a new response handler that will use the specified JSON unmarshaller to unmarshall the service response and uses the specified response element path to find the root of the business data in the service's response.

Parameters:

responseUnmarshaller - The JSON unmarshaller to use on the response.

simpleTypeUnmarshallers - List of unmarshallers to be used for scalar types.

customTypeMarshallers - List of custom unmarshallers to be used for special types.

jsonFactory - the json factory to be used for parsing the response.

Method Detail

handle

public AmazonWebServiceResponse<T> handle(HttpResponse response)
                                   throws Exception

Description copied from interface: HttpResponseHandler

Accepts an HTTP response object, and returns an object of type T. Individual implementations may choose to handle the response however they need to, and return any type that they need to.

Specified by:

handle in interface HttpResponseHandler<AmazonWebServiceResponse<T>>

Parameters:

response - The HTTP response to handle, as received from an AWS service.

Returns:

An object of type T, as defined by individual implementations.

Throws:

Exception - If any problems are encountered handling the response.

See Also:

HttpResponseHandler.handle(HttpResponse)

registerAdditionalMetadataExpressions

protected void registerAdditionalMetadataExpressions(com.ibm.cloud.objectstorage.transform.JsonUnmarshallerContext unmarshallerContext)

Hook for subclasses to override in order to collect additional metadata from service responses.

Parameters:

unmarshallerContext - The unmarshaller context used to configure a service's response data.

needsConnectionLeftOpen

public boolean needsConnectionLeftOpen()

Description copied from interface: HttpResponseHandler

Indicates if this response handler requires that the underlying HTTP connection not be closed automatically after the response is handled.

For example, if the object returned by this response handler manually manages the stream of data from the HTTP connection, and doesn't read all the data from the connection in the HttpResponseHandler.handle(HttpResponse) method, this method can be used to prevent the underlying connection from being prematurely closed.

Response handlers should use this option very carefully, since it means that resource cleanup is no longer handled automatically, and if neglected, can result in the client runtime running out of resources for new HTTP connections.

Specified by:

needsConnectionLeftOpen in interface HttpResponseHandler<AmazonWebServiceResponse<T>>

Returns:

True if this response handler requires that the underlying HTTP connection be left open, and not automatically closed, otherwise false.