uk.co.visalia.brightpearl.apiclient.request

Class AbstractServiceRequest<T>

java.lang.Object

uk.co.visalia.brightpearl.apiclient.request.AbstractServiceRequest<T>

Type Parameters:

T - A placeholder for the type expected in the response, avoiding the requirement to cast responses. This is not linked to the Type set on a request so a ClassCastException is possible if the type is set incorrectly.

Direct Known Subclasses:

ServiceReadRequest, ServiceWriteRequest

public abstract class AbstractServiceRequest<T>
extends Object

This is the superclass for read and write request classes, providing the functionality common to both. It is only intended for use internally so has a package private constructor.

Requests are split into read requests (including searches) and write requests because write requests can be included in multimessages and read requests cannot, and because read requests can be cached and write requests cannot.

Method Summary

Methods

Modifier and Type	Method and Description
Method	getMethod() The HTTP method of the request.
Map<String,String>	getParams() Querystring parameters to be added to the URL.
String	getPath() Returns the path of the Brightpearl resource within the service given by getService().
Type	getResponseType() A generic type token representing the expected type of the response element in the JSON response body.
String	getRuid() A unique identifier for the request.
ServiceName	getService() Returns the name of the Brightpearl service that contains the resource to be called.

Methods inherited from class java.lang.Object

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

Method Detail

getRuid

public String getRuid()

A unique identifier for the request. This is used as the label for the request when it is sent in a multimessage, and is also useful for logging. A unique ID is generated internally if a custom ID is not supplied.

Returns:

unique ID of the request.

getMethod

public Method getMethod()

The HTTP method of the request.

Returns:

HTTP method.

getService

public ServiceName getService()

Returns the name of the Brightpearl service that contains the resource to be called.

Returns:

service name.

getPath

public String getPath()

Returns the path of the Brightpearl resource within the service given by getService(). For example, for the product GET API, this would be '/product'.

Returns:

the resource path.

getResponseType

public Type getResponseType()

A generic type token representing the expected type of the response element in the JSON response body. This is used by the client to deserialise the response, so if it does not match the expected response an exception may be thrown or an empty object returned. Type is used instead of Class to provide support for deserialising generic types e.g. collections and maps, however this does mean the type is not guaranteed to match the type token T, which is used to avoid casting responses.

Returns:

the response type expected.

getParams

public Map<String,String> getParams()

Querystring parameters to be added to the URL. Parameters are sometimes used to request additional data sections in the response, and for filtering, sorting and column selection in resource searches.

Returns:

unencoded querystring parameters.