クラス AuthorizedClientServiceOAuth2AuthorizedClientManager
- 実装されているすべてのインターフェース:
OAuth2AuthorizedClientManager
HttpServletRequest のコンテキスト外で動作できる OAuth2AuthorizedClientManager の実装。スケジュールされた / バックグラウンドスレッドおよび / またはサービス層。(HttpServletRequest のコンテキスト内で操作する場合は、代わりに DefaultOAuth2AuthorizedClientManager を使用してください)
承認されたクライアントの永続性
このマネージャーは OAuth2AuthorizedClientService を使用して OAuth2AuthorizedClient を永続化します。
デフォルトでは、認証の試行が成功すると、OAuth2AuthorizedClient が OAuth2AuthorizedClientService に保存されます。この機能は、setAuthorizationSuccessHandler(OAuth2AuthorizationSuccessHandler) を介してカスタム OAuth2AuthorizationSuccessHandler を構成することで変更できます。
デフォルトでは、 "invalid_grant" エラーが原因で認証の試行が失敗すると、以前に保存された OAuth2AuthorizedClient が OAuth2AuthorizedClientService から削除されます。( "invalid_grant" エラーは、無効になったリフレッシュトークンを使用して新しいアクセストークンを取得すると発生する可能性があります)この機能は、setAuthorizationFailureHandler(OAuth2AuthorizationFailureHandler) を介してカスタム OAuth2AuthorizationFailureHandler を構成することで変更できます。
ネストされたクラスの要約
ネストされたクラスコンストラクターの概要
コンストラクターコンストラクター説明AuthorizedClientServiceOAuth2AuthorizedClientManager(ClientRegistrationRepository clientRegistrationRepository, OAuth2AuthorizedClientService authorizedClientService) 指定されたパラメーターを使用してAuthorizedClientServiceOAuth2AuthorizedClientManagerを構築します。メソッドのサマリー
修飾子と型メソッド説明authorize(OAuth2AuthorizeRequest authorizeRequest) 提供されたclientRegistrationIdによって識別されたclientを承認または再承認(必要な場合)します。voidsetAuthorizationFailureHandler(OAuth2AuthorizationFailureHandler authorizationFailureHandler) 認証の失敗を処理するOAuth2AuthorizationFailureHandlerを設定します。voidsetAuthorizationSuccessHandler(OAuth2AuthorizationSuccessHandler authorizationSuccessHandler) 成功した認証を処理するOAuth2AuthorizationSuccessHandlerを設定します。voidsetAuthorizedClientProvider(OAuth2AuthorizedClientProvider authorizedClientProvider) OAuth 2.0 クライアントの認証(または再認証)に使用するOAuth2AuthorizedClientProviderを設定します。voidsetContextAttributesMapper(FunctionSE<OAuth2AuthorizeRequest, MapSE<StringSE, ObjectSE>> contextAttributesMapper) 属性をOAuth2AuthorizeRequestからauthorization contextに関連付けられる属性のMapにマッピングするために使用されるFunctionを設定します。
コンストラクターの詳細
AuthorizedClientServiceOAuth2AuthorizedClientManager
public AuthorizedClientServiceOAuth2AuthorizedClientManager(ClientRegistrationRepository clientRegistrationRepository, OAuth2AuthorizedClientService authorizedClientService) 指定されたパラメーターを使用してAuthorizedClientServiceOAuth2AuthorizedClientManagerを構築します。- パラメーター:
clientRegistrationRepository- クライアント登録のリポジトリauthorizedClientService- 認可されたクライアントサービス
メソッドの詳細
authorize
インターフェースからコピーされた説明:OAuth2AuthorizedClientManager提供されたclientRegistrationIdによって識別されたclientを認可または再認可(必要な場合)します。指定されたクライアントで認証がサポートされていない場合、実装はnullを返す必要があります。関連するOAuth2AuthorizedClientProviderは、クライアント用に構成されたauthorization grant型をサポートしていません。再認証の場合、クライアントで再認証がサポートされていない場合、または必要でない場合、実装は提供された
authorized clientを返す必要があります。refresh tokenが利用できないか、access tokenの有効期限が切れていません。- 次で指定:
- インターフェース
OAuth2AuthorizedClientManagerのauthorize - パラメーター:
authorizeRequest- 承認リクエスト- 戻り値:
- 指定されたクライアントで認可がサポートされていない場合は、
OAuth2AuthorizedClientまたはnull
setAuthorizedClientProvider
OAuth 2.0 クライアントの認証(または再認証)に使用するOAuth2AuthorizedClientProviderを設定します。- パラメーター:
authorizedClientProvider- OAuth 2.0 クライアントの認証(または再認証)に使用されるOAuth2AuthorizedClientProvider
setContextAttributesMapper
public void setContextAttributesMapper(FunctionSE<OAuth2AuthorizeRequest, MapSE<StringSE, ObjectSE>> contextAttributesMapper) 属性をOAuth2AuthorizeRequestからauthorization contextに関連付けられる属性のMapにマッピングするために使用されるFunctionを設定します。- パラメーター:
contextAttributesMapper- 属性のMapをauthorization contextに提供するために使用されるFunction
setAuthorizationSuccessHandler
public void setAuthorizationSuccessHandler(OAuth2AuthorizationSuccessHandler authorizationSuccessHandler) 成功した認証を処理するOAuth2AuthorizationSuccessHandlerを設定します。デフォルトでは、
OAuth2AuthorizedClientがOAuth2AuthorizedClientServiceに保存されます。- パラメーター:
authorizationSuccessHandler- 成功した認証を処理するOAuth2AuthorizationSuccessHandler- 導入:
- 5.3
setAuthorizationFailureHandler
public void setAuthorizationFailureHandler(OAuth2AuthorizationFailureHandler authorizationFailureHandler) 認証の失敗を処理するOAuth2AuthorizationFailureHandlerを設定します。デフォルトでは
RemoveAuthorizedClientOAuth2AuthorizationFailureHandlerが使用されます。- パラメーター:
authorizationFailureHandler- 認証の失敗を処理するOAuth2AuthorizationFailureHandler- 導入:
- 5.3
- 関連事項: