org.springframework.security.config.annotation.web.configurers.oauth2.client

Class OAuth2LoginConfigurer<B extends 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<T,B>

org.springframework.security.config.annotation.web.configurers.AbstractAuthenticationFilterConfigurer<B,OAuth2LoginConfigurer<B>,org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter>

org.springframework.security.config.annotation.web.configurers.oauth2.client.OAuth2LoginConfigurer<B>

All Implemented Interfaces:

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

public final class OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>
extends AbstractAuthenticationFilterConfigurer<B,OAuth2LoginConfigurer<B>,org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter>

A security configurer for OAuth 2.0 / OpenID Connect 1.0 login.

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OAuth2LoginConfigurer.AuthorizationEndpointConfig
class	OAuth2LoginConfigurer.RedirectionEndpointConfig
class	OAuth2LoginConfigurer.TokenEndpointConfig
class	OAuth2LoginConfigurer.UserInfoEndpointConfig

Constructor Summary

Constructors

Constructor and Description
OAuth2LoginConfigurer()

Method Summary

Modifier and Type	Method and Description
OAuth2LoginConfigurer.AuthorizationEndpointConfig	authorizationEndpoint()
OAuth2LoginConfigurer<B>	authorizedClientService(org.springframework.security.oauth2.client.OAuth2AuthorizedClientService authorizedClientService)
OAuth2LoginConfigurer<B>	clientRegistrationRepository(org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository)
void	configure(B http) Configure the SecurityBuilder by setting the necessary properties on the SecurityBuilder.
protected org.springframework.security.web.util.matcher.RequestMatcher	createLoginProcessingUrlMatcher(java.lang.String loginProcessingUrl) Create the RequestMatcher given a loginProcessingUrl
void	init(B http) Initialize the SecurityBuilder.
OAuth2LoginConfigurer<B>	loginPage(java.lang.String loginPage) Specifies the URL to send users to if login is required.
OAuth2LoginConfigurer.RedirectionEndpointConfig	redirectionEndpoint()
OAuth2LoginConfigurer.TokenEndpointConfig	tokenEndpoint()
OAuth2LoginConfigurer.UserInfoEndpointConfig	userInfoEndpoint()

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

authenticationDetailsSource, defaultSuccessUrl, defaultSuccessUrl, failureHandler, failureUrl, getAuthenticationFilter, getFailureUrl, getLoginPage, getLoginProcessingUrl, isCustomLoginPage, loginProcessingUrl, permitAll, permitAll, setAuthenticationFilter, successHandler

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

OAuth2LoginConfigurer

public OAuth2LoginConfigurer()

Method Detail

clientRegistrationRepository

public OAuth2LoginConfigurer<B> clientRegistrationRepository(org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository)

authorizedClientService

public OAuth2LoginConfigurer<B> authorizedClientService(org.springframework.security.oauth2.client.OAuth2AuthorizedClientService authorizedClientService)

loginPage

public OAuth2LoginConfigurer<B> loginPage(java.lang.String loginPage)

Description copied from class: AbstractAuthenticationFilterConfigurer

Specifies the URL to send users to if login is required. If used with WebSecurityConfigurerAdapter a default login page will be generated when this attribute is not specified.

If a URL is specified or this is not being used in conjuction with WebSecurityConfigurerAdapter, users are required to process the specified URL to generate a login page.

Overrides:

loginPage in class AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>,org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter>

authorizationEndpoint

public OAuth2LoginConfigurer.AuthorizationEndpointConfig authorizationEndpoint()

tokenEndpoint

public OAuth2LoginConfigurer.TokenEndpointConfig tokenEndpoint()

redirectionEndpoint

public OAuth2LoginConfigurer.RedirectionEndpointConfig redirectionEndpoint()

userInfoEndpoint

public OAuth2LoginConfigurer.UserInfoEndpointConfig userInfoEndpoint()

init

public void init(B http)
          throws java.lang.Exception

Description copied from interface: SecurityConfigurer

Initialize the SecurityBuilder. Here only shared state should be created and modified, but not properties on the SecurityBuilder used for building the object. This ensures that the SecurityConfigurer.configure(SecurityBuilder) method uses the correct shared objects when building.

Specified by:

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

Overrides:

init in class AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>,org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter>

Throws:

java.lang.Exception

configure

public void configure(B http)
               throws java.lang.Exception

Description copied from interface: SecurityConfigurer

Configure the SecurityBuilder by setting the necessary properties on the SecurityBuilder.

Specified by:

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

Overrides:

configure in class AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>,org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter>

Throws:

java.lang.Exception

createLoginProcessingUrlMatcher

protected org.springframework.security.web.util.matcher.RequestMatcher createLoginProcessingUrlMatcher(java.lang.String loginProcessingUrl)

Description copied from class: AbstractAuthenticationFilterConfigurer

Create the RequestMatcher given a loginProcessingUrl

Specified by:

createLoginProcessingUrlMatcher in class AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>,org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter>

Parameters:

loginProcessingUrl - creates the RequestMatcher based upon the loginProcessingUrl

Returns:

the RequestMatcher to use based upon the loginProcessingUrl