com.ibm.cloud.objectstorage.services.s3.internal

Class S3ErrorResponseHandler

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.internal.S3ErrorResponseHandler

All Implemented Interfaces:

HttpResponseHandler<AmazonServiceException>

public class S3ErrorResponseHandler
extends Object
implements HttpResponseHandler<AmazonServiceException>

Response handler for S3 error responses. S3 error responses are different from other Amazon Web Services error responses in a few ways. Most error responses will contain an XML body, but not all (ex: error responses to HEAD requests will not), so this error handler has to account for that. The actual XML error response body is slightly different than other services like SimpleDB or EC2 and some information isn't explicitly represented in the XML error response body (ex: error type/fault information) so it has to be inferred from other parts of the error response.

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
S3ErrorResponseHandler(ClientConfiguration clientConfiguration)

Method Summary

Modifier and Type	Method and Description
AmazonServiceException	handle(HttpResponse httpResponse) 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

S3ErrorResponseHandler

public S3ErrorResponseHandler(ClientConfiguration clientConfiguration)

Method Detail

handle

public AmazonServiceException handle(HttpResponse httpResponse)
                              throws XMLStreamException

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:

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

Returns:

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

Throws:

XMLStreamException

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()