org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization

Class OAuth2AuthorizationServerConfigurer<B extends org.springframework.security.config.annotation.web.HttpSecurityBuilder<B>>

java.lang.Object

org.springframework.security.config.annotation.SecurityConfigurerAdapter<org.springframework.security.web.DefaultSecurityFilterChain,B>

org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer<OAuth2AuthorizationServerConfigurer<B>,B>

org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization.OAuth2AuthorizationServerConfigurer<B>

All Implemented Interfaces:

org.springframework.security.config.annotation.SecurityConfigurer<org.springframework.security.web.DefaultSecurityFilterChain,B>

public final class OAuth2AuthorizationServerConfigurer<B extends org.springframework.security.config.annotation.web.HttpSecurityBuilder<B>>
extends org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer<OAuth2AuthorizationServerConfigurer<B>,B>

An AbstractHttpConfigurer for OAuth 2.0 Authorization Server support.

Since:

0.0.1

See Also:

AbstractHttpConfigurer, OAuth2ClientAuthenticationConfigurer, OAuth2AuthorizationEndpointConfigurer, OAuth2TokenEndpointConfigurer, OAuth2TokenIntrospectionEndpointConfigurer, OAuth2TokenRevocationEndpointConfigurer, OidcConfigurer, RegisteredClientRepository, OAuth2AuthorizationService, OAuth2AuthorizationConsentService, NimbusJwkSetEndpointFilter, OAuth2AuthorizationServerMetadataEndpointFilter

Constructor Summary

Constructors

Constructor and Description
OAuth2AuthorizationServerConfigurer()

Method Summary

Modifier and Type	Method and Description
OAuth2AuthorizationServerConfigurer<B>	authorizationConsentService(OAuth2AuthorizationConsentService authorizationConsentService) Sets the authorization consent service.
OAuth2AuthorizationServerConfigurer<B>	authorizationEndpoint(org.springframework.security.config.Customizer<OAuth2AuthorizationEndpointConfigurer> authorizationEndpointCustomizer) Configures the OAuth 2.0 Authorization Endpoint.
OAuth2AuthorizationServerConfigurer<B>	authorizationService(OAuth2AuthorizationService authorizationService) Sets the authorization service.
OAuth2AuthorizationServerConfigurer<B>	clientAuthentication(org.springframework.security.config.Customizer<OAuth2ClientAuthenticationConfigurer> clientAuthenticationCustomizer) Configures OAuth 2.0 Client Authentication.
void	configure(B builder)
org.springframework.security.web.util.matcher.RequestMatcher	getEndpointsMatcher() Returns a RequestMatcher for the authorization server endpoints.
void	init(B builder)
OAuth2AuthorizationServerConfigurer<B>	oidc(org.springframework.security.config.Customizer<OidcConfigurer> oidcCustomizer) Configures OpenID Connect 1.0 support.
OAuth2AuthorizationServerConfigurer<B>	providerSettings(ProviderSettings providerSettings) Sets the provider settings.
OAuth2AuthorizationServerConfigurer<B>	registeredClientRepository(RegisteredClientRepository registeredClientRepository) Sets the repository of registered clients.
OAuth2AuthorizationServerConfigurer<B>	tokenEndpoint(org.springframework.security.config.Customizer<OAuth2TokenEndpointConfigurer> tokenEndpointCustomizer) Configures the OAuth 2.0 Token Endpoint.
OAuth2AuthorizationServerConfigurer<B>	tokenGenerator(OAuth2TokenGenerator<? extends org.springframework.security.oauth2.core.OAuth2Token> tokenGenerator) Sets the token generator.
OAuth2AuthorizationServerConfigurer<B>	tokenIntrospectionEndpoint(org.springframework.security.config.Customizer<OAuth2TokenIntrospectionEndpointConfigurer> tokenIntrospectionEndpointCustomizer) Configures the OAuth 2.0 Token Introspection Endpoint.
OAuth2AuthorizationServerConfigurer<B>	tokenRevocationEndpoint(org.springframework.security.config.Customizer<OAuth2TokenRevocationEndpointConfigurer> tokenRevocationEndpointCustomizer) Configures the OAuth 2.0 Token Revocation Endpoint.

Methods inherited from class org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer

disable, withObjectPostProcessor

Methods inherited from class org.springframework.security.config.annotation.SecurityConfigurerAdapter

addObjectPostProcessor, and, getBuilder, postProcess, setBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2AuthorizationServerConfigurer

public OAuth2AuthorizationServerConfigurer()

Method Detail

registeredClientRepository

public OAuth2AuthorizationServerConfigurer<B> registeredClientRepository(RegisteredClientRepository registeredClientRepository)

Sets the repository of registered clients.

Parameters:

registeredClientRepository - the repository of registered clients

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

authorizationService

public OAuth2AuthorizationServerConfigurer<B> authorizationService(OAuth2AuthorizationService authorizationService)

Sets the authorization service.

Parameters:

authorizationService - the authorization service

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

authorizationConsentService

public OAuth2AuthorizationServerConfigurer<B> authorizationConsentService(OAuth2AuthorizationConsentService authorizationConsentService)

Sets the authorization consent service.

Parameters:

authorizationConsentService - the authorization consent service

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

providerSettings

public OAuth2AuthorizationServerConfigurer<B> providerSettings(ProviderSettings providerSettings)

Sets the provider settings.

Parameters:

providerSettings - the provider settings

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

tokenGenerator

public OAuth2AuthorizationServerConfigurer<B> tokenGenerator(OAuth2TokenGenerator<? extends org.springframework.security.oauth2.core.OAuth2Token> tokenGenerator)

Sets the token generator.

Parameters:

tokenGenerator - the token generator

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

Since:

0.2.3

clientAuthentication

public OAuth2AuthorizationServerConfigurer<B> clientAuthentication(org.springframework.security.config.Customizer<OAuth2ClientAuthenticationConfigurer> clientAuthenticationCustomizer)

Configures OAuth 2.0 Client Authentication.

Parameters:

clientAuthenticationCustomizer - the Customizer providing access to the OAuth2ClientAuthenticationConfigurer

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

authorizationEndpoint

public OAuth2AuthorizationServerConfigurer<B> authorizationEndpoint(org.springframework.security.config.Customizer<OAuth2AuthorizationEndpointConfigurer> authorizationEndpointCustomizer)

Configures the OAuth 2.0 Authorization Endpoint.

Parameters:

authorizationEndpointCustomizer - the Customizer providing access to the OAuth2AuthorizationEndpointConfigurer

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

tokenEndpoint

public OAuth2AuthorizationServerConfigurer<B> tokenEndpoint(org.springframework.security.config.Customizer<OAuth2TokenEndpointConfigurer> tokenEndpointCustomizer)

Configures the OAuth 2.0 Token Endpoint.

Parameters:

tokenEndpointCustomizer - the Customizer providing access to the OAuth2TokenEndpointConfigurer

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

tokenIntrospectionEndpoint

public OAuth2AuthorizationServerConfigurer<B> tokenIntrospectionEndpoint(org.springframework.security.config.Customizer<OAuth2TokenIntrospectionEndpointConfigurer> tokenIntrospectionEndpointCustomizer)

Configures the OAuth 2.0 Token Introspection Endpoint.

Parameters:

tokenIntrospectionEndpointCustomizer - the Customizer providing access to the OAuth2TokenIntrospectionEndpointConfigurer

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

Since:

0.2.3

tokenRevocationEndpoint

public OAuth2AuthorizationServerConfigurer<B> tokenRevocationEndpoint(org.springframework.security.config.Customizer<OAuth2TokenRevocationEndpointConfigurer> tokenRevocationEndpointCustomizer)

Configures the OAuth 2.0 Token Revocation Endpoint.

Parameters:

tokenRevocationEndpointCustomizer - the Customizer providing access to the OAuth2TokenRevocationEndpointConfigurer

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

Since:

0.2.2

oidc

public OAuth2AuthorizationServerConfigurer<B> oidc(org.springframework.security.config.Customizer<OidcConfigurer> oidcCustomizer)

Configures OpenID Connect 1.0 support.

Parameters:

oidcCustomizer - the Customizer providing access to the OidcConfigurer

Returns:

the OAuth2AuthorizationServerConfigurer for further configuration

getEndpointsMatcher

public org.springframework.security.web.util.matcher.RequestMatcher getEndpointsMatcher()

Returns a RequestMatcher for the authorization server endpoints.

Returns:

a RequestMatcher for the authorization server endpoints

init

public void init(B builder)

Specified by:

init in interface org.springframework.security.config.annotation.SecurityConfigurer<org.springframework.security.web.DefaultSecurityFilterChain,B extends org.springframework.security.config.annotation.web.HttpSecurityBuilder<B>>

Overrides:

init in class org.springframework.security.config.annotation.SecurityConfigurerAdapter<org.springframework.security.web.DefaultSecurityFilterChain,B extends org.springframework.security.config.annotation.web.HttpSecurityBuilder<B>>

configure

public void configure(B builder)

Specified by:

configure in interface org.springframework.security.config.annotation.SecurityConfigurer<org.springframework.security.web.DefaultSecurityFilterChain,B extends org.springframework.security.config.annotation.web.HttpSecurityBuilder<B>>

Overrides:

configure in class org.springframework.security.config.annotation.SecurityConfigurerAdapter<org.springframework.security.web.DefaultSecurityFilterChain,B extends org.springframework.security.config.annotation.web.HttpSecurityBuilder<B>>