com.ibm.cloud.objectstorage.http

Interface HttpResponseHandler<T>

Type Parameters:

T - The output of this response handler.

All Known Implementing Classes:

AbstractS3ResponseHandler, AwsResponseHandlerAdapter, DefaultErrorResponseHandler, JsonErrorResponseHandler, JsonResponseHandler, ResponseHeaderHandlerChain, S3ErrorResponseHandler, S3MetadataResponseHandler, S3ObjectResponseHandler, S3StringResponseHandler, S3XmlResponseHandler, StaxResponseHandler

public interface HttpResponseHandler<T>

Responsible for handling an HTTP response and returning an object of type T. For example, a typical response handler might accept a response, and translate it into a concrete typed object.

Field Summary

Fields

Modifier and Type	Field and Description
static String	X_AMZ_REQUEST_ID_ALTERNATIVE_HEADER Alternative header identifying the request.
static String	X_AMZN_EXTENDED_REQUEST_ID_HEADER An extended request ID used primarily by S3 related services.
static String	X_AMZN_QUERY_ERROR
static String	X_AMZN_REQUEST_ID_HEADER Header identifying the request.

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.

Field Detail

X_AMZN_REQUEST_ID_HEADER

static final String X_AMZN_REQUEST_ID_HEADER

Header identifying the request. Generated by the service and returned in the HTTP response.

See Also:

Constant Field Values

X_AMZN_EXTENDED_REQUEST_ID_HEADER

static final String X_AMZN_EXTENDED_REQUEST_ID_HEADER

An extended request ID used primarily by S3 related services.

See Also:

Constant Field Values

X_AMZ_REQUEST_ID_ALTERNATIVE_HEADER

static final String X_AMZ_REQUEST_ID_ALTERNATIVE_HEADER

Alternative header identifying the request. Generated by S3 related services and with 503 error responses.

See Also:

Constant Field Values

X_AMZN_QUERY_ERROR

static final String X_AMZN_QUERY_ERROR

See Also:

Constant Field Values

Method Detail

handle

T handle(HttpResponse response)
  throws Exception

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.

needsConnectionLeftOpen

boolean needsConnectionLeftOpen()

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.

Returns:

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