Package software.amazon.awssdk.http

Class StaxResponseHandler<T>

java.lang.Object

software.amazon.awssdk.http.StaxResponseHandler<T>

Type Parameters:

T - Indicates the type being unmarshalled by this response handler.

All Implemented Interfaces:

HttpResponseHandler<T>

Direct Known Subclasses:

SimpleDbStaxResponseHandler

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

Default implementation of HttpResponseHandler that handles a successful response from an AWS service and unmarshalls the result using a StAX unmarshaller.

Field Summary

Fields inherited from interface software.amazon.awssdk.http.HttpResponseHandler

X_AMZN_REQUEST_ID_HEADER

Constructor Summary

Constructors

Constructor	Description
StaxResponseHandler(Unmarshaller<T,StaxUnmarshallerContext> responseUnmarshaller)	Constructs a new response handler that will use the specified StAX unmarshaller to unmarshall the service response and uses the specified response element path to find the root of the business data in the service's response.

Method Summary

Modifier and Type	Method	Description
static <ResponseT,ReturnT> SdkHttpResponseHandler<ReturnT>	createStreamingAsyncResponseHandler(Unmarshaller<ResponseT,StaxUnmarshallerContext> unmarshaller, AsyncResponseHandler<ResponseT,ReturnT> asyncResponseHandler)	Creates an async SdkHttpResponseHandler from the given unmarshaller and customer provided AsyncResponseHandler.
static <ResponseT,ReturnT> HttpResponseHandler<ReturnT>	createStreamingResponseHandler(Unmarshaller<ResponseT,StaxUnmarshallerContext> unmarshaller, StreamingResponseHandler<ResponseT,ReturnT> streamingHandler)	Creates an synchronous HttpResponseHandler that unmarshalls the resposne POJO thne passes the HTTP content to the given StreamingResponseHandler.
T	handle(HttpResponse response)	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

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

Constructor Detail

StaxResponseHandler

public StaxResponseHandler(Unmarshaller<T,StaxUnmarshallerContext> responseUnmarshaller)

Constructs a new response handler that will use the specified StAX unmarshaller to unmarshall the service response and uses the specified response element path to find the root of the business data in the service's response.

Parameters:

responseUnmarshaller - The StAX unmarshaller to use on the response.

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.

See Also:

HttpResponseHandler.handle(HttpResponse)

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

createStreamingResponseHandler

public static <ResponseT,ReturnT> HttpResponseHandler<ReturnT> createStreamingResponseHandler(Unmarshaller<ResponseT,StaxUnmarshallerContext> unmarshaller,
                                                                                              StreamingResponseHandler<ResponseT,ReturnT> streamingHandler)

Creates an synchronous HttpResponseHandler that unmarshalls the resposne POJO thne passes the HTTP content to the given StreamingResponseHandler.

Type Parameters:

ResponseT - Response POJO type.

ReturnT - Return type of customer provided response handler.

Parameters:

unmarshaller - Unmarshaller for response POJO.

streamingHandler - Customer provided response handler.

createStreamingAsyncResponseHandler

public static <ResponseT,ReturnT> SdkHttpResponseHandler<ReturnT> createStreamingAsyncResponseHandler(Unmarshaller<ResponseT,StaxUnmarshallerContext> unmarshaller,
                                                                                                      AsyncResponseHandler<ResponseT,ReturnT> asyncResponseHandler)

Creates an async SdkHttpResponseHandler from the given unmarshaller and customer provided AsyncResponseHandler.

Type Parameters:

ResponseT - Response POJO type.

ReturnT - Return type of customer provided response handler.

Parameters:

unmarshaller - Unmarshaller for POJO response type.

asyncResponseHandler - Customer provided response handler to consume HTTP content.

Returns:

SdkHttpResponseHandler that first unmarshalls the POJO and then provides the content.