com.boomi.restlet.client

Class ResponseUtil

java.lang.Object

com.boomi.restlet.client.ResponseUtil

public class ResponseUtil
extends Object

Constructor Summary

Constructors

Constructor and Description
ResponseUtil()

Method Summary

Modifier and Type	Method and Description
static String	getMessage(org.restlet.data.Response response) Extract the message from the response, or default a message.
static String	getMessage(org.restlet.data.Status status) Extract a meaningful message from Status object.
static InputStream	getStream(org.restlet.data.Response response) This method will extract the InputStream present in a Response.
static boolean	isHttpBackoff(int code) Check whether the HTTP status code is our backoff code.
static boolean	isHttpSuccess(int code, boolean unavailableIsSuccess) Check http code for OK status.
static <T> T	parse(org.restlet.data.Response response, com.boomi.util.StreamUtil.Parser<T> parser) This method will extract the InputStream present in the Response and will parse the InputStream to return T.
static org.restlet.resource.Representation	parseResponseToRepresentation(org.restlet.data.Response response) Lazy man's tool to extract a Representation from a Response.
static Payload	toErrorPayload(org.restlet.data.Response response, Logger log) Converts a response to a payload and logs any issues reading the stream using the provided logger.
static ExtendedPayload	toErrorPayload(org.restlet.data.Response response, Logger log, PayloadMetadata metadata) Converts a response to a payload with the provided metadata and logs any issues reading the stream using the provided logger.
static Payload	toPayload(org.restlet.data.Response response) Converts a response to a payload.
static ExtendedPayload	toPayload(org.restlet.data.Response response, PayloadMetadata metadata) Converts a response to a payload with the provided metadata.
static <T> T	unmarshallResponse(Class<T> unmarshallClass, org.restlet.data.Response response) Really lazy man's tool to unmarshall an object from a response.
static boolean	validateResponse(org.restlet.data.Response response) Quick and easy tool to validate a Response status.
static boolean	validateResponse(org.restlet.data.Response response, boolean unavailableIsSuccess) Quick and easy tool to validate a Response status.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseUtil

public ResponseUtil()

Method Detail

validateResponse

public static boolean validateResponse(org.restlet.data.Response response)

Quick and easy tool to validate a Response status.

Parameters:

response - the response to validate

Returns:

true if ok, false otherwise.

validateResponse

public static boolean validateResponse(org.restlet.data.Response response,
                                       boolean unavailableIsSuccess)

Quick and easy tool to validate a Response status.

Parameters:

response - to validate

unavailableIsSuccess - if resource unavailable counts as a success

Returns:

true if ok, false otherwise.

parseResponseToRepresentation

public static org.restlet.resource.Representation parseResponseToRepresentation(org.restlet.data.Response response)
                                                                         throws Exception

Lazy man's tool to extract a Representation from a Response. First validates the response to make sure the status is ok.

Parameters:

response - which may contain a Representation.

Returns:

the representation found in the response, if the response is ok.

Throws:

Exception - if the response is invalid.

unmarshallResponse

public static <T> T unmarshallResponse(Class<T> unmarshallClass,
                                       org.restlet.data.Response response)
                                throws Exception

Really lazy man's tool to unmarshall an object from a response.

Parameters:

unmarshallClass - The class of Object we expect to find.

response - which should contain the object.

Returns:

the unmarshalled object.

Throws:

Exception - if errors occurred.

isHttpSuccess

public static boolean isHttpSuccess(int code,
                                    boolean unavailableIsSuccess)

Check http code for OK status.

Parameters:

code - the HTTP status code

unavailableIsSuccess - if UNAVAILABLE status is ok in this case

Returns:

true if ok, false otherwise.

isHttpBackoff

public static boolean isHttpBackoff(int code)

Check whether the HTTP status code is our backoff code.

Parameters:

code - the HTTP status code

Returns:

true if backoff, false otherwise.

getMessage

public static String getMessage(org.restlet.data.Response response)

Extract the message from the response, or default a message.

Parameters:

response - the response

Returns:

a status message

getMessage

public static String getMessage(org.restlet.data.Status status)

Extract a meaningful message from Status object.

Parameters:

status - the status response

Returns:

a status message

toErrorPayload

public static Payload toErrorPayload(org.restlet.data.Response response,
                                     Logger log)

Converts a response to a payload and logs any issues reading the stream using the provided logger. This method WILL SUPPRESS exceptions encountered while reading the entity stream. Therefore, it should ONLY be used to create a payload with additional information when the response is known to be an error and the process / document will NOT be marked successful. General conversion of successful or unknown responses should be done using the toPayload(Response) variation which fails if an exception occurs while reading the entity stream.

Parameters:

response - the error response to convert

log - the logger

Returns:

payload containing the entity stream from the response if available, null otherwise

toErrorPayload

public static ExtendedPayload toErrorPayload(org.restlet.data.Response response,
                                             Logger log,
                                             PayloadMetadata metadata)

Converts a response to a payload with the provided metadata and logs any issues reading the stream using the provided logger. This method WILL SUPPRESS exceptions encountered while reading the entity stream. Therefore, it should ONLY be used to create a payload with additional information when the response is known to be an error and the process / document will NOT be marked successful. General conversion of successful or unknown responses should be done using the toPayload(Response, PayloadMetadata) variation which fails if an exception occurs while reading the entity stream.

Parameters:

response - the error response to convert

log - the logger

metadata - the metadata

Returns:

payload containing the entity stream if available, a payload containing an empty stream if the entity stream is not available but metadata was provided (i.e., not null), null otherwise

toPayload

public static Payload toPayload(org.restlet.data.Response response)
                         throws IOException

Converts a response to a payload.

Parameters:

response - the response to convert

Returns:

payload containing the entity stream if available, null otherwise

Throws:

IOException - if the response entity stream is available but cannot be read

toPayload

public static ExtendedPayload toPayload(org.restlet.data.Response response,
                                        PayloadMetadata metadata)
                                 throws IOException

Converts a response to a payload with the provided metadata.

Parameters:

response - the response to convert

metadata - the metadata

Returns:

payload containing the entity stream if available, a payload containing an empty stream if the entity stream is not available but metadata was provided (i.e., not null), null otherwise

Throws:

IOException - if the response entity stream is available but cannot be read

parse

public static <T> T parse(org.restlet.data.Response response,
                          com.boomi.util.StreamUtil.Parser<T> parser)
                   throws IOException

This method will extract the InputStream present in the Response and will parse the InputStream to return T. The parsing is done by a StreamUtil.Parser implementation which would call StreamUtil.Parser#parse(InputStream) to parse the InputStream. The InputStream will be closed once it has been parsed.

Type Parameters:

T -

Parameters:

response - The response to parse

parser - The parser implementation that will parse the underlying input stream

Returns:

The parsed entity present in the response

Throws:

IOException

getStream

public static InputStream getStream(org.restlet.data.Response response)
                             throws IOException

This method will extract the InputStream present in a Response. It will first check if the Response is not null and Message.isEntityAvailable() is true. Otherwise this method will throw and IOException.

Parameters:

response -

Returns:

Throws:

IOException