io.sphere.sdk.client

Interface SphereAccessTokenSupplier

All Superinterfaces:

AutoCloseable, Supplier<CompletionStage<String>>

public interface SphereAccessTokenSupplier
extends AutoCloseable, Supplier<CompletionStage<String>>

Provides an OAuth token for accessing protected Sphere HTTP API endpoints. There a no guarantees concerning the token providing mechanism.

See also TokensFacade if you just want to fetch an access token for one time.

Method Summary

Modifier and Type	Method and Description
void	close()
CompletionStage<String>	get() Returns the OAuth access token.
static SphereAccessTokenSupplier	ofAutoRefresh(SphereAuthConfig config, HttpClient httpClient, boolean closeHttpClient) Provides a token generator which tries to always provide a valid token.
static SphereAccessTokenSupplier	ofConstantToken(String token) Provides a token generator which just returns a fixed token, so the client is only usable for the live time of this token.
static SphereAccessTokenSupplier	ofOneTimeFetchingToken(SphereAuthConfig config, HttpClient httpClient, boolean closeHttpClient) Provides a token generator which fetches only one token.

Method Detail

get

CompletionStage<String> get()

Returns the OAuth access token.

Specified by:

get in interface Supplier<CompletionStage<String>>

close

void close()

Specified by:

close in interface AutoCloseable

ofAutoRefresh

static SphereAccessTokenSupplier ofAutoRefresh(SphereAuthConfig config,
                                               HttpClient httpClient,
                                               boolean closeHttpClient)

Provides a token generator which tries to always provide a valid token.

Parameters:

config - the configuration to fetch a token

httpClient - used http client

closeHttpClient - set to true, if the httpClient should be closed with the created SphereAccessTokenSupplier

Returns:

token service

ofConstantToken

static SphereAccessTokenSupplier ofConstantToken(String token)

Provides a token generator which just returns a fixed token, so the client is only usable for the live time of this token.

Parameters:

token - the token which will be passed to the client

Returns:

token service

ofOneTimeFetchingToken

static SphereAccessTokenSupplier ofOneTimeFetchingToken(SphereAuthConfig config,
                                                        HttpClient httpClient,
                                                        boolean closeHttpClient)

Provides a token generator which fetches only one token. This could be useful for integration tests.

Parameters:

config - the configuration to fetch a token

httpClient - used http client, will be closed with this generator on close()

closeHttpClient - set to true, if the httpClient should be closed with the created SphereAccessTokenSupplier

Returns:

token service