Update javadoc AuthorizationCodeOAuth2AuthorizedClientProvider

Closes gh-9708
This commit is contained in:
Asian Malaysian Vietnamese 2021-05-07 12:40:27 +08:00 committed by Joe Grandja
parent ef0d933a65
commit 5f6de026a8
2 changed files with 14 additions and 6 deletions

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2019 the original author or authors. * Copyright 2002-2021 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -18,6 +18,7 @@ package org.springframework.security.oauth2.client;
import org.springframework.lang.Nullable; import org.springframework.lang.Nullable;
import org.springframework.security.oauth2.client.registration.ClientRegistration; import org.springframework.security.oauth2.client.registration.ClientRegistration;
import org.springframework.security.oauth2.client.web.OAuth2AuthorizationRequestRedirectFilter;
import org.springframework.security.oauth2.core.AuthorizationGrantType; import org.springframework.security.oauth2.core.AuthorizationGrantType;
import org.springframework.util.Assert; import org.springframework.util.Assert;
@ -39,8 +40,11 @@ public final class AuthorizationCodeOAuth2AuthorizedClientProvider implements OA
* not {@link AuthorizationGrantType#AUTHORIZATION_CODE authorization_code} OR the * not {@link AuthorizationGrantType#AUTHORIZATION_CODE authorization_code} OR the
* client is already authorized. * client is already authorized.
* @param context the context that holds authorization-specific state for the client * @param context the context that holds authorization-specific state for the client
* @return the {@link OAuth2AuthorizedClient} or {@code null} if authorization is not * @return {@code null} if authorization is not supported or the client is already
* supported * authorized
* @throws ClientAuthorizationRequiredException in order to trigger authorization in
* which the {@link OAuth2AuthorizationRequestRedirectFilter} will catch and initiate
* the authorization request
*/ */
@Override @Override
@Nullable @Nullable

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2019 the original author or authors. * Copyright 2002-2021 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -19,6 +19,7 @@ package org.springframework.security.oauth2.client;
import reactor.core.publisher.Mono; import reactor.core.publisher.Mono;
import org.springframework.security.oauth2.client.registration.ClientRegistration; import org.springframework.security.oauth2.client.registration.ClientRegistration;
import org.springframework.security.oauth2.client.web.server.OAuth2AuthorizationRequestRedirectWebFilter;
import org.springframework.security.oauth2.core.AuthorizationGrantType; import org.springframework.security.oauth2.core.AuthorizationGrantType;
import org.springframework.util.Assert; import org.springframework.util.Assert;
@ -41,8 +42,11 @@ public final class AuthorizationCodeReactiveOAuth2AuthorizedClientProvider
* not {@link AuthorizationGrantType#AUTHORIZATION_CODE authorization_code} OR the * not {@link AuthorizationGrantType#AUTHORIZATION_CODE authorization_code} OR the
* client is already authorized. * client is already authorized.
* @param context the context that holds authorization-specific state for the client * @param context the context that holds authorization-specific state for the client
* @return the {@link OAuth2AuthorizedClient} or an empty {@code Mono} if * @return an empty {@code Mono} if authorization is not supported or the client is
* authorization is not supported * already authorized
* @throws ClientAuthorizationRequiredException in order to trigger authorization in
* which the {@link OAuth2AuthorizationRequestRedirectWebFilter} will catch and
* initiate the authorization request
*/ */
@Override @Override
public Mono<OAuth2AuthorizedClient> authorize(OAuth2AuthorizationContext context) { public Mono<OAuth2AuthorizedClient> authorize(OAuth2AuthorizationContext context) {