クラス DefaultReactiveOAuth2AuthorizedClientManager
- 実装されているすべてのインターフェース:
ReactiveOAuth2AuthorizedClientManager
ServerWebExchange のコンテキスト内で使用する ReactiveOAuth2AuthorizedClientManager のデフォルト実装。(ServerWebExchange のコンテキスト外で操作する場合は、代わりに AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager を使用してください)
これは DefaultOAuth2AuthorizedClientManager のリアクティブな同等物です。
承認されたクライアントの永続性
このクライアントマネージャーは、ServerOAuth2AuthorizedClientRepository を使用して OAuth2AuthorizedClient を永続化します。
デフォルトでは、認証の試行が成功すると、OAuth2AuthorizedClient は認証されたクライアントリポジトリに保存されます。この機能は、setAuthorizationSuccessHandler(ReactiveOAuth2AuthorizationSuccessHandler) を介してカスタム ReactiveOAuth2AuthorizationSuccessHandler を構成することで変更できます。
デフォルトでは、 "invalid_grant" エラーが原因で認証の試行が失敗すると、以前に保存された OAuth2AuthorizedClient が認証済みクライアントリポジトリから削除されます。( "invalid_grant" エラーは通常、有効ではなくなったリフレッシュトークンを使用して新しいアクセストークンを取得すると発生します)この機能は、setAuthorizationFailureHandler(ReactiveOAuth2AuthorizationFailureHandler) を介してカスタム ReactiveOAuth2AuthorizationFailureHandler を構成することで変更できます。
ネストされたクラスの要約
ネストされたクラスコンストラクターの概要
コンストラクターコンストラクター説明DefaultReactiveOAuth2AuthorizedClientManager(ReactiveClientRegistrationRepository clientRegistrationRepository, ServerOAuth2AuthorizedClientRepository authorizedClientRepository) 指定されたパラメーターを使用してDefaultReactiveOAuth2AuthorizedClientManagerを構築します。メソッドのサマリー
修飾子と型メソッド説明reactor.core.publisher.Mono<OAuth2AuthorizedClient>authorize(OAuth2AuthorizeRequest authorizeRequest) 提供されたclientRegistrationIdによって識別されたclientを承認または再承認(必要な場合)します。voidsetAuthorizationFailureHandler(ReactiveOAuth2AuthorizationFailureHandler authorizationFailureHandler) 認証の失敗を処理するハンドラーを設定します。voidsetAuthorizationSuccessHandler(ReactiveOAuth2AuthorizationSuccessHandler authorizationSuccessHandler) 成功した認証を処理するハンドラーを設定します。voidsetAuthorizedClientProvider(ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider) OAuth 2.0 クライアントの認証(または再認証)に使用するReactiveOAuth2AuthorizedClientProviderを設定します。voidsetContextAttributesMapper(FunctionSE<OAuth2AuthorizeRequest, reactor.core.publisher.Mono<MapSE<StringSE, ObjectSE>>> contextAttributesMapper) 属性をOAuth2AuthorizeRequestからauthorization contextに関連付けられる属性のMapにマッピングするために使用されるFunctionを設定します。
コンストラクターの詳細
DefaultReactiveOAuth2AuthorizedClientManager
public DefaultReactiveOAuth2AuthorizedClientManager(ReactiveClientRegistrationRepository clientRegistrationRepository, ServerOAuth2AuthorizedClientRepository authorizedClientRepository) 指定されたパラメーターを使用してDefaultReactiveOAuth2AuthorizedClientManagerを構築します。- パラメーター:
clientRegistrationRepository- クライアント登録のリポジトリauthorizedClientRepository- 認可されたクライアントのリポジトリ
メソッドの詳細
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(FunctionSE<OAuth2AuthorizeRequest, reactor.core.publisher.Mono<MapSE<StringSE, ObjectSE>>> contextAttributesMapper) 属性をOAuth2AuthorizeRequestからauthorization contextに関連付けられる属性のMapにマッピングするために使用されるFunctionを設定します。- パラメーター:
contextAttributesMapper- 属性のMapをauthorization contextに提供するために使用されるFunction
setAuthorizationSuccessHandler
public void setAuthorizationSuccessHandler(ReactiveOAuth2AuthorizationSuccessHandler authorizationSuccessHandler) 成功した認証を処理するハンドラーを設定します。デフォルトでは、OAuth2AuthorizedClientがServerOAuth2AuthorizedClientRepositoryに保存されます。- パラメーター:
authorizationSuccessHandler- 成功した認証を処理するハンドラー。- 導入:
- 5.3
setAuthorizationFailureHandler
public void setAuthorizationFailureHandler(ReactiveOAuth2AuthorizationFailureHandler authorizationFailureHandler) 認証の失敗を処理するハンドラーを設定します。デフォルトでは
RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandlerが使用されます。- パラメーター:
authorizationFailureHandler- 認証の失敗を処理するハンドラー。- 導入:
- 5.3
- 関連事項: