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

Class OAuthRefreshTokenFlow.Builder

java.lang.Object

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

Enclosing class:

OAuthRefreshTokenFlow

public static class OAuthRefreshTokenFlow.Builder
extends Object

Builder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
OAuthRefreshTokenFlow	build()	Builds the flow.
OAuthRefreshTokenFlow.Builder	clientId(String value)	Sets the OAuth client ID.
OAuthRefreshTokenFlow.Builder	clientSecret(String value)	Sets the OAuth client secret.
OAuthRefreshTokenFlow.Builder	clientSecretSupplier(Supplier<String> value)	Sets the OAuth client secret via a supplier.
OAuthRefreshTokenFlow.Builder	httpRequestConfigurator(Consumer<com.nimbusds.oauth2.sdk.http.HTTPRequest> value)	Sets the HTTP request configurator.
OAuthRefreshTokenFlow.Builder	httpTimeout(Duration value)	Sets the connect/read timeout applied to the token request.
OAuthRefreshTokenFlow.Builder	refreshToken(String value)	Sets the refresh-token value.
OAuthRefreshTokenFlow.Builder	resource(URI value)	Sets the RFC 8707 resource indicator sent on the token request.
OAuthRefreshTokenFlow.Builder	scope(String... values)	Adds optional scope narrowing.
OAuthRefreshTokenFlow.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 OAuthRefreshTokenFlow.Builder tokenEndpoint(URI value)

Sets the token endpoint URL. Required.

Parameters:

value - The endpoint.

Returns:

This object.

clientId

public OAuthRefreshTokenFlow.Builder clientId(String value)

Sets the OAuth client ID. Required.

Parameters:

value - The client ID.

Returns:

This object.

clientSecret

public OAuthRefreshTokenFlow.Builder clientSecret(String value)

Sets the OAuth client secret. May be omitted for public clients.

Parameters:

value - The secret.

Returns:

This object.

clientSecretSupplier

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

Sets the OAuth client secret via a supplier.

Parameters:

value - The supplier.

Returns:

This object.

refreshToken

public OAuthRefreshTokenFlow.Builder refreshToken(String value)

Sets the refresh-token value. Required.

Parameters:

value - The refresh token.

Returns:

This object.

scope

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

Adds optional scope narrowing.

Parameters:

values - The scopes.

Returns:

This object.

resource

public OAuthRefreshTokenFlow.Builder resource(URI value)

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

Parameters:

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

Returns:

This object.

httpTimeout

public OAuthRefreshTokenFlow.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 OAuthRefreshTokenFlow.Builder httpRequestConfigurator(Consumer<com.nimbusds.oauth2.sdk.http.HTTPRequest> value)

Sets the HTTP request configurator.

Parameters:

value - The callback.

Returns:

This object.

build

public OAuthRefreshTokenFlow build()

Builds the flow.

Returns:

A new OAuthRefreshTokenFlow.