org.esigate.http

Class HttpResponseUtils

java.lang.Object

org.esigate.http.HttpResponseUtils

public final class HttpResponseUtils
extends Object

Utility methods for HttpClient's Request and Response objects.

Author:

Francois-Xavier Bonnet, Nicolas Richeton

Method Summary

Modifier and Type	Method and Description
static org.apache.http.entity.ContentType	getContentType(org.apache.http.client.methods.CloseableHttpResponse response)
static String	getFirstHeader(String headerName, org.apache.http.HttpResponse httpResponse) Get the value of the first header matching "headerName".
static boolean	isError(org.apache.http.HttpResponse httpResponse) Check if httpResponse has an error status.
static String	removeSessionId(String uri, org.apache.http.HttpResponse httpResponse) Removes ";jsessionid=<id>" from the url, if the session id is also set in "httpResponse".
static String	toString(org.apache.http.client.methods.CloseableHttpResponse response)
static String	toString(org.apache.http.HttpResponse httpResponse, EventManager eventManager) Returns the response body as a string or the reason phrase if body is empty.
static void	writeTo(org.apache.http.HttpEntity httpEntity, OutputStream outstream) Copied from org.apache.http.entity.InputStreamEntity.writeTo(OutputStream) method but flushes the buffer after each read in order to allow streaming and web sockets.

Methods inherited from class java.lang.Object

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

Method Detail

isError

public static boolean isError(org.apache.http.HttpResponse httpResponse)

Check if httpResponse has an error status.

Parameters:

httpResponse - tge HttpResponse

Returns:

true if status code >= 400

getFirstHeader

public static String getFirstHeader(String headerName,
                                    org.apache.http.HttpResponse httpResponse)

Get the value of the first header matching "headerName".

Parameters:

headerName -

httpResponse -

Returns:

value of the first header or null if it doesn't exist.

removeSessionId

public static String removeSessionId(String uri,
                                     org.apache.http.HttpResponse httpResponse)

Removes ";jsessionid=<id>" from the url, if the session id is also set in "httpResponse".

This methods first looks for the following header :

 Set-Cookie: JSESSIONID=
 

If found and perfectly matches the jsessionid value in url, the complete jsessionid definition is removed from the url.

Parameters:

uri - original uri, may contains a jsessionid.

httpResponse - the response which set the jsessionId

Returns:

uri, without jsession

toString

public static String toString(org.apache.http.HttpResponse httpResponse,
                              EventManager eventManager)
                       throws HttpErrorPage

Returns the response body as a string or the reason phrase if body is empty.

This methods is similar to EntityUtils#toString() internally, but uncompress the entity first if necessary.

This methods also holds an extension point, which can be used to guess the real encoding of the entity, if the HTTP headers set a wrong encoding declaration.

Parameters:

httpResponse -

eventManager -

Returns:

The body as string or the reason phrase if body was empty.

Throws:

HttpErrorPage

Since:

3.0, 4.1 - Event EventManager.EVENT_READ_ENTITY is fired when calling this method.

getContentType

public static org.apache.http.entity.ContentType getContentType(org.apache.http.client.methods.CloseableHttpResponse response)

toString

public static String toString(org.apache.http.client.methods.CloseableHttpResponse response)
                       throws HttpErrorPage

Throws:

HttpErrorPage

writeTo

public static void writeTo(org.apache.http.HttpEntity httpEntity,
                           OutputStream outstream)
                    throws IOException

Copied from org.apache.http.entity.InputStreamEntity.writeTo(OutputStream) method but flushes the buffer after each read in order to allow streaming and web sockets.

Parameters:

httpEntity - The entity to copy to the OutputStream

outstream - The OutputStream

Throws:

IOException - If a problem occurs