Interface EnvironmentBuilder.OAuth2Configuration

Enclosing interface:

EnvironmentBuilder

public static interface EnvironmentBuilder.OAuth2Configuration

Configuration to retrieve a token using the OAuth 2 Client Credentials flow.

Since:

1.3.0

Method Summary

Modifier and Type	Method	Description
EnvironmentBuilder.OAuth2Configuration	ciphers(String... ciphers)	TLS cipher suites for HTTPS requests.
EnvironmentBuilder.OAuth2Configuration	clientId(String clientId)	Set the OAuth 2 client ID
EnvironmentBuilder.OAuth2Configuration	clientSecret(String clientSecret)	Set the secret (password) to use to get a token.
EnvironmentBuilder	environmentBuilder()	Go back to the environment builder
EnvironmentBuilder.OAuth2Configuration	grantType(String grantType)	Set the grant type to use when requesting the token.
EnvironmentBuilder.OAuth2Configuration	namedGroups(String... namedGroups)	TLS named groups (key exchange groups) for HTTPS requests.
EnvironmentBuilder.OAuth2Configuration	parameter(String name, String value)	Set a parameter to pass in the request.
EnvironmentBuilder.OAuth2Configuration	sslContext(SSLContext sslContext)	SSLContext for HTTPS requests.
EnvironmentBuilder.OAuth2Configuration	tokenEndpointUri(String uri)	Set the URI to access to get the token.

Method Details

tokenEndpointUri

EnvironmentBuilder.OAuth2Configuration tokenEndpointUri(String uri)

Set the URI to access to get the token.

TLS is supported by providing a HTTPS URI and setting a SSLContext. See sslContext(javax.net.ssl.SSLContext) for more information. Applications in production should always use HTTPS to retrieve tokens.

Parameters:

uri - access URI

Returns:

OAuth 2 configuration

See Also:

• sslContext(javax.net.ssl.SSLContext)

clientId

EnvironmentBuilder.OAuth2Configuration clientId(String clientId)

Set the OAuth 2 client ID

The client ID usually identifies the application that requests a token.

Parameters:

clientId - client ID

Returns:

OAuth 2 configuration

clientSecret

EnvironmentBuilder.OAuth2Configuration clientSecret(String clientSecret)

Set the secret (password) to use to get a token.

Parameters:

clientSecret - client secret

Returns:

OAuth 2 configuration

grantType

EnvironmentBuilder.OAuth2Configuration grantType(String grantType)

Set the grant type to use when requesting the token.

The default is client_credentials, but some OAuth 2 servers can use non-standard grant types to request tokens with extra-information.

Parameters:

grantType - grant type

Returns:

OAuth 2 configuration

parameter

EnvironmentBuilder.OAuth2Configuration parameter(String name,
 String value)

Set a parameter to pass in the request.

The OAuth 2 server may require extra parameters to narrow down the identity of the user.

Parameters:

name - name of the parameter

value - value of the parameter

Returns:

OAuth 2 configuration

sslContext

EnvironmentBuilder.OAuth2Configuration sslContext(SSLContext sslContext)

SSLContext for HTTPS requests.

Parameters:

sslContext - the SSL context

Returns:

OAuth 2 configuration

namedGroups

EnvironmentBuilder.OAuth2Configuration namedGroups(String... namedGroups)

TLS named groups (key exchange groups) for HTTPS requests.

Use this to select post-quantum or hybrid post-quantum key exchange, e.g. X25519MLKEM768. Requires sslContext(javax.net.ssl.SSLContext) to be set, and Java 20 or more.

Parameters:

namedGroups - the named groups, in order of preference

Returns:

OAuth 2 configuration

Since:

1.12.0

ciphers

EnvironmentBuilder.OAuth2Configuration ciphers(String... ciphers)

TLS cipher suites for HTTPS requests.

Note this does not affect the key exchange algorithm with TLS 1.3, see namedGroups(String...) for post-quantum key exchange. Requires sslContext(javax.net.ssl.SSLContext) to be set.

Parameters:

ciphers - the cipher suites, in order of preference

Returns:

OAuth 2 configuration

Since:

1.12.0

environmentBuilder

EnvironmentBuilder environmentBuilder()

Go back to the environment builder

Returns:

the environment builder