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

Class AbstractS3ResponseHandler<T>

java.lang.Object

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

Type Parameters:

T - The output type resulting from handling a response.

All Implemented Interfaces:

HttpResponseHandler<AmazonWebServiceResponse<T>>

Direct Known Subclasses:

S3MetadataResponseHandler, S3ObjectResponseHandler, S3StringResponseHandler, S3XmlResponseHandler

public abstract class AbstractS3ResponseHandler<T>
extends Object
implements HttpResponseHandler<AmazonWebServiceResponse<T>>

Abstract HTTP response handler for Amazon S3 responses. Provides common utilities that other specialized S3 response handlers need to share such as pulling common response metadata (ex: request IDs) out of headers.

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

Method Summary

Modifier and Type	Method and Description
boolean	needsConnectionLeftOpen() The majority of S3 response handlers read the complete response while handling it, and don't need to manually manage the underlying HTTP connection.
protected AmazonWebServiceResponse<T>	parseResponseMetadata(HttpResponse response) Parses the S3 response metadata (ex: Amazon Web Services request ID) from the specified response, and returns a AmazonWebServiceResponse object ready for the result to be plugged in.
protected void	populateObjectMetadata(HttpResponse response, ObjectMetadata metadata) Populates the specified S3ObjectMetadata object with all object metadata pulled from the headers in the specified response.

Methods inherited from class java.lang.Object

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

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

handle

Constructor Detail

AbstractS3ResponseHandler

public AbstractS3ResponseHandler()

Method Detail

needsConnectionLeftOpen

public boolean needsConnectionLeftOpen()

The majority of S3 response handlers read the complete response while handling it, and don't need to manually manage the underlying HTTP connection.

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.

See Also:

HttpResponseHandler.needsConnectionLeftOpen()

parseResponseMetadata

protected AmazonWebServiceResponse<T> parseResponseMetadata(HttpResponse response)

Parses the S3 response metadata (ex: Amazon Web Services request ID) from the specified response, and returns a AmazonWebServiceResponse object ready for the result to be plugged in.

Parameters:

response - The response containing the response metadata to pull out.

Returns:

A new, populated AmazonWebServiceResponse object, ready for the result to be plugged in.

populateObjectMetadata

protected void populateObjectMetadata(HttpResponse response,
                                      ObjectMetadata metadata)

Populates the specified S3ObjectMetadata object with all object metadata pulled from the headers in the specified response.

Parameters:

response - The HTTP response containing the object metadata within the headers.

metadata - The metadata object to populate from the response's headers.