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