クラス OAuth2LoginAuthenticationProvider
- java.lang.Object
-
- org.springframework.security.oauth2.client.authentication.OAuth2LoginAuthenticationProvider
- 実装されたすべてのインターフェース:
AuthenticationProvider
public class OAuth2LoginAuthenticationProvider extends java.lang.Object implements AuthenticationProvider
OAuth 2.0 認証コード付与フローを活用する OAuth 2.0 ログイン用のAuthenticationProvider
の実装。このAuthenticationProvider
は、認証サーバーのトークンエンドポイントを使用して認証コードのクレデンシャルを認証し、有効な場合はアクセストークンのクレデンシャルと交換するロールを果たします。また、
OAuth2UserService
を使用して UserInfo エンドポイントからエンドユーザー(リソース所有者)のユーザー属性を取得し、OAuth2User
の形式でPrincipal
を作成します。次に、OAuth2User
がOAuth2LoginAuthenticationToken
に関連付けられ、認証が完了します。
コンストラクターのサマリー
コンストラクター コンストラクター 説明 OAuth2LoginAuthenticationProvider(OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient, OAuth2UserService<OAuth2UserRequest,OAuth2User> userService)
指定されたパラメーターを使用してOAuth2LoginAuthenticationProvider
を構築します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 Authentication
authenticate(Authentication authentication)
AuthenticationManager.authenticate(Authentication)
と同じ契約で認証を実行します。void
setAuthoritiesMapper(GrantedAuthoritiesMapper authoritiesMapper)
OAuth2AuthenticatedPrincipal.getAuthorities()
をOAuth2LoginAuthenticationToken
に関連付けられる新しい権限のセットにマッピングするために使用されるGrantedAuthoritiesMapper
を設定します。boolean
supports(java.lang.Class<?> authentication)
このAuthenticationProvider
が指定されたAuthentication
オブジェクトをサポートする場合、true
を返します。
コンストラクターの詳細
OAuth2LoginAuthenticationProvider
public OAuth2LoginAuthenticationProvider(OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient, OAuth2UserService<OAuth2UserRequest,OAuth2User> userService)
指定されたパラメーターを使用してOAuth2LoginAuthenticationProvider
を構築します。- パラメーター:
accessTokenResponseClient
- トークンエンドポイントからアクセストークンクレデンシャルをリクエストするために使用されるクライアントuserService
- UserInfo エンドポイントからエンドユーザーのユーザー属性を取得するために使用されるサービス
メソッドの詳細
authenticate
public Authentication authenticate(Authentication authentication) throws AuthenticationException
インターフェースからコピーされた説明:AuthenticationProvider
AuthenticationManager.authenticate(Authentication)
と同じ契約で認証を実行します。- 次で指定:
- インターフェース
AuthenticationProvider
のauthenticate
- パラメーター:
authentication
- 認証リクエストオブジェクト。- 戻り値:
- 資格情報を含む完全に認証されたオブジェクト。
AuthenticationProvider
が、渡されたAuthentication
オブジェクトの認証をサポートできない場合、null
を返すことがあります。そのような場合、提示されたAuthentication
クラスをサポートする次のAuthenticationProvider
が試行されます。 - 例外:
AuthenticationException
- 認証が失敗した場合。
setAuthoritiesMapper
public final void setAuthoritiesMapper(GrantedAuthoritiesMapper authoritiesMapper)
OAuth2AuthenticatedPrincipal.getAuthorities()
をOAuth2LoginAuthenticationToken
に関連付けられる新しい権限のセットにマッピングするために使用されるGrantedAuthoritiesMapper
を設定します。- パラメーター:
authoritiesMapper
- ユーザーの権限のマッピングに使用されるGrantedAuthoritiesMapper
supports
public boolean supports(java.lang.Class<?> authentication)
インターフェースからコピーされた説明:AuthenticationProvider
このAuthenticationProvider
が指定されたAuthentication
オブジェクトをサポートする場合、true
を返します。true
を返すことは、AuthenticationProvider
がAuthentication
クラスの提示されたインスタンスを認証できることを保証しません。それは、それがより詳細な評価をサポートできることを示しています。AuthenticationProvider
は、AuthenticationProvider.authenticate(Authentication)
メソッドからnull
を返して、別のAuthenticationProvider
を試す必要があることを示すことができます。認証を実行できる
AuthenticationProvider
の選択は、実行時にProviderManager
で行われます。- 次で指定:
- インターフェース
AuthenticationProvider
のsupports
- 戻り値:
- 実装が提示された
Authentication
クラスをより厳密に評価できる場合はtrue