uk.co.visalia.brightpearl.apiclient.config

Class RequestCapStrategy

java.lang.Object

uk.co.visalia.brightpearl.apiclient.config.RequestCapStrategy

public class RequestCapStrategy
extends Object

Defines the strategy BrightpearlApiClient should use when a request cap error is received from the Brightpearl API, in terms on the number of retries and wait between them. With a non-zero retryAttempts value, all requests will be blocked while the first to fail is repeated until it succeeds. All waiting requests are then sent.

See Also:

http://www.brightpearl.com/developer/latest/concept/request-throttling.html

Field Summary

Fields

Modifier and Type	Field and Description
static RequestCapStrategy	FAIL Fail strategy: Do not attempt to repeat requests until they succeed; throw an exception for every failure.
static RequestCapStrategy	RETRY Default retry configuration: Make one attempt every 15 seconds and fail if 5 successive retries are blocked by the request cap.

Method Summary

Methods

Modifier and Type	Method and Description
int	getRetryAttempts() For a retry strategy, returns the number of attempts that will be made to retry a request before aborting.
long	getRetryWait() For a retry strategy, returns the wait period between attempts.
static RequestCapStrategy	retry(int retryAttempts, long retryWait) Constructs a retry strategy with a custom number of retry attempts and wait period in ms.

Methods inherited from class java.lang.Object

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

Field Detail

RETRY

public static RequestCapStrategy RETRY

Default retry configuration: Make one attempt every 15 seconds and fail if 5 successive retries are blocked by the request cap.

FAIL

public static RequestCapStrategy FAIL

Fail strategy: Do not attempt to repeat requests until they succeed; throw an exception for every failure.

Method Detail

retry

public static RequestCapStrategy retry(int retryAttempts,
                       long retryWait)

Constructs a retry strategy with a custom number of retry attempts and wait period in ms. The product of the two numbers should be at least 60,000 (60 seconds) to guarantee that retry will eventually succeed, subject to Brightpearl's API following the stated behaviour.

Parameters:

retryAttempts -

retryWait -

Returns:

getRetryAttempts

public int getRetryAttempts()

For a retry strategy, returns the number of attempts that will be made to retry a request before aborting. For a fail strategy this is zero.

Returns:

the number of retry attempts allowed.

getRetryWait

public long getRetryWait()

For a retry strategy, returns the wait period between attempts. For a fail strategy this is zero and has no meaning.

Returns:

the wait between retries.