パッケージ org.springframework.security.oauth2.client.authentication

クラス OAuth2AuthorizationCodeAuthenticationProvider

java.lang.ObjectSE
org.springframework.security.oauth2.client.authentication.OAuth2AuthorizationCodeAuthenticationProvider
実装されたすべてのインターフェース:
AuthenticationProvider
public class OAuth2AuthorizationCodeAuthenticationProvider extends ObjectSE implements AuthenticationProvider
OAuth 2.0 Authorization Code Grant の AuthenticationProvider の実装。

この AuthenticationProvider は、認可サーバーのトークンエンドポイントで認可コードの資格情報を認証し、有効な場合はアクセストークンの資格情報と交換します。

導入:
5.1
関連事項:

  • コンストラクターの詳細

    • OAuth2AuthorizationCodeAuthenticationProvider

      public OAuth2AuthorizationCodeAuthenticationProvider(OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient)
      指定されたパラメーターを使用して OAuth2AuthorizationCodeAuthenticationProvider を構築します。
      パラメーター:
      accessTokenResponseClient - トークンエンドポイントからアクセストークンクレデンシャルをリクエストするために使用されるクライアント

  • メソッドの詳細

    • authenticate

      public Authentication authenticate(Authentication authentication) throws AuthenticationException
      インターフェースからコピーされた説明: AuthenticationProvider
      AuthenticationManager.authenticate(Authentication) と同じ契約で認証を実行します。
      次で指定:
      インターフェース AuthenticationProvider の authenticate 
      パラメーター:
      authentication - 認証リクエストオブジェクト。
      戻り値:
      資格情報を含む完全に認証されたオブジェクト。AuthenticationProvider が、渡された Authentication オブジェクトの認証をサポートできない場合、null を返すことがあります。そのような場合、提示された Authentication クラスをサポートする次の AuthenticationProvider が試行されます。
      例外:
      AuthenticationException - 認証が失敗した場合。

    • supports

      public boolean supports(ClassSE<?> authentication)
      インターフェースからコピーされた説明: AuthenticationProvider
      この AuthenticationProvider が指定された Authentication オブジェクトをサポートする場合、true を返します。

      true を返しても、AuthenticationProvider が提示された Authentication オブジェクトを認証できることは保証されません。これは単に、より詳細な評価をサポートできることを示しているだけです。AuthenticationProvider は、AuthenticationProvider.authenticate(Authentication) メソッドから null を返して、別の AuthenticationProvider を試す必要があることを示すことができます。

      認証を実行できる AuthenticationProvider の選択は、実行時に ProviderManager で行われます。

      次で指定:
      インターフェース AuthenticationProvider の supports 
      戻り値:
      実装が提示された Authentication クラスをより厳密に評価できる場合は true