クラス OAuth2DeviceVerificationAuthenticationProvider
java.lang.ObjectSE
org.springframework.security.oauth2.server.authorization.authentication.OAuth2DeviceVerificationAuthenticationProvider
- 実装済みのインターフェース一覧:
AuthenticationProvider
public final class OAuth2DeviceVerificationAuthenticationProvider
extends ObjectSE
implements AuthenticationProvider
OAuth 2.0 デバイス認可付与で使用されるデバイス検証リクエスト (ユーザーコードの送信) の
AuthenticationProvider 実装。- 導入:
- 7.0
- 関連事項:
OAuth2DeviceVerificationAuthenticationTokenOAuth2DeviceAuthorizationRequestAuthenticationProviderOAuth2DeviceAuthorizationConsentAuthenticationProviderOAuth2DeviceCodeAuthenticationProviderRegisteredClientRepositoryOAuth2AuthorizationServiceOAuth2AuthorizationConsentService- OAuth 2.0 デバイス認証付与
- セクション 3.3 ユーザー対話
コンストラクター概要
コンストラクターコンストラクター説明OAuth2DeviceVerificationAuthenticationProvider(RegisteredClientRepository registeredClientRepository, OAuth2AuthorizationService authorizationService, OAuth2AuthorizationConsentService authorizationConsentService) 指定されたパラメーターを使用してOAuth2DeviceVerificationAuthenticationProviderを構築します。方法の概要
修飾子と型メソッド説明authenticate(Authentication authentication) AuthenticationManager.authenticate(Authentication)と同じ契約で認証を実行します。voidsetAuthorizationConsentRequired(PredicateSE<OAuth2DeviceVerificationAuthenticationContext> authorizationConsentRequired) 認可同意が必要かどうかを判断するために使用されるPredicateを設定します。booleanこのAuthenticationProviderが指定されたAuthenticationオブジェクトをサポートしている場合は、trueを返します。
コンストラクターの詳細
OAuth2DeviceVerificationAuthenticationProvider
public OAuth2DeviceVerificationAuthenticationProvider(RegisteredClientRepository registeredClientRepository, OAuth2AuthorizationService authorizationService, OAuth2AuthorizationConsentService authorizationConsentService) 指定されたパラメーターを使用してOAuth2DeviceVerificationAuthenticationProviderを構築します。- パラメーター:
registeredClientRepository- 登録済みクライアントのリポジトリauthorizationService- 認可サービスauthorizationConsentService- 認可同意サービス
メソッドの詳細
authenticate
インターフェースからコピーされた説明:AuthenticationProviderAuthenticationManager.authenticate(Authentication)と同じ契約で認証を実行します。- 次で指定:
- インターフェース
AuthenticationProviderのauthenticate - パラメーター:
authentication- 認証リクエストオブジェクト。- 戻り値:
- 資格情報を含む完全に認証されたオブジェクト。
AuthenticationProviderが、渡されたAuthenticationオブジェクトの認証をサポートできない場合、nullを返すことがあります。そのような場合、提示されたAuthenticationクラスをサポートする次のAuthenticationProviderが試行されます。 - 例外:
AuthenticationException- 認証が失敗した場合。
supports
インターフェースからコピーされた説明:AuthenticationProviderこのAuthenticationProviderが指定されたAuthenticationオブジェクトをサポートする場合、trueを返します。trueを返しても、AuthenticationProviderが提示されたAuthenticationオブジェクトを認証できることは保証されません。これは単に、より詳細な評価をサポートできることを示しているだけです。AuthenticationProviderは、AuthenticationProvider.authenticate(Authentication)メソッドからnullを返して、別のAuthenticationProviderを試す必要があることを示すことができます。認証を実行できる
AuthenticationProviderの選択は、実行時にProviderManagerによって行われます。- 次で指定:
- インターフェース
AuthenticationProviderのsupports - 戻り値:
- 実装が提示された
Authenticationクラスをより厳密に評価できる場合はtrue
setAuthorizationConsentRequired
public void setAuthorizationConsentRequired(PredicateSE<OAuth2DeviceVerificationAuthenticationContext> authorizationConsentRequired) 認可同意が必要かどうかを判断するために使用されるPredicateを設定します。OAuth2DeviceVerificationAuthenticationContextは述語にOAuth2DeviceVerificationAuthenticationTokenへのアクセスと、次のコンテキスト属性を提供します。- デバイス認証リクエストに関連付けられた
RegisteredClient。 - デバイス認証リクエストパラメーターを含む
OAuth2Authorization。 - 以前に
RegisteredClientに付与されたOAuth2AuthorizationConsent、または利用できない場合はnull。
- パラメーター:
authorizationConsentRequired- 認可同意が必要かどうかを判断するために使用されるPredicate
- デバイス認証リクエストに関連付けられた