uk.co.visalia.brightpearl.apiclient

Class BrightpearlApiClientFactory

java.lang.Object

uk.co.visalia.brightpearl.apiclient.BrightpearlApiClientFactory

public final class BrightpearlApiClientFactory
extends Object

Constructs a configured BrightpearlApiClient. Supports construction in code using the builder pattern (starting with brightpearlApiClient()) and usage as a Spring bean factory. For example:

 <bean id="brightpearlApiClientFactory" class="BrightpearlApiClientFactory">
     <property name="clientFactory" ref="myClientFactory"/>
 </bean>

 <bean id="brightpearlApiClient"
     factory-bean="brightpearlApiClientFactory"
     factory-method="build"/>
 

Defaults are available for all the configuration options so there is no requirement to set any options before building the client instance.

Constructor Summary

Constructors

Constructor and Description
BrightpearlApiClientFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static BrightpearlApiClientFactory	brightpearlApiClient() Static builder method for method chaining, fluent builder style.
BrightpearlApiClient	build() Constructs the immutable BrightpearlApiClient with configuration options provided, using defaults for any not set.
void	setClientFactory(ClientFactory clientFactory) Set the ClientFactory that will supply Client instances for the execution of HTTP requests.
void	setGson(com.google.gson.Gson gson) Provide a custom GSON instance for serialising JSON request bodies and deserialising JSON responses.
void	setRateLimiter(RateLimiter rateLimiter) Set the RateLimiter implementation to be used for monitoring and limiting request throughput.
BrightpearlApiClientFactory	withClientFactory(ClientFactory clientFactory) Set the ClientFactory that will supply Client instances for the execution of HTTP requests.
BrightpearlApiClientFactory	withGson(com.google.gson.Gson gson) Provide a custom GSON instance for serialising JSON request bodies and deserialising JSON responses.
BrightpearlApiClientFactory	withRateLimiter(RateLimiter rateLimiter) Set the RateLimiter implementation to be used for monitoring and limiting request throughput.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrightpearlApiClientFactory

public BrightpearlApiClientFactory()

Method Detail

brightpearlApiClient

public static BrightpearlApiClientFactory brightpearlApiClient()

Static builder method for method chaining, fluent builder style.

Returns:

a new BrightpearlApiClientFactory instance.

build

public BrightpearlApiClient build()

Constructs the immutable BrightpearlApiClient with configuration options provided, using defaults for any not set.

Returns:

an immutable BrightpearlApiClient instance.

setClientFactory

public void setClientFactory(ClientFactory clientFactory)

Set the ClientFactory that will supply Client instances for the execution of HTTP requests. By default, an Apache HTTP Components implementation is used, with a dependency on org.apache.httpcomponents:httpclient:4.2.5. This may be replaced with another implementation when required.

Parameters:

clientFactory - custom client factory implementation.

setRateLimiter

public void setRateLimiter(RateLimiter rateLimiter)

Set the RateLimiter implementation to be used for monitoring and limiting request throughput. By default, a no-op implementation is used, which places no restrictions on the number of requests made.

Parameters:

rateLimiter - custom rate limiter implementation.

setGson

public void setGson(com.google.gson.Gson gson)

Provide a custom GSON instance for serialising JSON request bodies and deserialising JSON responses. A custom instance can support serialisation of types not used by the service package included in this client, for example Joda dates. The default GSON instance used has the default configuration, except for the addition of support for serialising Calendars as ISO dates.

Parameters:

gson - a custom configured GSON instance.

withClientFactory

public BrightpearlApiClientFactory withClientFactory(ClientFactory clientFactory)

Set the ClientFactory that will supply Client instances for the execution of HTTP requests. By default, an Apache HTTP Components implementation is used, with a dependency on org.apache.httpcomponents:httpclient:4.2.5. This may be replaced with another implementation when required.

Parameters:

clientFactory - custom client factory implementation.

Returns:

builder instance for method chaining.

withRateLimiter

public BrightpearlApiClientFactory withRateLimiter(RateLimiter rateLimiter)

Set the RateLimiter implementation to be used for monitoring and limiting request throughput. By default, a no-op implementation is used, which places no restrictions on the number of requests made.

Parameters:

rateLimiter - custom rate limiter implementation.

Returns:

builder instance for method chaining.

withGson

public BrightpearlApiClientFactory withGson(com.google.gson.Gson gson)

Provide a custom GSON instance for serialising JSON request bodies and deserialising JSON responses. A custom instance can support serialisation of types not used by the service package included in this client, for example Joda dates. The default GSON instance used has the default configuration, except for the addition of support for serialising Calendars as ISO dates.

Parameters:

gson - a custom configured GSON instance.

Returns:

builder instance for method chaining.