uk.co.visalia.brightpearl.apiclient.http.httpclient4

Class HttpClient4ClientFactoryBuilder

java.lang.Object

uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder

public final class HttpClient4ClientFactoryBuilder
extends Object

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

 <bean id="httpClient4ClientFactoryBuilder" class="HttpClient4ClientFactoryBuilder">
     <property name="maxConnections">20</property>
 </bean>

 <bean id="httpClient4ClientFactory"
     factory-bean="httpClient4ClientFactoryBuilder"
     factory-method="build"/>
 

See static fields of HttpClient4ClientFactory for the default settings applied if methods in this builder are not used to override them.

Constructor Summary

Constructors

Constructor and Description
HttpClient4ClientFactoryBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
HttpClient4ClientFactory	build() Builds an immutable HttpClient4ClientFactory instance with the configuration supplied.
static HttpClient4ClientFactoryBuilder	httpClient4ClientFactory() Static builder method for method chaining, fluent builder style.
void	setAllowRedirects(boolean allowRedirects) Set whether redirects should be followed.
void	setConnectionManagerTimeoutMs(int connectionManagerTimeoutMs) Sets the connection manager timeout in milliseconds.
void	setConnectionTimeoutMs(int connectionTimeoutMs) Set the time in milliseconds to wait for a connection to be established before aborting the request.
void	setMaxConnections(int maxConnections) Set the maximum total connections allowed across all routes.
void	setMaxConnectionsPerRoute(int maxConnectionsPerRoute) Set the maximum connections allowed per route.
void	setSocketTimeoutMs(int socketTimeoutMs) Maximum time of inactivity to allow between two consecutive data packets from the server before aborting the request.
HttpClient4ClientFactoryBuilder	withAllowRedirects(boolean allowRedirects) Set whether redirects should be followed.
HttpClient4ClientFactoryBuilder	withConnectionManagerTimeoutMs(int connectionManagerTimeoutMs) Sets the connection manager timeout in milliseconds.
HttpClient4ClientFactoryBuilder	withConnectionTimeoutMs(int connectionTimeoutMs) Set the time in milliseconds to wait for a connection to be established before aborting the request.
HttpClient4ClientFactoryBuilder	withMaxConnections(int maxConnections) Set the maximum total connections allowed across all routes.
HttpClient4ClientFactoryBuilder	withMaxConnectionsPerRoute(int maxConnectionsPerRoute) Set the maximum connections allowed per route.
HttpClient4ClientFactoryBuilder	withSocketTimeoutMs(int socketTimeoutMs) Maximum time of inactivity to allow between two consecutive data packets from the server before aborting the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClient4ClientFactoryBuilder

public HttpClient4ClientFactoryBuilder()

Method Detail

httpClient4ClientFactory

public static HttpClient4ClientFactoryBuilder httpClient4ClientFactory()

Static builder method for method chaining, fluent builder style.

Returns:

a new HttpClient4ClientFactoryBuilder instance.

setMaxConnections

public void setMaxConnections(int maxConnections)

Set the maximum total connections allowed across all routes. If creating a client for use with multiple Brightpearl customer accounts there will be one route per datacenter.

Parameters:

maxConnections - maximum total connections allowed for all routes.

setMaxConnectionsPerRoute

public void setMaxConnectionsPerRoute(int maxConnectionsPerRoute)

Set the maximum connections allowed per route. All Brightpearl customer accounts on a datacenter will share the same route, so this is not a per-account limit.

Parameters:

maxConnectionsPerRoute - maximum connections allowed per route.

setConnectionManagerTimeoutMs

public void setConnectionManagerTimeoutMs(int connectionManagerTimeoutMs)

Sets the connection manager timeout in milliseconds. This is the time a thread will wait for a connection to become free when the connection pool is exhausted. Use zero for indefinite blocking.

Parameters:

connectionManagerTimeoutMs - connection manager timeout in milliseconds.

setConnectionTimeoutMs

public void setConnectionTimeoutMs(int connectionTimeoutMs)

Set the time in milliseconds to wait for a connection to be established before aborting the request. A value of zero is interpreted as infinite timeout.

Parameters:

connectionTimeoutMs - connection timeout in milliseconds.

setSocketTimeoutMs

public void setSocketTimeoutMs(int socketTimeoutMs)

Maximum time of inactivity to allow between two consecutive data packets from the server before aborting the request. A value of zero is interpreted as an infinite timeout.

Parameters:

socketTimeoutMs - socket timeout in milliseconds.

setAllowRedirects

public void setAllowRedirects(boolean allowRedirects)

Set whether redirects should be followed. Redirects are not expected from the Brightpearl API according to the documentation provided, and this setting is untested.

Parameters:

allowRedirects - whether redirects should be followed.

withMaxConnections

public HttpClient4ClientFactoryBuilder withMaxConnections(int maxConnections)

Set the maximum total connections allowed across all routes. If creating a client for use with multiple Brightpearl customer accounts there will be one route per datacenter.

Parameters:

maxConnections - maximum total connections allowed for all routes.

Returns:

builder instance for method chaining.

withMaxConnectionsPerRoute

public HttpClient4ClientFactoryBuilder withMaxConnectionsPerRoute(int maxConnectionsPerRoute)

Set the maximum connections allowed per route. All Brightpearl customer accounts on a datacenter will share the same route, so this is not a per-account limit.

Parameters:

maxConnectionsPerRoute - maximum connections allowed per route.

Returns:

builder instance for method chaining.

withConnectionManagerTimeoutMs

public HttpClient4ClientFactoryBuilder withConnectionManagerTimeoutMs(int connectionManagerTimeoutMs)

Sets the connection manager timeout in milliseconds. This is the time a thread will wait for a connection to become free when the connection pool is exhausted.

Parameters:

connectionManagerTimeoutMs - connection manager timeout in milliseconds.

Returns:

builder instance for method chaining.

withConnectionTimeoutMs

public HttpClient4ClientFactoryBuilder withConnectionTimeoutMs(int connectionTimeoutMs)

Set the time in milliseconds to wait for a connection to be established before aborting the request. A value of zero is interpreted as infinite timeout.

Parameters:

connectionTimeoutMs - connection timeout in milliseconds.

Returns:

builder instance for method chaining.

withSocketTimeoutMs

public HttpClient4ClientFactoryBuilder withSocketTimeoutMs(int socketTimeoutMs)

Maximum time of inactivity to allow between two consecutive data packets from the server before aborting the request. A value of zero is interpreted as an infinite timeout.

Parameters:

socketTimeoutMs - socket timeout in milliseconds.

Returns:

builder instance for method chaining.

withAllowRedirects

public HttpClient4ClientFactoryBuilder withAllowRedirects(boolean allowRedirects)

Set whether redirects should be followed. Redirects are not expected from the Brightpearl API according to the documentation provided, and this setting is untested.

Parameters:

allowRedirects - whether redirects should be followed.

Returns:

builder instance for method chaining.

build

public HttpClient4ClientFactory build()

Builds an immutable HttpClient4ClientFactory instance with the configuration supplied.

Returns:

a HttpClient4ClientFactory instance.