Package org.springframework.security.oauth2.server.authorization

Class AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<T extends AbstractOAuth2AuthorizationServerMetadata,B extends AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<T,B>>

java.lang.Object

org.springframework.security.oauth2.server.authorization.AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<T,B>

Type Parameters:

T - the type of object

B - the type of the builder

Direct Known Subclasses:

OAuth2AuthorizationServerMetadata.Builder, OidcProviderConfiguration.Builder

Enclosing class:

AbstractOAuth2AuthorizationServerMetadata

protected abstract static class AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<T extends AbstractOAuth2AuthorizationServerMetadata,B extends AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<T,B>>
extends Object

A builder for subclasses of AbstractOAuth2AuthorizationServerMetadata.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
B	authorizationEndpoint(String authorizationEndpoint)	Use this authorization_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.
abstract T	build()	Creates the AbstractOAuth2AuthorizationServerMetadata.
B	claim(String name, Object value)	Use this claim in the resulting AbstractOAuth2AuthorizationServerMetadata.
B	claims(Consumer<Map<String,Object>> claimsConsumer)	Provides access to every claim(String, Object) declared so far with the possibility to add, replace, or remove.
B	clientRegistrationEndpoint(String clientRegistrationEndpoint)	Use this registration_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
B	codeChallengeMethod(String codeChallengeMethod)	Add this Proof Key for Code Exchange (PKCE) code_challenge_method to the collection of code_challenge_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
B	codeChallengeMethods(Consumer<List<String>> codeChallengeMethodsConsumer)	A Consumer of the Proof Key for Code Exchange (PKCE) code_challenge_method values supported allowing the ability to add, replace, or remove.
B	deviceAuthorizationEndpoint(String deviceAuthorizationEndpoint)	Use this device_authorization_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
protected Map<String,Object>	getClaims()
protected final B	getThis()
B	grantType(String grantType)	Add this OAuth 2.0 grant_type to the collection of grant_types_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
B	grantTypes(Consumer<List<String>> grantTypesConsumer)	A Consumer of the OAuth 2.0 grant_type values supported allowing the ability to add, replace, or remove.
B	issuer(String issuer)	Use this issuer in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.
B	jwkSetUrl(String jwkSetUrl)	Use this jwks_uri in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
B	responseType(String responseType)	Add this OAuth 2.0 response_type to the collection of response_types_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.
B	responseTypes(Consumer<List<String>> responseTypesConsumer)	A Consumer of the OAuth 2.0 response_type values supported allowing the ability to add, replace, or remove.
B	scope(String scope)	Add this OAuth 2.0 scope to the collection of scopes_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, RECOMMENDED.
B	scopes(Consumer<List<String>> scopesConsumer)	A Consumer of the OAuth 2.0 scope values supported allowing the ability to add, replace, or remove.
B	tlsClientCertificateBoundAccessTokens(boolean tlsClientCertificateBoundAccessTokens)	Use this tls_client_certificate_bound_access_tokens in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
B	tokenEndpoint(String tokenEndpoint)	Use this token_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.
B	tokenEndpointAuthenticationMethod(String authenticationMethod)	Add this client authentication method to the collection of token_endpoint_auth_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
B	tokenEndpointAuthenticationMethods(Consumer<List<String>> authenticationMethodsConsumer)	A Consumer of the client authentication method(s) allowing the ability to add, replace, or remove.
B	tokenIntrospectionEndpoint(String tokenIntrospectionEndpoint)	Use this introspection_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
B	tokenIntrospectionEndpointAuthenticationMethod(String authenticationMethod)	Add this client authentication method to the collection of introspection_endpoint_auth_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
B	tokenIntrospectionEndpointAuthenticationMethods(Consumer<List<String>> authenticationMethodsConsumer)	A Consumer of the client authentication method(s) allowing the ability to add, replace, or remove.
B	tokenRevocationEndpoint(String tokenRevocationEndpoint)	Use this revocation_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
B	tokenRevocationEndpointAuthenticationMethod(String authenticationMethod)	Add this client authentication method to the collection of revocation_endpoint_auth_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.
B	tokenRevocationEndpointAuthenticationMethods(Consumer<List<String>> authenticationMethodsConsumer)	A Consumer of the client authentication method(s) allowing the ability to add, replace, or remove.
protected void	validate()
protected static void	validateURL(Object url, String errorMessage)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

getClaims

protected Map<String,Object> getClaims()

getThis

protected final B getThis()

issuer

public B issuer(String issuer)

Use this issuer in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.

Parameters:

issuer - the URL of the Authorization Server's Issuer Identifier

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

authorizationEndpoint

public B authorizationEndpoint(String authorizationEndpoint)

Use this authorization_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.

Parameters:

authorizationEndpoint - the URL of the OAuth 2.0 Authorization Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

deviceAuthorizationEndpoint

public B deviceAuthorizationEndpoint(String deviceAuthorizationEndpoint)

Use this device_authorization_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

deviceAuthorizationEndpoint - the URL of the OAuth 2.0 Device Authorization Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

Since:

1.1

tokenEndpoint

public B tokenEndpoint(String tokenEndpoint)

Use this token_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.

Parameters:

tokenEndpoint - the URL of the OAuth 2.0 Token Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

tokenEndpointAuthenticationMethod

public B tokenEndpointAuthenticationMethod(String authenticationMethod)

Add this client authentication method to the collection of token_endpoint_auth_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

authenticationMethod - the client authentication method supported by the OAuth 2.0 Token Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

tokenEndpointAuthenticationMethods

public B tokenEndpointAuthenticationMethods(Consumer<List<String>> authenticationMethodsConsumer)

A Consumer of the client authentication method(s) allowing the ability to add, replace, or remove.

Parameters:

authenticationMethodsConsumer - a Consumer of the client authentication method(s) supported by the OAuth 2.0 Token Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

jwkSetUrl

public B jwkSetUrl(String jwkSetUrl)

Use this jwks_uri in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

jwkSetUrl - the URL of the JSON Web Key Set

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

scope

public B scope(String scope)

Add this OAuth 2.0 scope to the collection of scopes_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, RECOMMENDED.

Parameters:

scope - the OAuth 2.0 scope value supported

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

scopes

public B scopes(Consumer<List<String>> scopesConsumer)

A Consumer of the OAuth 2.0 scope values supported allowing the ability to add, replace, or remove.

Parameters:

scopesConsumer - a Consumer of the OAuth 2.0 scope values supported

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

responseType

public B responseType(String responseType)

Add this OAuth 2.0 response_type to the collection of response_types_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, REQUIRED.

Parameters:

responseType - the OAuth 2.0 response_type value supported

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

responseTypes

public B responseTypes(Consumer<List<String>> responseTypesConsumer)

A Consumer of the OAuth 2.0 response_type values supported allowing the ability to add, replace, or remove.

Parameters:

responseTypesConsumer - a Consumer of the OAuth 2.0 response_type values supported

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

grantType

public B grantType(String grantType)

Add this OAuth 2.0 grant_type to the collection of grant_types_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

grantType - the OAuth 2.0 grant_type value supported

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

grantTypes

public B grantTypes(Consumer<List<String>> grantTypesConsumer)

A Consumer of the OAuth 2.0 grant_type values supported allowing the ability to add, replace, or remove.

Parameters:

grantTypesConsumer - a Consumer of the OAuth 2.0 grant_type values supported

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

tokenRevocationEndpoint

public B tokenRevocationEndpoint(String tokenRevocationEndpoint)

Use this revocation_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

tokenRevocationEndpoint - the URL of the OAuth 2.0 Token Revocation Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

tokenRevocationEndpointAuthenticationMethod

public B tokenRevocationEndpointAuthenticationMethod(String authenticationMethod)

Add this client authentication method to the collection of revocation_endpoint_auth_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

authenticationMethod - the client authentication method supported by the OAuth 2.0 Token Revocation Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

tokenRevocationEndpointAuthenticationMethods

public B tokenRevocationEndpointAuthenticationMethods(Consumer<List<String>> authenticationMethodsConsumer)

A Consumer of the client authentication method(s) allowing the ability to add, replace, or remove.

Parameters:

authenticationMethodsConsumer - a Consumer of the client authentication method(s) supported by the OAuth 2.0 Token Revocation Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

tokenIntrospectionEndpoint

public B tokenIntrospectionEndpoint(String tokenIntrospectionEndpoint)

Use this introspection_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

tokenIntrospectionEndpoint - the URL of the OAuth 2.0 Token Introspection Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

tokenIntrospectionEndpointAuthenticationMethod

public B tokenIntrospectionEndpointAuthenticationMethod(String authenticationMethod)

Add this client authentication method to the collection of introspection_endpoint_auth_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

authenticationMethod - the client authentication method supported by the OAuth 2.0 Token Introspection Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

tokenIntrospectionEndpointAuthenticationMethods

public B tokenIntrospectionEndpointAuthenticationMethods(Consumer<List<String>> authenticationMethodsConsumer)

A Consumer of the client authentication method(s) allowing the ability to add, replace, or remove.

Parameters:

authenticationMethodsConsumer - a Consumer of the client authentication method(s) supported by the OAuth 2.0 Token Introspection Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

clientRegistrationEndpoint

public B clientRegistrationEndpoint(String clientRegistrationEndpoint)

Use this registration_endpoint in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

clientRegistrationEndpoint - the URL of the OAuth 2.0 Dynamic Client Registration Endpoint

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

Since:

0.4.0

codeChallengeMethod

public B codeChallengeMethod(String codeChallengeMethod)

Add this Proof Key for Code Exchange (PKCE) code_challenge_method to the collection of code_challenge_methods_supported in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

codeChallengeMethod - the code_challenge_method value supported

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

codeChallengeMethods

public B codeChallengeMethods(Consumer<List<String>> codeChallengeMethodsConsumer)

A Consumer of the Proof Key for Code Exchange (PKCE) code_challenge_method values supported allowing the ability to add, replace, or remove.

Parameters:

codeChallengeMethodsConsumer - a Consumer of the code_challenge_method values supported

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

tlsClientCertificateBoundAccessTokens

public B tlsClientCertificateBoundAccessTokens(boolean tlsClientCertificateBoundAccessTokens)

Use this tls_client_certificate_bound_access_tokens in the resulting AbstractOAuth2AuthorizationServerMetadata, OPTIONAL.

Parameters:

tlsClientCertificateBoundAccessTokens - true to indicate support for mutual-TLS client certificate-bound access tokens

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

Since:

1.3

claim

public B claim(String name,
 Object value)

Use this claim in the resulting AbstractOAuth2AuthorizationServerMetadata.

Parameters:

name - the claim name

value - the claim value

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configuration

claims

public B claims(Consumer<Map<String,Object>> claimsConsumer)

Provides access to every claim(String, Object) declared so far with the possibility to add, replace, or remove.

Parameters:

claimsConsumer - a Consumer of the claims

Returns:

the AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder for further configurations

build

public abstract T build()

Creates the AbstractOAuth2AuthorizationServerMetadata.

Returns:

the AbstractOAuth2AuthorizationServerMetadata

validate

protected void validate()

validateURL

protected static void validateURL(Object url,
 String errorMessage)