uk.co.visalia.brightpearl.apiclient.http

Class Response

java.lang.Object

uk.co.visalia.brightpearl.apiclient.http.Response

public final class Response
extends Object

Contains the basic details of an HTTP response received from the Brightpearl API. Client implementations must return instances with all properties set, except when the HTTP request fails with a transport error, in which case a BrightpearlHttpException should be thrown.

Instances are immutable and may be constructed using ResponseBuilder.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getBody() Returns the JSON response body.
String	getHeader(String key) A utility method that looks up the value of a named header.
Map<String,String>	getHeaders() Returns the response headers.
int	getStatus() Returns the HTTP status of the response.
long	getTimestamp() Returns the timestamp this response instance was created.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getStatus

public int getStatus()

Returns the HTTP status of the response.

Returns:

HTTP response status.

getHeaders

public Map<String,String> getHeaders()

Returns the response headers. All headers should be included.

Returns:

response headers.

getBody

public String getBody()

Returns the JSON response body.

Returns:

unparsed JSON string.

getTimestamp

public long getTimestamp()

Returns the timestamp this response instance was created. This indicates the age of the response and may be used for caching.

Returns:

response timestamp.

getHeader

public String getHeader(String key)

A utility method that looks up the value of a named header.

Parameters:

key - Header name to look up.

Returns:

value of the header if it was present in the response, null if not.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object