Package dev.galasa.http

Class HttpClientResponse<T>

java.lang.Object

dev.galasa.http.HttpClientResponse<T>

Type Parameters:

T - Class describing the content type of the response

Direct Known Subclasses:

HttpFileResponse

public class HttpClientResponse<T>
extends Object

Parametrisable representation of a response to an HTTP request. The parameter describes the content type of the response. Use the static methods to create instances from an HttpResponse.

Method Summary

Modifier and Type	Method	Description
static HttpClientResponse<byte[]>	byteResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse)	Create an HttpClientResponse with a byte array content type from an HttpResponse.
static HttpClientResponse<byte[]>	byteResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse, boolean contentOnBadResponse)	Create an HttpClientResponse with a byte array content type from an HttpResponse.
T	getContent()
Object	getHeader(String header)	Get the value of a specific header as a String.
Map<String,String>	getheaders()	Get all headers from the response
String	getProtocolVersion()
int	getStatusCode()
String	getStatusLine()
String	getStatusMessage()
static HttpClientResponse<Object>	jaxbResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse, boolean contentOnBadResponse, Class<?>... responseTypes)	Create an HttpClientResponse with an Object content type from an HttpResponse.
static HttpClientResponse<Object>	jaxbResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse, Class<?>... responseTypes)	Create an HttpClientResponse with an Object content type from an HttpResponse.
static HttpClientResponse<Object>	jaxbResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse, boolean contentOnBadResponse, Class<?>... responseTypes)	Deprecated. This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse).
static HttpClientResponse<Object>	jaxbResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse, Class<?>... responseTypes)	Deprecated. This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse).
static HttpClientResponse<com.google.gson.JsonObject>	jsonResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse)	Create an HttpClientResponse with a com.google.gson.JsonObject content type from an HttpResponse.
static HttpClientResponse<com.google.gson.JsonObject>	jsonResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse, boolean contentOnBadResponse)	Create an HttpClientResponse with a com.google.gson.JsonObject content type from an HttpResponse.
static HttpClientResponse<com.google.gson.JsonObject>	jsonResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse)	Deprecated. This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse).
static HttpClientResponse<com.google.gson.JsonObject>	jsonResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse, boolean contentOnBadResponse)	Deprecated. This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse).
protected void	populateGenericValues(org.apache.hc.core5.http.HttpResponse httpResponse)
protected void	populateGenericValues(org.apache.http.client.methods.CloseableHttpResponse httpResponse)	Deprecated. This method uses the deprecated Apache HttpClient 4 API.
protected void	setContent(T content)
static HttpClientResponse<String>	textResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse)	Create an HttpClientResponse with a String content type from an HttpResponse.
static HttpClientResponse<String>	textResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse, boolean contentOnBadResponse)	Create an HttpClientResponse with a String content type from an HttpResponse.
static HttpClientResponse<Document>	xmlResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse)	Create an HttpClientResponse with a Document content type from an HttpResponse.
static HttpClientResponse<Document>	xmlResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse, boolean contentOnBadResponse)	Create an HttpClientResponse with a Document content type from an HttpResponse.
static HttpClientResponse<Document>	xmlResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse)	Deprecated. This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse).
static HttpClientResponse<Document>	xmlResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse, boolean contentOnBadResponse)	Deprecated. This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse).

Methods inherited from class java.lang.Object

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

Method Details

getStatusCode

public int getStatusCode()

Returns:

- status code of the response

getStatusMessage

public String getStatusMessage()

Returns:

- reason phrase or status message of the response

getProtocolVersion

public String getProtocolVersion()

Returns:

- protocol version string of the response

getStatusLine

public String getStatusLine()

Returns:

- full status line

setContent

protected void setContent(T content)

getContent

public T getContent()

Returns:

- the content of the response

getHeader

public Object getHeader(String header)

Get the value of a specific header as a String. May be null

Parameters:

header -

Returns:

- the value of the header

getheaders

public Map<String,String> getheaders()

Get all headers from the response

Returns:

- map of headers and values

populateGenericValues

protected void populateGenericValues(org.apache.hc.core5.http.HttpResponse httpResponse)

byteResponse

public static HttpClientResponse<byte[]> byteResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse)
                                               throws HttpClientException

Create an HttpClientResponse with a byte array content type from an HttpResponse.

Parameters:

httpResponse -

Returns:

- HttpClientResponse with a byte array content type

Throws:

HttpClientException

byteResponse

public static HttpClientResponse<byte[]> byteResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse,
 boolean contentOnBadResponse)
                                               throws HttpClientException

Create an HttpClientResponse with a byte array content type from an HttpResponse. If contentOnBadResponse is true, an attempt will be made to retrieve the content even on a non 200 status code, otherwise the content will be null in such an instance.

Parameters:

httpResponse -

contentOnBadResponse -

Returns:

- HttpClientResponse with a byte array content type

Throws:

HttpClientException

textResponse

public static HttpClientResponse<String> textResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse)
                                               throws HttpClientException

Create an HttpClientResponse with a String content type from an HttpResponse.

Parameters:

httpResponse -

Returns:

- HttpClientResponse with a String content type

Throws:

HttpClientException

textResponse

public static HttpClientResponse<String> textResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse,
 boolean contentOnBadResponse)
                                               throws HttpClientException

Create an HttpClientResponse with a String content type from an HttpResponse. If contentOnBadResponse is true, an attempt will be made to retrieve the content even on a non 200 status code, otherwise the content will be null in such an instance.

Parameters:

httpResponse -

contentOnBadResponse -

Returns:

- HttpClientResponse with a String content type

Throws:

HttpClientException

jsonResponse

public static HttpClientResponse<com.google.gson.JsonObject> jsonResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse)
                                                                   throws HttpClientException

Create an HttpClientResponse with a com.google.gson.JsonObject content type from an HttpResponse.

Parameters:

httpResponse -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

jsonResponse

public static HttpClientResponse<com.google.gson.JsonObject> jsonResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse,
 boolean contentOnBadResponse)
                                                                   throws HttpClientException

Create an HttpClientResponse with a com.google.gson.JsonObject content type from an HttpResponse. If contentOnBadResponse is true, an attempt will be made to retrieve the content even on a non 200 status code, otherwise the content will be null in such an instance.

Parameters:

httpResponse -

contentOnBadResponse -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

xmlResponse

public static HttpClientResponse<Document> xmlResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse)
                                                throws HttpClientException

Create an HttpClientResponse with a Document content type from an HttpResponse.

Parameters:

httpResponse -

Returns:

- HttpClientResponse with a Document content type

Throws:

HttpClientException

xmlResponse

public static HttpClientResponse<Document> xmlResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse,
 boolean contentOnBadResponse)
                                                throws HttpClientException

Create an HttpClientResponse with a Document content type from an HttpResponse. If contentOnBadResponse is true, an attempt will be made to retrieve the content even on a non 200 status code, otherwise the content will be null in such an instance.

Parameters:

httpResponse -

contentOnBadResponse -

Returns:

- HttpClientResponse with a Document content type

Throws:

HttpClientException

jaxbResponse

public static HttpClientResponse<Object> jaxbResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse,
 Class<?>... responseTypes)
                                               throws HttpClientException

Create an HttpClientResponse with an Object content type from an HttpResponse. The object returned will be an instance of one of the JAXB classes provided in responseTypes. If the response did not contain a status code 200 (OK), the content will be null.

Parameters:

httpResponse -

responseTypes -

Returns:

- HttpClientResponse with an Object content type

Throws:

HttpClientException

jaxbResponse

public static HttpClientResponse<Object> jaxbResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse,
 boolean contentOnBadResponse,
 Class<?>... responseTypes)
                                               throws HttpClientException

Create an HttpClientResponse with an Object content type from an HttpResponse. The object returned will be an instance of one of the JAXB classes provided in responseTypes. If contentOnBadResponse is true, an attempt will be made to retrieve the content even on a non 200 status code, otherwise the content will be null in such an instance.

Parameters:

httpResponse -

contentOnBadResponse -

responseTypes -

Returns:

- HttpClientResponse with an Object content type

Throws:

HttpClientException

populateGenericValues

@Deprecated
protected void populateGenericValues(org.apache.http.client.methods.CloseableHttpResponse httpResponse)

Deprecated.

This method uses the deprecated Apache HttpClient 4 API. It will be removed in a future release. Internal use only.

jsonResponse

@Deprecated
public static HttpClientResponse<com.google.gson.JsonObject> jsonResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse)
                                                                   throws HttpClientException

Deprecated.

This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse). Use the overloaded method that accepts ClassicHttpResponse instead. This method will be removed in a future release.

Create an HttpClientResponse with a com.google.gson.JsonObject content type from an HttpResponse.

Parameters:

httpResponse -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

jsonResponse

@Deprecated
public static HttpClientResponse<com.google.gson.JsonObject> jsonResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse,
 boolean contentOnBadResponse)
                                                                   throws HttpClientException

Deprecated.

This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse). Use the overloaded method that accepts ClassicHttpResponse instead. This method will be removed in a future release.

Create an HttpClientResponse with a com.google.gson.JsonObject content type from an HttpResponse. If contentOnBadResponse is true, an attempt will be made to retrieve the content even on a non 200 status code, otherwise the content will be null in such an instance.

Parameters:

httpResponse -

contentOnBadResponse -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

xmlResponse

@Deprecated
public static HttpClientResponse<Document> xmlResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse)
                                                throws HttpClientException

Deprecated.

This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse). Use the overloaded method that accepts ClassicHttpResponse instead. This method will be removed in a future release.

Create an HttpClientResponse with a Document content type from an HttpResponse.

Parameters:

httpResponse -

Returns:

- HttpClientResponse with a Document content type

Throws:

HttpClientException

xmlResponse

@Deprecated
public static HttpClientResponse<Document> xmlResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse,
 boolean contentOnBadResponse)
                                                throws HttpClientException

Deprecated.

This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse). Use the overloaded method that accepts ClassicHttpResponse instead. This method will be removed in a future release.

Create an HttpClientResponse with a Document content type from an HttpResponse. If contentOnBadResponse is true, an attempt will be made to retrieve the content even on a non 200 status code, otherwise the content will be null in such an instance.

Parameters:

httpResponse -

contentOnBadResponse -

Returns:

- HttpClientResponse with a Document content type

Throws:

HttpClientException

jaxbResponse

@Deprecated
public static HttpClientResponse<Object> jaxbResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse,
 Class<?>... responseTypes)
                                               throws HttpClientException

Deprecated.

This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse). Use the overloaded method that accepts ClassicHttpResponse instead. This method will be removed in a future release.

Create an HttpClientResponse with an Object content type from an HttpResponse. The object returned will be an instance of one of the JAXB classes provided in responseTypes. If the response did not contain a status code 200 (OK), the content will be null.

Parameters:

httpResponse -

responseTypes -

Returns:

- HttpClientResponse with an Object content type

Throws:

HttpClientException

jaxbResponse

@Deprecated
public static HttpClientResponse<Object> jaxbResponse(org.apache.http.client.methods.CloseableHttpResponse httpResponse,
 boolean contentOnBadResponse,
 Class<?>... responseTypes)
                                               throws HttpClientException

Deprecated.

This method uses the deprecated Apache HttpClient 4 API (CloseableHttpResponse). Use the overloaded method that accepts ClassicHttpResponse instead. This method will be removed in a future release.

Create an HttpClientResponse with an Object content type from an HttpResponse. The object returned will be an instance of one of the JAXB classes provided in responseTypes. If contentOnBadResponse is true, an attempt will be made to retrieve the content even on a non 200 status code, otherwise the content will be null in such an instance.

Parameters:

httpResponse -

contentOnBadResponse -

responseTypes -

Returns:

- HttpClientResponse with an Object content type

Throws:

HttpClientException