クラス OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>
- java.lang.Object
-
- org.springframework.security.config.annotation.SecurityConfigurerAdapter<DefaultSecurityFilterChain,B>
-
- org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer<T,B>
-
- org.springframework.security.config.annotation.web.configurers.AbstractAuthenticationFilterConfigurer<B,OAuth2LoginConfigurer<B>,OAuth2LoginAuthenticationFilter>
-
- org.springframework.security.config.annotation.web.configurers.oauth2.client.OAuth2LoginConfigurer<B>
- 実装されたすべてのインターフェース:
SecurityConfigurer<DefaultSecurityFilterChain,B>
public final class OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>> extends AbstractAuthenticationFilterConfigurer<B,OAuth2LoginConfigurer<B>,OAuth2LoginAuthenticationFilter>
OAuth 2.0 認証コード付与フローを活用する OAuth 2.0 ログイン用のAbstractHttpConfigurer
。OAuth 2.0 Login は、OAuth 2.0 または OpenID Connect 1.0 プロバイダーで既存のアカウントを使用してユーザーをログインさせる機能をアプリケーションに提供します。
すべての構成オプションにデフォルトが提供され、必要な構成は
clientRegistrationRepository(ClientRegistrationRepository)
のみです。または、代わりにClientRegistrationRepository
@Bean
を登録できます。セキュリティフィルター
次のFilter
が読み込まれます。作成された共有オブジェクト
次の共有オブジェクトが読み込まれます。ClientRegistrationRepository
(必須)OAuth2AuthorizedClientRepository
(オプション)GrantedAuthoritiesMapper
(オプション)
使用される共有オブジェクト
次の共有オブジェクトが使用されます。ClientRegistrationRepository
OAuth2AuthorizedClientRepository
GrantedAuthoritiesMapper
DefaultLoginPageGeneratingFilter
-loginPage(String)
が設定されておらず、DefaultLoginPageGeneratingFilter
が利用可能な場合、デフォルトのログインページが利用可能になります
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 class
OAuth2LoginConfigurer.AuthorizationEndpointConfig
認可サーバーの認可エンドポイントの構成オプション。class
OAuth2LoginConfigurer.RedirectionEndpointConfig
クライアントのリダイレクトエンドポイントの構成オプション。class
OAuth2LoginConfigurer.TokenEndpointConfig
認可サーバーのトークンエンドポイントの構成オプション。class
OAuth2LoginConfigurer.UserInfoEndpointConfig
認可サーバーの UserInfo エンドポイントの構成オプション。
コンストラクターのサマリー
コンストラクター コンストラクター 説明 OAuth2LoginConfigurer()
メソッドのサマリー
クラス org.springframework.security.config.annotation.web.configurers.AbstractAuthenticationFilterConfigurer から継承されたメソッド
authenticationDetailsSource, defaultSuccessUrl, defaultSuccessUrl, failureHandler, failureUrl, getAuthenticationEntryPoint, getAuthenticationEntryPointMatcher, getAuthenticationFilter, getFailureUrl, getLoginPage, getLoginProcessingUrl, isCustomLoginPage, permitAll, permitAll, registerAuthenticationEntryPoint, registerDefaultAuthenticationEntryPoint, securityContextRepository, setAuthenticationFilter, successHandler, updateAccessDefaults, updateAuthenticationDefaults
クラス org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer から継承されたメソッド
disable, withObjectPostProcessor
クラス org.springframework.security.config.annotation.SecurityConfigurerAdapter から継承されたメソッド
addObjectPostProcessor, and, getBuilder, postProcess, setBuilder
メソッドの詳細
clientRegistrationRepository
public OAuth2LoginConfigurer<B> clientRegistrationRepository(ClientRegistrationRepository clientRegistrationRepository)
クライアント登録のリポジトリを設定します。- パラメーター:
clientRegistrationRepository
- クライアント登録のリポジトリ- 戻り値:
- さらなる構成のための
OAuth2LoginConfigurer
authorizedClientRepository
public OAuth2LoginConfigurer<B> authorizedClientRepository(OAuth2AuthorizedClientRepository authorizedClientRepository)
認可されたクライアントのリポジトリを設定します。- パラメーター:
authorizedClientRepository
- 認可されたクライアントリポジトリ- 戻り値:
- さらなる構成のための
OAuth2LoginConfigurer
- 導入:
- 5.1
authorizedClientService
public OAuth2LoginConfigurer<B> authorizedClientService(OAuth2AuthorizedClientService authorizedClientService)
認可されたクライアントのサービスを設定します。- パラメーター:
authorizedClientService
- 認可されたクライアントサービス- 戻り値:
- さらなる構成のための
OAuth2LoginConfigurer
loginPage
public OAuth2LoginConfigurer<B> loginPage(java.lang.String loginPage)
クラスからコピーされた説明:AbstractAuthenticationFilterConfigurer
ログインが必要な場合にユーザーを送信する URL を指定します。
EnableWebSecurity
で使用すると、この属性が指定されていない場合にデフォルトのログインページが生成されます。URL が指定されている場合、またはこれが
EnableWebSecurity
と組み合わせて使用されていない場合、ユーザーは指定された URL を処理してログインページを生成する必要があります。- オーバーライド:
- クラス
AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>,OAuth2LoginAuthenticationFilter>
のloginPage
loginProcessingUrl
public OAuth2LoginConfigurer<B> loginProcessingUrl(java.lang.String loginProcessingUrl)
クラスからコピーされた説明:AbstractAuthenticationFilterConfigurer
資格情報を検証する URL を指定します。- オーバーライド:
- クラス
AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>,OAuth2LoginAuthenticationFilter>
のloginProcessingUrl
- パラメーター:
loginProcessingUrl
- ユーザー名とパスワードを検証する URL- 戻り値:
- 追加のカスタマイズのための
FormLoginConfigurer
authorizationEndpoint
public OAuth2LoginConfigurer.AuthorizationEndpointConfig authorizationEndpoint()
認可サーバーの認可エンドポイントを構成するためのOAuth2LoginConfigurer.AuthorizationEndpointConfig
を返します。
authorizationEndpoint
public OAuth2LoginConfigurer<B> authorizationEndpoint(Customizer<OAuth2LoginConfigurer.AuthorizationEndpointConfig> authorizationEndpointCustomizer)
認可サーバーの認可エンドポイントを構成します。- パラメーター:
authorizationEndpointCustomizer
-Customizer
を使用して、OAuth2LoginConfigurer.AuthorizationEndpointConfig
により多くのオプションを提供します。- 戻り値:
- さらにカスタマイズするための
OAuth2LoginConfigurer
tokenEndpoint
public OAuth2LoginConfigurer.TokenEndpointConfig tokenEndpoint()
認可サーバーのトークンエンドポイントを構成するためのOAuth2LoginConfigurer.TokenEndpointConfig
を返します。
tokenEndpoint
public OAuth2LoginConfigurer<B> tokenEndpoint(Customizer<OAuth2LoginConfigurer.TokenEndpointConfig> tokenEndpointCustomizer)
認可サーバーのトークンエンドポイントを構成します。- パラメーター:
tokenEndpointCustomizer
-Customizer
を使用して、OAuth2LoginConfigurer.TokenEndpointConfig
により多くのオプションを提供します。- 戻り値:
- さらにカスタマイズするための
OAuth2LoginConfigurer
- 例外:
java.lang.Exception
redirectionEndpoint
public OAuth2LoginConfigurer.RedirectionEndpointConfig redirectionEndpoint()
クライアントのリダイレクトエンドポイントを構成するためのOAuth2LoginConfigurer.RedirectionEndpointConfig
を返します。
redirectionEndpoint
public OAuth2LoginConfigurer<B> redirectionEndpoint(Customizer<OAuth2LoginConfigurer.RedirectionEndpointConfig> redirectionEndpointCustomizer)
クライアントのリダイレクトエンドポイントを構成します。- パラメーター:
redirectionEndpointCustomizer
-Customizer
を使用して、OAuth2LoginConfigurer.RedirectionEndpointConfig
により多くのオプションを提供します。- 戻り値:
- さらにカスタマイズするための
OAuth2LoginConfigurer
userInfoEndpoint
public OAuth2LoginConfigurer.UserInfoEndpointConfig userInfoEndpoint()
認可サーバーの UserInfo エンドポイントを構成するためのOAuth2LoginConfigurer.UserInfoEndpointConfig
を返します。
userInfoEndpoint
public OAuth2LoginConfigurer<B> userInfoEndpoint(Customizer<OAuth2LoginConfigurer.UserInfoEndpointConfig> userInfoEndpointCustomizer)
Authorization Server の UserInfo エンドポイントを構成します。- パラメーター:
userInfoEndpointCustomizer
-Customizer
を使用して、OAuth2LoginConfigurer.UserInfoEndpointConfig
により多くのオプションを提供します。- 戻り値:
- さらにカスタマイズするための
OAuth2LoginConfigurer
init
public void init(B http) throws java.lang.Exception
インターフェースからコピーされた説明:SecurityConfigurer
SecurityBuilder
を初期化します。ここでは、共有状態のみを作成および変更する必要がありますが、オブジェクトの構築に使用されるSecurityBuilder
のプロパティは作成および変更しないでください。これにより、構築時にSecurityConfigurer.configure(SecurityBuilder)
メソッドが正しい共有オブジェクトを使用するようになります。ここで設定を適用する必要があります。- 次で指定:
- インターフェース
SecurityConfigurer<DefaultSecurityFilterChain,B extends HttpSecurityBuilder<B>>
のinit
- オーバーライド:
- クラス
AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>,OAuth2LoginAuthenticationFilter>
のinit
- 例外:
java.lang.Exception
configure
public void configure(B http) throws java.lang.Exception
インターフェースからコピーされた説明:SecurityConfigurer
SecurityBuilder
に必要なプロパティを設定して、SecurityBuilder
を構成します。- 次で指定:
- インターフェース
SecurityConfigurer<DefaultSecurityFilterChain,B extends HttpSecurityBuilder<B>>
のconfigure
- オーバーライド:
- クラス
AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>,OAuth2LoginAuthenticationFilter>
のconfigure
- 例外:
java.lang.Exception
createLoginProcessingUrlMatcher
protected RequestMatcher createLoginProcessingUrlMatcher(java.lang.String loginProcessingUrl)
クラスからコピーされた説明:AbstractAuthenticationFilterConfigurer
loginProcessingUrl を与えられたRequestMatcher
を作成する- 次で指定:
- クラス
AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>,OAuth2LoginAuthenticationFilter>
のcreateLoginProcessingUrlMatcher
- パラメーター:
loginProcessingUrl
- loginProcessingUrl に基づいてRequestMatcher
を作成します- 戻り値:
- loginProcessingUrl に基づいて使用する
RequestMatcher