com.boomi.common.apache.http.response

Class HttpResponseUtil

java.lang.Object

com.boomi.common.apache.http.response.HttpResponseUtil

public class HttpResponseUtil
extends Object

General utilities for handling Apache HTTP response classes HttpResponse, StatusLine, etc.

Method Summary

Modifier and Type	Method and Description
static Map<String,String>	getCondensedHeaders(org.apache.http.HttpResponse response) Fetches all the response headers from the given HttpResponse and returns a Map of header name and corresponding header values.
static boolean	isContentType(org.apache.http.HttpEntity entity, org.apache.http.entity.ContentType contentType) Determines if the content type of the entity matches the provided content type.
static boolean	isContentType(org.apache.http.HttpResponse response, org.apache.http.entity.ContentType contentType) Determines if the content type of the response entity matches the provided content type.
static boolean	isEntityAvailable(org.apache.http.HttpResponse response) Determines if a content is available.
static boolean	isJson(org.apache.http.HttpResponse response) Determines if the content type of the response entity is ContentType.APPLICATION_JSON.
static boolean	isMimeTypeMatching(org.apache.http.entity.ContentType contentType, org.apache.http.entity.ContentType otherContentType) Determines both ContentType by the mime type.
static boolean	isResponseEntityNull(org.apache.http.HttpResponse response) Returns true if the response from the service has no data.
static boolean	isStatus(org.apache.http.HttpResponse response, int statusCode) Determines if the provided status code matches the status code of the provided response.
static boolean	isStatus(org.apache.http.StatusLine statusLine, int statusCode) Determines if the provided status code matches the status code of the provided response.
static ConnectorStatus	toConnectorStatus(org.apache.http.StatusLine status) Converts the provided StatusLine to a ConnectorStatus.
static OperationStatus	toOperationStatus(org.apache.http.StatusLine status) Converts the provided StatusLine to an OperationStatus based on StatusLine.getStatusCode().
static Payload	toPayload(org.apache.http.HttpResponse response) Converts the entity content of the provided response to a Payload
static ExtendedPayload	toPayload(org.apache.http.HttpResponse response, PayloadMetadata metadata) Converts the entity content of the provided response to a ExtendedPayload with the provided PayloadMetadata
static String	toStatusMessage(org.apache.http.StatusLine status) Converts the provided StatusLine to a status message

Methods inherited from class java.lang.Object

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

Method Detail

toPayload

public static Payload toPayload(org.apache.http.HttpResponse response)
                         throws IOException

Converts the entity content of the provided response to a Payload

Parameters:

response - the HTTP response

Returns:

null if the response or entity are null, new payload instance that can read the entity content otherwise

Throws:

IOException

toPayload

public static ExtendedPayload toPayload(org.apache.http.HttpResponse response,
                                        PayloadMetadata metadata)
                                 throws IOException

Converts the entity content of the provided response to a ExtendedPayload with the provided PayloadMetadata

Parameters:

response - the HTTP response

metadata - for the payload being created

Returns:

null if the response is null, returns empty stream if entity or content is null. Otherwise returns entity content.

Throws:

IOException

toStatusMessage

public static String toStatusMessage(org.apache.http.StatusLine status)

Converts the provided StatusLine to a status message

Parameters:

status - the status line

Returns:

StatusLine.getReasonPhrase() if available, otherwise an inferred message based on StatusLine.getStatusCode() if available, null otherwise

toOperationStatus

public static OperationStatus toOperationStatus(org.apache.http.StatusLine status)

Converts the provided StatusLine to an OperationStatus based on StatusLine.getStatusCode(). Note this method deviates from previous determinations based on status code as any "valid" status code that is not a success is treated as an OperationStatus.APPLICATION_ERROR. Previous rules only treated 2xx as success and 3xx/4xx as application errors. All other codes were treated as failures. However, lots services are poorly behaved and don't fit nicely into that box. Success Status Codes: 2xx Valid Status Codes: 1xx, 2xx, 3xx, 4xx, 5xx

Parameters:

status - the status line

Returns:

OperationStatus.SUCCESS if the status code is available and a success, otherwise OperationStatus.APPLICATION_ERROR if the status code is available and valid, OperationStatus.FAILURE otherwise

toConnectorStatus

public static ConnectorStatus toConnectorStatus(org.apache.http.StatusLine status)

Converts the provided StatusLine to a ConnectorStatus. The status message and operation status are determined using toStatusMessage(StatusLine) and toOperationStatus(StatusLine) respectively. The status code is a string representation of StatusLine.getStatusCode().

Parameters:

status - the status line

Returns:

the connector status if the status line is not null, ConnectorStatus.UNKNOWN otherwise

isJson

public static boolean isJson(org.apache.http.HttpResponse response)

Determines if the content type of the response entity is ContentType.APPLICATION_JSON. This method adheres to the same contract as isContentType(HttpResponse, ContentType).

Parameters:

response - the HTTP response

Returns:

true if the response entity content type is ContentType.APPLICATION_JSON

isContentType

public static boolean isContentType(org.apache.http.HttpResponse response,
                                    org.apache.http.entity.ContentType contentType)

Determines if the content type of the response entity matches the provided content type. Since this determination is usually part of processing an entity, this method also requires that the response entity is not null and that the entity content length is not zero.

Parameters:

response - the HTTP response

contentType - the content

Returns:

true if the response is not null, has a non-empty entity, and the content type of that entity matches the specified content type, false otherwise

isContentType

public static boolean isContentType(org.apache.http.HttpEntity entity,
                                    org.apache.http.entity.ContentType contentType)

Determines if the content type of the entity matches the provided content type. Since this determination is usually part of processing an entity, this method also requires that the entity is not null and that the entity content length is not zero.

Parameters:

entity - the entity

contentType - the content

Returns:

true if the entity is not null, the content length is greater than zero, and the content type of that entity matches the specified content type, false otherwise

isMimeTypeMatching

public static boolean isMimeTypeMatching(org.apache.http.entity.ContentType contentType,
                                         org.apache.http.entity.ContentType otherContentType)

Determines both ContentType by the mime type. this is not case-sensitive. returns true if both content type is the same. returns false otherwise.

Parameters:

contentType -

otherContentType -

Returns:

true if both ContentTypes's MimeType Match, false otherwise

isResponseEntityNull

public static boolean isResponseEntityNull(org.apache.http.HttpResponse response)

Returns true if the response from the service has no data. Returns false otherwise.

Parameters:

response -

Returns:

true if response is not empty, false otherwise.

isStatus

public static boolean isStatus(org.apache.http.HttpResponse response,
                               int statusCode)

Determines if the provided status code matches the status code of the provided response.

Parameters:

response - the HTTP response

statusCode - the status code

Returns:

true if the HttpResponse is not null, HttpResponse.getStatusLine() is not null, and StatusLine.getStatusCode() matches the provided status code. false otherwise

isStatus

public static boolean isStatus(org.apache.http.StatusLine statusLine,
                               int statusCode)

Determines if the provided status code matches the status code of the provided response.

Parameters:

statusLine - the HTTP response status line

statusCode - the status code

Returns:

true if the StatusLine is not null and StatusLine.getStatusCode() matches the provided status code. false otherwise

getCondensedHeaders

public static Map<String,String> getCondensedHeaders(org.apache.http.HttpResponse response)

Fetches all the response headers from the given HttpResponse and returns a Map of header name and corresponding header values. If more than one headers with the same name and different casing exist, the values will be combined with a ", " and wrapped under the first header naming.

Parameters:

response - http response from an endpoint

Returns:

A map containing all the http response headers

isEntityAvailable

public static boolean isEntityAvailable(org.apache.http.HttpResponse response)

Determines if a content is available. The response and the entity must not be null and the entity content length must not be 0.

Parameters:

response - the HTTP response

Returns:

true if a content is available