クラス OAuth2AuthorizationCodeRequestAuthenticationProvider

メソッドの詳細

• 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 

• setAuthorizationCodeGenerator

  public void setAuthorizationCodeGenerator(OAuth2TokenGenerator<OAuth2AuthorizationCode> authorizationCodeGenerator)

  OAuth2AuthorizationCode を生成する OAuth2TokenGenerator を設定します。

  パラメーター:

  authorizationCodeGenerator - OAuth2AuthorizationCode を生成する OAuth2TokenGenerator

• setAuthenticationValidator

  public void setAuthenticationValidator(ConsumerSE<OAuth2AuthorizationCodeRequestAuthenticationContext> authenticationValidator)

  OAuth2AuthorizationCodeRequestAuthenticationContext へのアクセスを提供する Consumer を設定し、OAuth2AuthorizationCodeRequestAuthenticationToken に関連付けられた特定の OAuth 2.0 認可リクエストパラメーターを検証します。デフォルトの認証バリデータは OAuth2AuthorizationCodeRequestAuthenticationValidator です。

  注意 : 検証が失敗した場合、認証バリデーターは OAuth2AuthorizationCodeRequestAuthenticationException をスローする必要があります。

  パラメーター:

  authenticationValidator - OAuth2AuthorizationCodeRequestAuthenticationContext へのアクセスを提供する Consumer は、特定の OAuth 2.0 認可リクエストパラメーターの検証を担当します。

• setAuthorizationConsentRequired

  public void setAuthorizationConsentRequired(PredicateSE<OAuth2AuthorizationCodeRequestAuthenticationContext> authorizationConsentRequired)

  認可同意が必要かどうかを判断するために使用される Predicate を設定します。

  OAuth2AuthorizationCodeRequestAuthenticationContext は述語に OAuth2AuthorizationCodeRequestAuthenticationToken へのアクセスと、次のコンテキスト属性を提供します。

  • 認可リクエストに関連付けられた RegisteredClient。
  • 認可リクエストパラメーターを含む OAuth2AuthorizationRequest。
  • 以前に RegisteredClient に付与された OAuth2AuthorizationConsent、または利用できない場合は null。

  パラメーター:

  authorizationConsentRequired - 認可同意が必要かどうかを判断するために使用される Predicate