クラス OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>
java.lang.ObjectSE
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
が利用可能な場合、デフォルトのログインページが利用可能になりますOidcSessionRegistry
ネストされたクラスのサマリー
ネストされたクラス修飾子と型クラス説明final class
認可サーバーの認可エンドポイントの構成オプション。final class
クライアントのリダイレクトエンドポイントの構成オプション。final class
認可サーバーのトークンエンドポイントの構成オプション。final class
認可サーバーの UserInfo エンドポイントの構成オプション。コンストラクターのサマリー
コンストラクターメソッドのサマリー
修飾子と型メソッド説明非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。7.0 の取り外し用。authorizationEndpoint
(Customizer<OAuth2LoginConfigurer<B>.AuthorizationEndpointConfig> authorizationEndpointCustomizer) 認可サーバーの認可エンドポイントを構成します。authorizedClientRepository
(OAuth2AuthorizedClientRepository authorizedClientRepository) 認可されたクライアントのリポジトリを設定します。authorizedClientService
(OAuth2AuthorizedClientService authorizedClientService) 認可されたクライアントのサービスを設定します。clientRegistrationRepository
(ClientRegistrationRepository clientRegistrationRepository) クライアント登録のリポジトリを設定します。void
SecurityBuilder
に必要なプロパティを設定して、SecurityBuilder
を構成します。protected RequestMatcher
createLoginProcessingUrlMatcher
(StringSE loginProcessingUrl) loginProcessingUrl を与えられたRequestMatcher
を作成するvoid
SecurityBuilder
を初期化します。ログインが必要な場合にユーザーを送信する URL を指定します。loginProcessingUrl
(StringSE loginProcessingUrl) 資格情報を検証する URL を指定します。oidcSessionRegistry
(OidcSessionRegistry oidcSessionRegistry) OIDC クライアントとプロバイダーのセッションリンクを管理するためのレジストリを設定します非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。7.0 の取り外し用。redirectionEndpoint
(Customizer<OAuth2LoginConfigurer<B>.RedirectionEndpointConfig> redirectionEndpointCustomizer) クライアントのリダイレクトエンドポイントを構成します。非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。7.0 の取り外し用。tokenEndpoint
(Customizer<OAuth2LoginConfigurer<B>.TokenEndpointConfig> tokenEndpointCustomizer) 認可サーバーのトークンエンドポイントを構成します。非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。7.0 の取り外し用。userInfoEndpoint
(Customizer<OAuth2LoginConfigurer<B>.UserInfoEndpointConfig> userInfoEndpointCustomizer) Authorization Server の UserInfo エンドポイントを構成します。クラス 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, getSecurityContextHolderStrategy, withObjectPostProcessor
クラス org.springframework.security.config.annotation.SecurityConfigurerAdapter から継承されたメソッド
addObjectPostProcessor, and, getBuilder, postProcess, setBuilder
コンストラクターの詳細
OAuth2LoginConfigurer
public OAuth2LoginConfigurer()
メソッドの詳細
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
クラスからコピーされた説明:AbstractAuthenticationFilterConfigurer
ログインが必要な場合にユーザーを送信する URL を指定します。
EnableWebSecurity
で使用すると、この属性が指定されていない場合にデフォルトのログインページが生成されます。URL が指定されている場合、またはこれが
EnableWebSecurity
と組み合わせて使用されていない場合、ユーザーは指定された URL を処理してログインページを生成する必要があります。- オーバーライド:
- クラス
AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,
のOAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>, OAuth2LoginAuthenticationFilter> loginPage
loginProcessingUrl
クラスからコピーされた説明:AbstractAuthenticationFilterConfigurer
資格情報を検証する URL を指定します。- オーバーライド:
- クラス
AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,
のOAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>, OAuth2LoginAuthenticationFilter> loginProcessingUrl
- パラメーター:
loginProcessingUrl
- ユーザー名とパスワードを検証する URL- 戻り値:
- 追加のカスタマイズのための
FormLoginConfigurer
oidcSessionRegistry
OIDC クライアントとプロバイダーのセッションリンクを管理するためのレジストリを設定します- パラメーター:
oidcSessionRegistry
- 使用するOidcSessionRegistry
- 戻り値:
- さらなる構成のための
OAuth2LoginConfigurer
- 導入:
- 6.2
authorizationEndpoint
@DeprecatedSE(since="6.1", forRemoval=true) public OAuth2LoginConfigurer<B>.AuthorizationEndpointConfig authorizationEndpoint()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。7.0 の取り外し用。代わりにauthorizationEndpoint(Customizer)
を使用してください認可サーバーの認可エンドポイントを構成するためのOAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.AuthorizationEndpointConfig
を返します。- 戻り値:
OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.AuthorizationEndpointConfig
authorizationEndpoint
public OAuth2LoginConfigurer<B> authorizationEndpoint(Customizer<OAuth2LoginConfigurer<B>.AuthorizationEndpointConfig> authorizationEndpointCustomizer) 認可サーバーの認可エンドポイントを構成します。- パラメーター:
authorizationEndpointCustomizer
-OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.AuthorizationEndpointConfig
により多くのオプションを提供するCustomizer
- 戻り値:
- さらにカスタマイズするための
OAuth2LoginConfigurer
tokenEndpoint
@DeprecatedSE(since="6.1", forRemoval=true) public OAuth2LoginConfigurer<B>.TokenEndpointConfig tokenEndpoint()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。7.0 の取り外し用。デフォルトをそのまま使用するには、tokenEndpoint(Customizer)
またはtokenEndpoint(Customizer.withDefaults())
を使用します。詳細については、ドキュメントを参照してください。認可サーバーのトークンエンドポイントを構成するためのOAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.TokenEndpointConfig
を返します。- 戻り値:
OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.TokenEndpointConfig
tokenEndpoint
public OAuth2LoginConfigurer<B> tokenEndpoint(Customizer<OAuth2LoginConfigurer<B>.TokenEndpointConfig> tokenEndpointCustomizer) 認可サーバーのトークンエンドポイントを構成します。- パラメーター:
tokenEndpointCustomizer
-OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.TokenEndpointConfig
により多くのオプションを提供するCustomizer
- 戻り値:
- さらにカスタマイズするための
OAuth2LoginConfigurer
- 例外:
ExceptionSE
redirectionEndpoint
@DeprecatedSE(since="6.1", forRemoval=true) public OAuth2LoginConfigurer<B>.RedirectionEndpointConfig redirectionEndpoint()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。7.0 の取り外し用。代わりにredirectionEndpoint(Customizer)
を使用してくださいクライアントのリダイレクトエンドポイントを構成するためのOAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.RedirectionEndpointConfig
を返します。- 戻り値:
OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.RedirectionEndpointConfig
redirectionEndpoint
public OAuth2LoginConfigurer<B> redirectionEndpoint(Customizer<OAuth2LoginConfigurer<B>.RedirectionEndpointConfig> redirectionEndpointCustomizer) クライアントのリダイレクトエンドポイントを構成します。- パラメーター:
redirectionEndpointCustomizer
-OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.RedirectionEndpointConfig
により多くのオプションを提供するCustomizer
- 戻り値:
- さらにカスタマイズするための
OAuth2LoginConfigurer
userInfoEndpoint
@DeprecatedSE(since="6.1", forRemoval=true) public OAuth2LoginConfigurer<B>.UserInfoEndpointConfig userInfoEndpoint()非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。7.0 の取り外し用。デフォルトをそのまま使用するには、userInfoEndpoint(Customizer)
またはuserInfoEndpoint(Customizer.withDefaults())
を使用します。詳細については、ドキュメントを参照してください。認可サーバーの UserInfo エンドポイントを構成するためのOAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.UserInfoEndpointConfig
を返します。- 戻り値:
OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.UserInfoEndpointConfig
userInfoEndpoint
public OAuth2LoginConfigurer<B> userInfoEndpoint(Customizer<OAuth2LoginConfigurer<B>.UserInfoEndpointConfig> userInfoEndpointCustomizer) Authorization Server の UserInfo エンドポイントを構成します。- パラメーター:
userInfoEndpointCustomizer
-OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>.UserInfoEndpointConfig
により多くのオプションを提供するCustomizer
- 戻り値:
- さらにカスタマイズするための
OAuth2LoginConfigurer
init
インターフェースからコピーされた説明: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
- 例外:
ExceptionSE
configure
インターフェースからコピーされた説明:SecurityConfigurer
SecurityBuilder
に必要なプロパティを設定して、SecurityBuilder
を構成します。- 次で指定:
- インターフェース
SecurityConfigurer<DefaultSecurityFilterChain,
のB extends HttpSecurityBuilder<B>> configure
- オーバーライド:
- クラス
AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,
のOAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>, OAuth2LoginAuthenticationFilter> configure
- 例外:
ExceptionSE
createLoginProcessingUrlMatcher
クラスからコピーされた説明:AbstractAuthenticationFilterConfigurer
loginProcessingUrl を与えられたRequestMatcher
を作成する- 次で指定:
- クラス
AbstractAuthenticationFilterConfigurer<B extends HttpSecurityBuilder<B>,
のOAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>, OAuth2LoginAuthenticationFilter> createLoginProcessingUrlMatcher
- パラメーター:
loginProcessingUrl
- loginProcessingUrl に基づいてRequestMatcher
を作成します- 戻り値:
- loginProcessingUrl に基づいて使用する
RequestMatcher