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