io.sphere.sdk.client.retry

Class RetryableSphereClientBuilder

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.client.retry.RetryableSphereClientBuilder

public final class RetryableSphereClientBuilder
extends Base

To create a Sphere Client with retry logic which computes a exponential backoff time delay in milliseconds. And handle all the configurations for the creation of client.

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	DEFAULT_INITIAL_RETRY_DELAY
protected static long	DEFAULT_MAX_DELAY
protected static int	DEFAULT_MAX_PARALLEL_REQUESTS
protected static int	DEFAULT_MAX_RETRY_ATTEMPT

Method Summary

Modifier and Type	Method and Description
SphereClient	build() creates a SphereClient using the class configuration values.
protected SphereClient	decorateSphereClient(SphereClient underlyingClient, RetryAction retryAction, int maxParallelRequests)
static RetryableSphereClientBuilder	of(SphereClientConfig sphereClientConfig, HttpClient httpClient) Creates a new instance of RetryableSphereClientBuilder given a SphereClientConfig responsible for creation of a SphereClient.
RetryableSphereClientBuilder	withInitialDelay(long initialDelay) Sets the initialDelay value in milliseconds.
RetryableSphereClientBuilder	withMaxDelay(long maxDelay) Sets the maxDelay value value in milliseconds.
RetryableSphereClientBuilder	withMaxParallelRequests(int maxParallelRequests) Sets the Max Parallel Requests value, It should be always positive number.
RetryableSphereClientBuilder	withMaxRetryAttempt(int maxRetryAttempt) Sets the Max Retry value, It should be greater than 1 for the Retry attempt.
RetryableSphereClientBuilder	withStatusCodesToRetry(List<Integer> statusCodesToRetry) Sets the Retry Error Status Codes.

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_MAX_DELAY

protected static final long DEFAULT_MAX_DELAY

See Also:

Constant Field Values

DEFAULT_INITIAL_RETRY_DELAY

protected static final long DEFAULT_INITIAL_RETRY_DELAY

See Also:

Constant Field Values

DEFAULT_MAX_RETRY_ATTEMPT

protected static final int DEFAULT_MAX_RETRY_ATTEMPT

See Also:

Constant Field Values

DEFAULT_MAX_PARALLEL_REQUESTS

protected static final int DEFAULT_MAX_PARALLEL_REQUESTS

See Also:

Constant Field Values

Method Detail

of

public static RetryableSphereClientBuilder of(@Nonnull
                                              SphereClientConfig sphereClientConfig,
                                              @Nonnull
                                              HttpClient httpClient)

Creates a new instance of RetryableSphereClientBuilder given a SphereClientConfig responsible for creation of a SphereClient.

Parameters:

sphereClientConfig - the client configuration for the client.

httpClient - client to execute requests

Returns:

the instantiated RetryableSphereClientBuilder.

withMaxDelay

public RetryableSphereClientBuilder withMaxDelay(long maxDelay)

Sets the maxDelay value value in milliseconds.

Parameters:

maxDelay - - build with maxDelay value.

Returns:

RetryableSphereClientBuilder with given maxDelay value.

withInitialDelay

public RetryableSphereClientBuilder withInitialDelay(long initialDelay)

Sets the initialDelay value in milliseconds.

Parameters:

initialDelay - - build with initialDelay value. If initialDelay is equal or greater than maxDelay then, a IllegalArgumentException will be thrown.

Returns:

RetryableSphereClientBuilder with given initialDelay value.

withMaxRetryAttempt

public RetryableSphereClientBuilder withMaxRetryAttempt(int maxRetryAttempt)

Sets the Max Retry value, It should be greater than 1 for the Retry attempt.

Parameters:

maxRetryAttempt - - build with maxRetries value. If maxRetryAttempt is less than 1 then, a IllegalArgumentException will be thrown.

Returns:

RetryableSphereClientBuilder with given maxRetries value.

withMaxParallelRequests

public RetryableSphereClientBuilder withMaxParallelRequests(int maxParallelRequests)

Sets the Max Parallel Requests value, It should be always positive number.

Parameters:

maxParallelRequests - - build with maxParallelRequests value. If maxParallelRequests is less than 1 then, a IllegalArgumentException will be thrown.

Returns:

RetryableSphereClientBuilder with given maxParallelRequests value.

withStatusCodesToRetry

public RetryableSphereClientBuilder withStatusCodesToRetry(List<Integer> statusCodesToRetry)

Sets the Retry Error Status Codes.

Parameters:

statusCodesToRetry - - build with retryErrorStatusCodes.

Returns:

RetryableSphereClientBuilder with given retryErrorStatusCodes.

build

public SphereClient build()

creates a SphereClient using the class configuration values.

Returns:

the instantiated SphereClient

decorateSphereClient

protected SphereClient decorateSphereClient(@Nonnull
                                            SphereClient underlyingClient,
                                            @Nonnull
                                            RetryAction retryAction,
                                            int maxParallelRequests)