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

Class OAuthAuthorizationCodeFlow.Builder

java.lang.Object

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

Enclosing class:

OAuthAuthorizationCodeFlow

public static class OAuthAuthorizationCodeFlow.Builder
extends Object

Builder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
OAuthAuthorizationCodeFlow.Builder	authorizationEndpoint(URI value)	Sets the authorization endpoint URL.
OAuthAuthorizationCodeFlow	build()	Builds the flow.
OAuthAuthorizationCodeFlow.Builder	clientId(String value)	Sets the OAuth client ID.
OAuthAuthorizationCodeFlow.Builder	clientSecret(String value)	Sets the client secret.
OAuthAuthorizationCodeFlow.Builder	clientSecretSupplier(Supplier<String> value)	Sets the client secret via a supplier.
OAuthAuthorizationCodeFlow.Builder	httpRequestConfigurator(Consumer<com.nimbusds.oauth2.sdk.http.HTTPRequest> value)	Sets the HTTP request configurator (applied to the token-exchange request).
OAuthAuthorizationCodeFlow.Builder	httpTimeout(Duration value)	Sets the connect/read timeout applied to the token-exchange request.
OAuthAuthorizationCodeFlow.Builder	redirectUri(URI value)	Sets the redirect URI.
OAuthAuthorizationCodeFlow.Builder	resource(URI value)	Sets the RFC 8707 resource indicator sent on both the authorization request and the token exchange.
OAuthAuthorizationCodeFlow.Builder	scope(String... values)	Adds requested scopes.
OAuthAuthorizationCodeFlow.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

authorizationEndpoint

public OAuthAuthorizationCodeFlow.Builder authorizationEndpoint(URI value)

Sets the authorization endpoint URL. Required.

Parameters:

value - The endpoint URL.

Returns:

This object.

tokenEndpoint

public OAuthAuthorizationCodeFlow.Builder tokenEndpoint(URI value)

Sets the token endpoint URL. Required.

Parameters:

value - The endpoint URL.

Returns:

This object.

clientId

public OAuthAuthorizationCodeFlow.Builder clientId(String value)

Sets the OAuth client ID. Required.

Parameters:

value - The client ID.

Returns:

This object.

clientSecret

public OAuthAuthorizationCodeFlow.Builder clientSecret(String value)

Sets the client secret. May be omitted for public clients (PKCE-only).

Parameters:

value - The client secret.

Returns:

This object.

clientSecretSupplier

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

Sets the client secret via a supplier.

Parameters:

value - The supplier.

Returns:

This object.

redirectUri

public OAuthAuthorizationCodeFlow.Builder redirectUri(URI value)

Sets the redirect URI. Required.

Parameters:

value - The redirect URI.

Returns:

This object.

scope

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

Adds requested scopes.

Parameters:

values - The scopes.

Returns:

This object.

resource

public OAuthAuthorizationCodeFlow.Builder resource(URI value)

Sets the RFC 8707 resource indicator sent on both the authorization request and the token exchange.

Parameters:

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

Returns:

This object.

httpTimeout

public OAuthAuthorizationCodeFlow.Builder httpTimeout(Duration value)

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

Parameters:

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

Returns:

This object.

httpRequestConfigurator

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

Sets the HTTP request configurator (applied to the token-exchange request).

Parameters:

value - The callback.

Returns:

This object.

build

public OAuthAuthorizationCodeFlow build()

Builds the flow.

Returns:

A new OAuthAuthorizationCodeFlow.