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

Class OidcProviderConfiguration.Builder

java.lang.Object

org.springframework.security.oauth2.server.authorization.AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<OidcProviderConfiguration,OidcProviderConfiguration.Builder>

org.springframework.security.oauth2.server.authorization.oidc.OidcProviderConfiguration.Builder

Enclosing class:

OidcProviderConfiguration

public static final class OidcProviderConfiguration.Builder
extends AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<OidcProviderConfiguration,OidcProviderConfiguration.Builder>

Helps configure an OidcProviderConfiguration.

Method Summary

Modifier and Type	Method	Description
OidcProviderConfiguration	build()	Validate the claims and build the OidcProviderConfiguration.
OidcProviderConfiguration.Builder	endSessionEndpoint(String endSessionEndpoint)	Use this end_session_endpoint in the resulting OidcProviderConfiguration, OPTIONAL.
OidcProviderConfiguration.Builder	idTokenSigningAlgorithm(String signingAlgorithm)	Add this JWS signing algorithm to the collection of id_token_signing_alg_values_supported in the resulting OidcProviderConfiguration, REQUIRED.
OidcProviderConfiguration.Builder	idTokenSigningAlgorithms(Consumer<List<String>> signingAlgorithmsConsumer)	A Consumer of the JWS signing algorithms for the ID Token allowing the ability to add, replace, or remove.
OidcProviderConfiguration.Builder	subjectType(String subjectType)	Add this Subject Type to the collection of subject_types_supported in the resulting OidcProviderConfiguration, REQUIRED.
OidcProviderConfiguration.Builder	subjectTypes(Consumer<List<String>> subjectTypesConsumer)	A Consumer of the Subject Types(s) allowing the ability to add, replace, or remove.
OidcProviderConfiguration.Builder	userInfoEndpoint(String userInfoEndpoint)	Use this userinfo_endpoint in the resulting OidcProviderConfiguration, OPTIONAL.
protected void	validate()

Methods inherited from class org.springframework.security.oauth2.server.authorization.AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder

authorizationEndpoint, claim, claims, clientRegistrationEndpoint, codeChallengeMethod, codeChallengeMethods, deviceAuthorizationEndpoint, getClaims, getThis, grantType, grantTypes, issuer, jwkSetUrl, responseType, responseTypes, scope, scopes, tlsClientCertificateBoundAccessTokens, tokenEndpoint, tokenEndpointAuthenticationMethod, tokenEndpointAuthenticationMethods, tokenIntrospectionEndpoint, tokenIntrospectionEndpointAuthenticationMethod, tokenIntrospectionEndpointAuthenticationMethods, tokenRevocationEndpoint, tokenRevocationEndpointAuthenticationMethod, tokenRevocationEndpointAuthenticationMethods, validateURL

Methods inherited from class java.lang.Object

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

Method Details

subjectType

public OidcProviderConfiguration.Builder subjectType(String subjectType)

Add this Subject Type to the collection of subject_types_supported in the resulting OidcProviderConfiguration, REQUIRED.

Parameters:

subjectType - the Subject Type that the OpenID Provider supports

Returns:

the OidcProviderConfiguration.Builder for further configuration

subjectTypes

public OidcProviderConfiguration.Builder subjectTypes(Consumer<List<String>> subjectTypesConsumer)

A Consumer of the Subject Types(s) allowing the ability to add, replace, or remove.

Parameters:

subjectTypesConsumer - a Consumer of the Subject Types(s)

Returns:

the OidcProviderConfiguration.Builder for further configuration

idTokenSigningAlgorithm

public OidcProviderConfiguration.Builder idTokenSigningAlgorithm(String signingAlgorithm)

Add this JWS signing algorithm to the collection of id_token_signing_alg_values_supported in the resulting OidcProviderConfiguration, REQUIRED.

Parameters:

signingAlgorithm - the JWS signing algorithm supported for the ID Token

Returns:

the OidcProviderConfiguration.Builder for further configuration

idTokenSigningAlgorithms

public OidcProviderConfiguration.Builder idTokenSigningAlgorithms(Consumer<List<String>> signingAlgorithmsConsumer)

A Consumer of the JWS signing algorithms for the ID Token allowing the ability to add, replace, or remove.

Parameters:

signingAlgorithmsConsumer - a Consumer of the JWS signing algorithms for the ID Token

Returns:

the OidcProviderConfiguration.Builder for further configuration

userInfoEndpoint

public OidcProviderConfiguration.Builder userInfoEndpoint(String userInfoEndpoint)

Use this userinfo_endpoint in the resulting OidcProviderConfiguration, OPTIONAL.

Parameters:

userInfoEndpoint - the URL of the OpenID Connect 1.0 UserInfo Endpoint

Returns:

the OidcProviderConfiguration.Builder for further configuration

Since:

0.2.2

endSessionEndpoint

public OidcProviderConfiguration.Builder endSessionEndpoint(String endSessionEndpoint)

Use this end_session_endpoint in the resulting OidcProviderConfiguration, OPTIONAL.

Parameters:

endSessionEndpoint - the URL of the OpenID Connect 1.0 End Session Endpoint

Returns:

the OidcProviderConfiguration.Builder for further configuration

Since:

1.1

build

public OidcProviderConfiguration build()

Validate the claims and build the OidcProviderConfiguration.

The following claims are REQUIRED: issuer, authorization_endpoint, token_endpoint, jwks_uri, response_types_supported, subject_types_supported and id_token_signing_alg_values_supported.

Specified by:

build in class AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<OidcProviderConfiguration,OidcProviderConfiguration.Builder>

Returns:

the OidcProviderConfiguration

validate

protected void validate()

Overrides:

validate in class AbstractOAuth2AuthorizationServerMetadata.AbstractBuilder<OidcProviderConfiguration,OidcProviderConfiguration.Builder>