Type Parameters:

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

All Implemented Interfaces:

HttpResponseHandler<AmazonWebServiceResponse<T>>

Direct Known Subclasses:

S3ControlStaxResponseHandler, SimpleDBStaxResponseHandler

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

• Field Summary

  • Fields inherited from interface com.amazonaws.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
  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.
  StaxResponseHandler (Unmarshaller<T,StaxUnmarshallerContext> responseUnmarshaller, boolean needsConnectionLeftOpen, boolean isPayloadXML)

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  AmazonWebServiceResponse<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 in most of the cases.

  • 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,
     boolean needsConnectionLeftOpen,
     boolean isPayloadXML)

  • 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 AmazonWebServiceResponse<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<AmazonWebServiceResponse<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 in most of the cases. However, we need it for payload as InputStream.

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