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

Class OAuthClientCredentialsFlow.Builder

java.lang.Object

org.apache.juneau.rest.auth.oauth.flow.OAuthClientCredentialsFlow.Builder

Enclosing class:

OAuthClientCredentialsFlow

public static class OAuthClientCredentialsFlow.Builder
extends Object

Builder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
OAuthClientCredentialsFlow	build()	Builds the flow.
OAuthClientCredentialsFlow.Builder	clientId(String value)	Sets the OAuth client ID.
OAuthClientCredentialsFlow.Builder	clientSecret(String value)	Sets the OAuth client secret as a literal string.
OAuthClientCredentialsFlow.Builder	clientSecretSupplier(Supplier<String> value)	Sets the OAuth client secret via a supplier.
OAuthClientCredentialsFlow.Builder	httpRequestConfigurator(Consumer<com.nimbusds.oauth2.sdk.http.HTTPRequest> value)	Sets a callback that customizes the Nimbus HTTPRequest.
OAuthClientCredentialsFlow.Builder	httpTimeout(Duration value)	Sets the connect/read timeout applied to the token request.
OAuthClientCredentialsFlow.Builder	resource(URI value)	Sets the RFC 8707 resource indicator sent on the token request.
OAuthClientCredentialsFlow.Builder	scope(String... values)	Adds requested OAuth scopes.
OAuthClientCredentialsFlow.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 OAuthClientCredentialsFlow.Builder tokenEndpoint(URI value)

Sets the token endpoint URL. Required.

Parameters:

value - The endpoint URL. Must not be null.

Returns:

This object.

clientId

public OAuthClientCredentialsFlow.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 OAuthClientCredentialsFlow.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 OAuthClientCredentialsFlow.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 OAuthClientCredentialsFlow.Builder scope(String... values)

Adds requested OAuth scopes.

Parameters:

values - The scopes.

Returns:

This object.

resource

public OAuthClientCredentialsFlow.Builder resource(URI value)

Sets the RFC 8707 resource indicator sent on the token request.

The canonical URI of the protected resource the acquired token is intended for. Setting this binds the token's audience so a malicious server cannot replay it against a different resource.

Parameters:

value - The canonical resource URI. Must not be null.

Returns:

This object.

httpTimeout

public OAuthClientCredentialsFlow.Builder httpTimeout(Duration value)

Sets the connect/read timeout applied to the token request. Default 10 seconds.

Parameters:

value - The timeout. Must not be null and must be positive.

Returns:

This object.

httpRequestConfigurator

public OAuthClientCredentialsFlow.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 OAuthClientCredentialsFlow build()

Builds the flow.

Returns:

A new OAuthClientCredentialsFlow.