uk.co.visalia.brightpearl.apiclient.http

Class Request

java.lang.Object

uk.co.visalia.brightpearl.apiclient.http.Request

public final class Request
extends Object

Contains the basic details of an HTTP request to be executed by a Client in a generic form that can be supported by any implementation. Immutable instances are created using RequestBuilder.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getBody() JSON request body for inclusion in PUT and POST requests.
Map<String,String>	getHeaders() HTTP headers for addition to the request.
Method	getMethod() The HTTP method.
Map<String,String>	getParameters() Parameters for addition to the URL querystring.
String	getUrl() The full URL of a Brightpearl API resource.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getMethod

public Method getMethod()

The HTTP method.

Returns:

the HTTP method.

getUrl

public String getUrl()

The full URL of a Brightpearl API resource.

Returns:

URL to be called.

getBody

public String getBody()

JSON request body for inclusion in PUT and POST requests.

Returns:

JSON request body.

getParameters

public Map<String,String> getParameters()

Parameters for addition to the URL querystring. The map will contain raw values, and the Client is responsible for encoding them.

Returns:

map of querystring parameters.

getHeaders

public Map<String,String> getHeaders()

HTTP headers for addition to the request. These will include the authentication token. The map will contain raw values, and the Client is responsible for encoding them.

Returns:

map of request headers.

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