org.qas.api.http

Class JsonResponseHandler<T>

java.lang.Object

org.qas.api.http.JsonResponseHandler<T>

All Implemented Interfaces:

HttpResponseHandler<ApiServiceResponse<T>>

public class JsonResponseHandler<T>
extends java.lang.Object
implements HttpResponseHandler<ApiServiceResponse<T>>

JsonResponseHandler

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
boolean	needsConnectionLeftOpen

Constructor Summary

Constructors

Constructor and Description
JsonResponseHandler(Unmarshaller<T,JsonUnmarshallerContext> 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 and Description
protected java.lang.String	getRequestId(HttpResponse response)
ApiServiceResponse<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.
protected void	registerAdditionalMetadataExpressions(JsonUnmarshallerContext unmarshallerContext) Hook for subclasses to override in order to collect additional metadata from service responses.

Methods inherited from class java.lang.Object

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

Field Detail

needsConnectionLeftOpen

public boolean needsConnectionLeftOpen

Constructor Detail

JsonResponseHandler

public JsonResponseHandler(Unmarshaller<T,JsonUnmarshallerContext> 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 ApiServiceResponse<T> handle(HttpResponse response)
                             throws java.lang.Exception

Description copied from interface: HttpResponseHandler

Accepts an HTTP response object, and returns an object of type T.

Specified by:

handle in interface HttpResponseHandler<ApiServiceResponse<T>>

Parameters:

response - The HTTP response to handle, as received from request.

Returns:

An object of type T, as defined by individual implementation.

Throws:

java.lang.Exception - If any problems are encountered handling the response.

registerAdditionalMetadataExpressions

protected void registerAdditionalMetadataExpressions(JsonUnmarshallerContext unmarshallerContext)

Hook for subclasses to override in order to collect additional metadata from service responses.

Parameters:

unmarshallerContext - The unmarshaller context used to process a service's response data.

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

Returns:

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

getRequestId

protected java.lang.String getRequestId(HttpResponse response)

Returns:

the response request header.