com.ibm.cloud.objectstorage.http.response

Class AwsResponseHandlerAdapter<T>

java.lang.Object

com.ibm.cloud.objectstorage.http.response.AwsResponseHandlerAdapter<T>

Type Parameters:

T - Unmarshalled result type

All Implemented Interfaces:

HttpResponseHandler<T>

public class AwsResponseHandlerAdapter<T>
extends Object
implements HttpResponseHandler<T>

Adapts an < AmazonWebServiceResponse > to an HttpResponseHandler (unwrapped result) with proper handling and logging of response metadata.

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
AwsResponseHandlerAdapter(HttpResponseHandler<AmazonWebServiceResponse<T>> delegate, Request<?> request, AWSRequestMetrics awsRequestMetrics, MetadataCache responseMetadataCache)

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AwsResponseHandlerAdapter

public AwsResponseHandlerAdapter(HttpResponseHandler<AmazonWebServiceResponse<T>> delegate,
                                 Request<?> request,
                                 AWSRequestMetrics awsRequestMetrics,
                                 MetadataCache responseMetadataCache)

Parameters:

delegate - Response handler to delegate to and unwrap

request - Marshalled request

awsRequestMetrics - Request metrics

Method Detail

handle

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

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<T>

Returns:

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