org.qas.api.http

Class StringResponseHandler

java.lang.Object

org.qas.api.http.StringResponseHandler

All Implemented Interfaces:

HttpResponseHandler<ApiServiceResponse<java.lang.String>>

public class StringResponseHandler
extends java.lang.Object
implements HttpResponseHandler<ApiServiceResponse<java.lang.String>>

StringResponseHandler

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
StringResponseHandler() Creates StringResponseHandler to handle response.
StringResponseHandler(Unmarshaller<java.lang.String,java.io.InputStream> responseUnmarshaller) Creates StringResponseHandler to handle response.

Method Summary

Modifier and Type	Method and Description
ApiServiceResponse<java.lang.String>	handle(HttpResponse<?> httpResponse) Accepts an HTTP response object, and returns an object of type T.
boolean	needsConnectionLeftOpen()

Methods inherited from class java.lang.Object

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

Constructor Detail

StringResponseHandler

public StringResponseHandler()

Creates StringResponseHandler to handle response.

StringResponseHandler

public StringResponseHandler(Unmarshaller<java.lang.String,java.io.InputStream> responseUnmarshaller)

Creates StringResponseHandler to handle response.

Parameters:

responseUnmarshaller - the given response unmarshaller.

Method Detail

handle

public ApiServiceResponse<java.lang.String> handle(HttpResponse<?> httpResponse)
                                            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<java.lang.String>>

Parameters:

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

needsConnectionLeftOpen

public boolean needsConnectionLeftOpen()

Specified by:

needsConnectionLeftOpen in interface HttpResponseHandler<ApiServiceResponse<java.lang.String>>

Returns:

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