uk.co.visalia.brightpearl.apiclient.request

Class ServiceReadRequestBuilder<T>

java.lang.Object

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

Type Parameters:

T - placeholder for the response type, used to avoid casting of responses. This is not linked to the Type set on a request so a ClassCastException is possible if the type is set incorrectly.

public class ServiceReadRequestBuilder<T>
extends Object

A factory for immutable ServiceReadRequest instances. Static methods provide GET and OPTIONS requests configured with the minimum fields needed to execute a request, and chaining methods are available to set additional attributes on the request before an immutable instance is build with build().

Method Summary

Methods

Modifier and Type	Method and Description
ServiceReadRequest<T>	build() Builds an immutable request instance from values provided to this builder.
protected Method	getMethod()
protected Map<String,String>	getParams()
protected String	getPath()
protected Type	getResponseType()
protected String	getRuid()
protected ServiceName	getService()
protected ServiceReadRequestBuilder<T>	getThis()
static <T> ServiceReadRequestBuilder<T>	newGetRequest(ServiceName service, String path, Class<T> responseType) Creates a new GET request builder configured with the URL to call and expected response type.
static <T> ServiceReadRequestBuilder<T>	newGetRequest(ServiceName service, String path, Type responseType) Creates a new GET request builder configured with the URL to call and expected response type.
static <T> ServiceReadRequestBuilder<T>	newOptionsRequest(ServiceName service, String path, Class<T> responseType) Creates a new OPTIONS request builder configured with the URL to call and expected response type.
static <T> ServiceReadRequestBuilder<T>	newOptionsRequest(ServiceName service, String path, Type responseType) Creates a new OPTIONS request builder configured with the URL to call and expected response type.
B	withAddedParam(String name, String value) Add an additional unencoded querystring parameter to be added to the request, preserving the existing set but overwriting any param with the same name.
B	withAddedParams(Map<String,String> params) Add additional unencoded querystring parameters to be added to the request, preserving the existing set but overwriting any param with the same names.
B	withParams(Map<String,String> params) Add querystring parameters to the request, replacing any previously set.
B	withPath(String path) Set the path of the Brightpearl resource within the service provided to withService(ServiceName).
B	withResponseType(Type responseType) Set the generic type token representing the expected type of the response element in the JSON response body.
B	withRuid(String ruid) Set a unique identifier for the request.
B	withService(ServiceName service) 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

getThis

protected ServiceReadRequestBuilder<T> getThis()

newGetRequest

public static <T> ServiceReadRequestBuilder<T> newGetRequest(ServiceName service,
                                             String path,
                                             Class<T> responseType)

Creates a new GET request builder configured with the URL to call and expected response type. This method does not support extraction of generic types but is able to infer the type parameter <T>.

Type Parameters:

T - placeholder for the response type, used to avoid casting of responses.

Parameters:

service - Brightpearl service that contains the resource.

path - path to the search resource, for example '/product'.

responseType - type of result expected in the 'response' element of the JSON response body. Use Void or null if no response is expected, or the response is not required.

Returns:

an OPTIONS request builder instance.

newGetRequest

public static <T> ServiceReadRequestBuilder<T> newGetRequest(ServiceName service,
                                             String path,
                                             Type responseType)

Creates a new GET request builder configured with the URL to call and expected response type. This method supports extraction of generic types (e.g. typed lists or maps) from the response element.

Type Parameters:

T - placeholder for the response type, used to avoid casting of responses.

Parameters:

service - Brightpearl service that contains the resource.

path - path to the search resource, for example '/product'.

responseType - type of result expected in the 'response' element of the JSON response body. Use Void or null if no response is expected, or the response is not required.

Returns:

A GET request builder instance.

newOptionsRequest

public static <T> ServiceReadRequestBuilder<T> newOptionsRequest(ServiceName service,
                                                 String path,
                                                 Class<T> responseType)

Creates a new OPTIONS request builder configured with the URL to call and expected response type. This method does not support extraction of generic types but is able to infer the type parameter <T>.

Type Parameters:

T - placeholder for the response type, used to avoid casting of responses.

Parameters:

service - Brightpearl service that contains the resource.

path - path to the search resource, for example '/product'.

responseType - type of result expected in the 'response' element of the JSON response body. Use Void or null if no response is expected, or the response is not required.

Returns:

an OPTIONS request builder instance.

newOptionsRequest

public static <T> ServiceReadRequestBuilder<T> newOptionsRequest(ServiceName service,
                                                 String path,
                                                 Type responseType)

Creates a new OPTIONS request builder configured with the URL to call and expected response type. This method supports extraction of generic types (e.g. typed lists or maps) from the response element.

Type Parameters:

T - placeholder for the response type, used to avoid casting of responses.

Parameters:

service - Brightpearl service that contains the resource.

path - path to the search resource, for example '/product'.

responseType - type of result expected in the 'response' element of the JSON response body. Use Void or null if no response is expected, or the response is not required.

Returns:

A OPTIONS request builder instance.

build

public ServiceReadRequest<T> build()

Builds an immutable request instance from values provided to this builder.

Returns:

immutable request instance.

withRuid

public B withRuid(String ruid)

Set a unique identifier for the request. All requests are given a unique identifier automatically, for use in logging and as a label for a request contained in a multimessage, and this method may be used to override it with a custom ID.

Note this RUID is applied only to the first request built by this builder; if you call build() more than once, the second and subsequent requests will have randomly generated IDs unless you also call this method between each invocation.

Parameters:

ruid - the custom unique identifier to use.

Returns:

builder instance for method chaining.

withService

public B withService(ServiceName service)

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

Parameters:

service - service containing the target resource.

Returns:

builder instance for method chaining.

withPath

public B withPath(String path)

Set the path of the Brightpearl resource within the service provided to withService(ServiceName). For example, for the product GET API, this would be '/product'.

Parameters:

path - the path to be set.

Returns:

builder instance for method chaining.

withResponseType

public B withResponseType(Type responseType)

Set the 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.

Parameters:

responseType - the type to set.

Returns:

builder instance for method chaining.

withAddedParam

public B withAddedParam(String name,
               String value)

Add an additional unencoded querystring parameter to be added to the request, preserving the existing set but overwriting any param with the same name.

Parameters:

name - parameter name.

value - parameter value.

Returns:

builder instance for method chaining.

withAddedParams

public B withAddedParams(Map<String,String> params)

Add additional unencoded querystring parameters to be added to the request, preserving the existing set but overwriting any param with the same names.

Parameters:

params - map of querystring params.

Returns:

builder instance for method chaining.

withParams

public B withParams(Map<String,String> params)

Add querystring parameters to the request, replacing any previously set.

Parameters:

params - map of querystring params.

Returns:

builder instance for method chaining.

getRuid

protected String getRuid()

getService

protected ServiceName getService()

getMethod

protected Method getMethod()

getPath

protected String getPath()

getResponseType

protected Type getResponseType()

getParams

protected Map<String,String> getParams()