com.ibm.cloud.objectstorage.http

Class DefaultErrorResponseHandler

java.lang.Object

com.ibm.cloud.objectstorage.http.DefaultErrorResponseHandler

All Implemented Interfaces:

HttpResponseHandler<AmazonServiceException>

public class DefaultErrorResponseHandler
extends Object
implements HttpResponseHandler<AmazonServiceException>

Implementation of HttpResponseHandler that handles only error responses from Amazon Web Services. A list of unmarshallers is passed into the constructor, and while handling a response, each unmarshaller is tried, in order, until one is found that can successfully unmarshall the error response. If no unmarshaller is found that can unmarshall the error response, a generic AmazonServiceException is created and populated with the AWS error response information (error message, AWS error code, AWS request ID, etc).

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
DefaultErrorResponseHandler(List<com.ibm.cloud.objectstorage.transform.Unmarshaller<AmazonServiceException,Node>> unmarshallerList) Constructs a new DefaultErrorResponseHandler that will handle error responses from Amazon services using the specified list of unmarshallers.
DefaultErrorResponseHandler(Map<String,com.ibm.cloud.objectstorage.transform.Unmarshaller<AmazonServiceException,Node>> unmarshallerMap, com.ibm.cloud.objectstorage.transform.Unmarshaller<AmazonServiceException,Node> defaultUnmarshaller) Constructs a new DefaultErrorResponseHandler that will handle error responses from Amazon services using the specified map of unmarshallers.

Method Summary

Modifier and Type	Method and Description
AmazonServiceException	handle(HttpResponse errorResponse) Accepts an HTTP response object, and returns an object of type T.
boolean	needsConnectionLeftOpen() Since this response handler completely consumes all the data from the underlying HTTP connection during the handle method, we don't need to keep the HTTP connection open.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultErrorResponseHandler

public DefaultErrorResponseHandler(Map<String,com.ibm.cloud.objectstorage.transform.Unmarshaller<AmazonServiceException,Node>> unmarshallerMap,
                                   com.ibm.cloud.objectstorage.transform.Unmarshaller<AmazonServiceException,Node> defaultUnmarshaller)

Constructs a new DefaultErrorResponseHandler that will handle error responses from Amazon services using the specified map of unmarshallers. Unmrarshallers are retrieved from unmarshallerMap

Parameters:

unmarshallerMap - The map of unmarshallers where key is errorCode and Value is unmarshaller for that errorCode.

defaultUnmarshaller - Default or standard Unmarshaller defined for the Service.

DefaultErrorResponseHandler

public DefaultErrorResponseHandler(List<com.ibm.cloud.objectstorage.transform.Unmarshaller<AmazonServiceException,Node>> unmarshallerList)

Constructs a new DefaultErrorResponseHandler that will handle error responses from Amazon services using the specified list of unmarshallers. Each unmarshaller will be tried, in order, until one is found that can unmarshall the error response.

Parameters:

unmarshallerList - The list of unmarshallers to try using when handling an error response.

Method Detail

handle

public AmazonServiceException handle(HttpResponse errorResponse)
                              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<AmazonServiceException>

Parameters:

errorResponse - 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.

needsConnectionLeftOpen

public boolean needsConnectionLeftOpen()

Since this response handler completely consumes all the data from the underlying HTTP connection during the handle method, we don't need to keep the HTTP connection open.

Specified by:

needsConnectionLeftOpen in interface HttpResponseHandler<AmazonServiceException>

Returns:

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

See Also:

HttpResponseHandler.needsConnectionLeftOpen()