Package org.apache.juneau.rest.server.auth.oauth

Class CachingClientCredentialsFlow.Builder

java.lang.Object

org.apache.juneau.rest.server.auth.oauth.CachingClientCredentialsFlow.Builder

Enclosing class:

CachingClientCredentialsFlow

public static class CachingClientCredentialsFlow.Builder
extends Object

Builder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
CachingClientCredentialsFlow	build()	Builds the flow.
CachingClientCredentialsFlow.Builder	cacheSkew(Duration value)	Sets the skew tolerance subtracted from the cached token's expiry.
CachingClientCredentialsFlow.Builder	clientId(String value)	Sets the OAuth client ID.
CachingClientCredentialsFlow.Builder	clientSecret(String value)	Sets the OAuth client secret as a literal string.
CachingClientCredentialsFlow.Builder	clientSecretSupplier(Supplier<String> value)	Sets the OAuth client secret via a supplier.
CachingClientCredentialsFlow.Builder	httpRequestConfigurator(Consumer<com.nimbusds.oauth2.sdk.http.HTTPRequest> value)	Sets a callback that customizes the Nimbus HTTPRequest.
CachingClientCredentialsFlow.Builder	scope(String... values)	Adds requested OAuth scopes.
CachingClientCredentialsFlow.Builder	tokenCache(TokenCache value)	Configures the cache for the acquired token.
CachingClientCredentialsFlow.Builder	tokenEndpoint(URI value)	Sets the token endpoint URL.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor.

Method Details

tokenEndpoint

public CachingClientCredentialsFlow.Builder tokenEndpoint(URI value)

Sets the token endpoint URL. Required.

Parameters:

value - The endpoint URL. Must not be null.

Returns:

This object.

clientId

public CachingClientCredentialsFlow.Builder clientId(String value)

Sets the OAuth client ID. Required.

Parameters:

value - The client ID. Must not be null or blank.

Returns:

This object.

clientSecret

public CachingClientCredentialsFlow.Builder clientSecret(String value)

Sets the OAuth client secret as a literal string.

Parameters:

value - The client secret. Must not be null or blank.

Returns:

This object.

clientSecretSupplier

public CachingClientCredentialsFlow.Builder clientSecretSupplier(Supplier<String> value)

Sets the OAuth client secret via a supplier.

Parameters:

value - The supplier. Must not be null.

Returns:

This object.

scope

public CachingClientCredentialsFlow.Builder scope(String... values)

Adds requested OAuth scopes.

Parameters:

values - The scopes.

Returns:

This object.

tokenCache

public CachingClientCredentialsFlow.Builder tokenCache(TokenCache value)

Configures the cache for the acquired token.

Parameters:

value - The cache. Must not be null.

Returns:

This object.

cacheSkew

public CachingClientCredentialsFlow.Builder cacheSkew(Duration value)

Sets the skew tolerance subtracted from the cached token's expiry. Default 30s.

Parameters:

value - The skew. Must be non-negative.

Returns:

This object.

httpRequestConfigurator

public CachingClientCredentialsFlow.Builder httpRequestConfigurator(Consumer<com.nimbusds.oauth2.sdk.http.HTTPRequest> value)

Sets a callback that customizes the Nimbus HTTPRequest.

Parameters:

value - The callback. Must not be null.

Returns:

This object.

build

public CachingClientCredentialsFlow build()

Builds the flow.

Returns:

A new CachingClientCredentialsFlow.