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

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

実装されたすべてのインターフェース:: SecurityConfigurer<DefaultSecurityFilterChain,B>

public final class OAuth2LoginConfigurer> extends AbstractAuthenticationFilterConfigurer<B,OAuth2LoginConfigurer,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

導入:

5.0

関連事項:

ネストされたクラスのサマリー
ネストされたクラス
修飾子と型
クラス
説明
final class
OAuth2LoginConfigurer.AuthorizationEndpointConfig
認可サーバーの認可エンドポイントの構成オプション。
final class
OAuth2LoginConfigurer.RedirectionEndpointConfig
クライアントのリダイレクトエンドポイントの構成オプション。
final class
OAuth2LoginConfigurer.TokenEndpointConfig
認可サーバーのトークンエンドポイントの構成オプション。
final class
OAuth2LoginConfigurer.UserInfoEndpointConfig
認可サーバーの UserInfo エンドポイントの構成オプション。
コンストラクターのサマリー
コンストラクター
コンストラクター
説明
OAuth2LoginConfigurer()
メソッドのサマリー
修飾子と型
メソッド
説明
OAuth2LoginConfigurer.AuthorizationEndpointConfig
authorizationEndpoint()
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
7.0 の取り外し用。
OAuth2LoginConfigurer
authorizationEndpoint(Customizer<OAuth2LoginConfigurer.AuthorizationEndpointConfig> authorizationEndpointCustomizer)
認可サーバーの認可エンドポイントを構成します。
OAuth2LoginConfigurer
authorizedClientRepository(OAuth2AuthorizedClientRepository authorizedClientRepository)
認可されたクライアントのリポジトリを設定します。
OAuth2LoginConfigurer
authorizedClientService(OAuth2AuthorizedClientService authorizedClientService)
認可されたクライアントのサービスを設定します。
OAuth2LoginConfigurer
clientRegistrationRepository(ClientRegistrationRepository clientRegistrationRepository)
クライアント登録のリポジトリを設定します。
void
configure(B http)
SecurityBuilder に必要なプロパティを設定して、SecurityBuilder を構成します。
protected RequestMatcher
createLoginProcessingUrlMatcher(StringSE loginProcessingUrl)
loginProcessingUrl を指定して RequestMatcher を作成します
void
init(B http)
SecurityBuilder を初期化します。
OAuth2LoginConfigurer
loginPage(StringSE loginPage)
ログインが必要な場合にユーザーを送信する URL を指定します。
OAuth2LoginConfigurer
loginProcessingUrl(StringSE loginProcessingUrl)
資格情報を検証する URL を指定します。
OAuth2LoginConfigurer
oidcSessionRegistry(OidcSessionRegistry oidcSessionRegistry)
OIDC クライアントとプロバイダーのセッションリンクを管理するためのレジストリを設定します
OAuth2LoginConfigurer.RedirectionEndpointConfig
redirectionEndpoint()
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
7.0 の取り外し用。
OAuth2LoginConfigurer
redirectionEndpoint(Customizer<OAuth2LoginConfigurer.RedirectionEndpointConfig> redirectionEndpointCustomizer)
クライアントのリダイレクトエンドポイントを構成します。
OAuth2LoginConfigurer.TokenEndpointConfig
tokenEndpoint()
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
7.0 の取り外し用。
OAuth2LoginConfigurer
tokenEndpoint(Customizer<OAuth2LoginConfigurer.TokenEndpointConfig> tokenEndpointCustomizer)
認可サーバーのトークンエンドポイントを構成します。
OAuth2LoginConfigurer.UserInfoEndpointConfig
userInfoEndpoint()
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
7.0 の取り外し用。
OAuth2LoginConfigurer
userInfoEndpoint(Customizer<OAuth2LoginConfigurer.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
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

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

クラス OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>>

セキュリティフィルター

作成された共有オブジェクト

使用される共有オブジェクト

ネストされたクラスのサマリー

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.security.config.annotation.web.configurers.AbstractAuthenticationFilterConfigurer から継承されたメソッド

クラス org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer から継承されたメソッド

クラス org.springframework.security.config.annotation.SecurityConfigurerAdapter から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

OAuth2LoginConfigurer

メソッドの詳細

clientRegistrationRepository

authorizedClientRepository

authorizedClientService

loginPage

loginProcessingUrl

oidcSessionRegistry

authorizationEndpoint

authorizationEndpoint

tokenEndpoint

tokenEndpoint

redirectionEndpoint

redirectionEndpoint

userInfoEndpoint

userInfoEndpoint

init

configure

createLoginProcessingUrlMatcher