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

Class S3ObjectResponseHandler

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.internal.AbstractS3ResponseHandler<S3Object>

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

All Implemented Interfaces:

HttpResponseHandler<AmazonWebServiceResponse<S3Object>>

public class S3ObjectResponseHandler
extends AbstractS3ResponseHandler<S3Object>

S3 HTTP response handler that knows how to pull S3 object content and metadata out of an HTTP response and unmarshall it into an S3Object object.

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

Method Summary

Modifier and Type	Method and Description
AmazonWebServiceResponse<S3Object>	handle(HttpResponse response) Accepts an HTTP response object, and returns an object of type T.
boolean	needsConnectionLeftOpen() Returns true, since the entire response isn't read while this response handler handles the response.

Methods inherited from class com.ibm.cloud.objectstorage.services.s3.internal.AbstractS3ResponseHandler

parseResponseMetadata, populateObjectMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

S3ObjectResponseHandler

public S3ObjectResponseHandler()

Method Detail

handle

public AmazonWebServiceResponse<S3Object> 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.

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(com.ibm.cloud.objectstorage.http.HttpResponse)

needsConnectionLeftOpen

public boolean needsConnectionLeftOpen()

Returns true, since the entire response isn't read while this response handler handles the response. This enables us to keep the underlying HTTP connection open, so that the caller can stream it off.

Specified by:

needsConnectionLeftOpen in interface HttpResponseHandler<AmazonWebServiceResponse<S3Object>>

Overrides:

needsConnectionLeftOpen in class AbstractS3ResponseHandler<S3Object>

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