io.sphere.sdk.client

Class TimeoutSphereClientDecorator

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.client.SphereClientDecorator

io.sphere.sdk.client.TimeoutSphereClientDecorator

All Implemented Interfaces:

SphereClient, AutoCloseable

public final class TimeoutSphereClientDecorator
extends SphereClientDecorator
implements SphereClient

Wraps a SphereClient to add timeouts. There are no guarantees that the timeout will be after the exact duration. The underlying HTTP client most likely will have a timeout and you may consider to implement it there. If the timeout occurs a SphereTimeoutException will be thrown.

Method Summary

Modifier and Type	Method and Description
void	close() Shuts down the client to save resources like connections and threads.
<T> CompletionStage<T>	execute(SphereRequest<T> sphereRequest) Executes asynchronously a request to Composable Commerce.
static SphereClient	of(SphereClient delegate, Duration duration)
static SphereClient	of(SphereClient delegate, long delay, TimeUnit timeUnit)

Methods inherited from class io.sphere.sdk.client.SphereClientDecorator

getConfig

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

Methods inherited from interface io.sphere.sdk.client.SphereClient

getConfig, of, of

Method Detail

of

public static SphereClient of(SphereClient delegate,
                              long delay,
                              TimeUnit timeUnit)

of

public static SphereClient of(SphereClient delegate,
                              Duration duration)

execute

public <T> CompletionStage<T> execute(SphereRequest<T> sphereRequest)

Description copied from interface: SphereClient

Executes asynchronously a request to Composable Commerce. By default it does not have a timeout.

Specified by:

execute in interface SphereClient

Overrides:

execute in class SphereClientDecorator

Type Parameters:

T - type of the result for the request

Parameters:

sphereRequest - request to Composable Commerce to perform

Returns:

future monad which can contain the result or an exception

close

public void close()

Description copied from interface: SphereClient

Shuts down the client to save resources like connections and threads.

Specified by:

close in interface SphereClient

Specified by:

close in interface AutoCloseable

Overrides:

close in class SphereClientDecorator