Skip to content

Commit b64bcda

Browse files
committed
Javadoc updates
1 parent 2f808a5 commit b64bcda

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/web/function/client/OAuth2ClientHttpRequestInterceptor.java

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,15 @@
9191
* {@link RemoveAuthorizedClientOAuth2AuthorizationFailureHandler} which can be provided
9292
* to {@link #setAuthorizationFailureHandler(OAuth2AuthorizationFailureHandler)}.
9393
*
94+
* <p>
95+
* For example:
96+
*
97+
* <pre>
98+
* OAuth2AuthorizationFailureHandler authorizationFailureHandler =
99+
* OAuth2ClientHttpRequestInterceptor.authorizationFailureHandler(authorizedClientRepository);
100+
* requestInterceptor.setAuthorizationFailureHandler(authorizationFailureHandler);
101+
* </pre>
102+
*
94103
* @author Steve Riesenberg
95104
* @since 6.4
96105
* @see OAuth2AuthorizedClientManager
@@ -184,6 +193,7 @@ public void setAuthorizationFailureHandler(OAuth2AuthorizationFailureHandler aut
184193
* new token is retrieved from the Authorization Server and used for future requests
185194
* to the Resource Server.
186195
* @param authorizedClientRepository the repository of authorized clients
196+
* @see #setAuthorizationFailureHandler(OAuth2AuthorizationFailureHandler)
187197
*/
188198
public static OAuth2AuthorizationFailureHandler authorizationFailureHandler(
189199
OAuth2AuthorizedClientRepository authorizedClientRepository) {
@@ -205,7 +215,7 @@ public static OAuth2AuthorizationFailureHandler authorizationFailureHandler(
205215
* using a {@link OAuth2AuthorizedClientService}.
206216
*
207217
* <p>
208-
* When this setter is used, authentication (HTTP 401) and authorization (HTTP 403)
218+
* When this method is used, authentication (HTTP 401) and authorization (HTTP 403)
209219
* failures returned from an OAuth 2.0 Resource Server will be forwarded to a
210220
* {@link RemoveAuthorizedClientOAuth2AuthorizationFailureHandler}, which will
211221
* potentially remove the {@link OAuth2AuthorizedClient} from the given
@@ -217,6 +227,7 @@ public static OAuth2AuthorizationFailureHandler authorizationFailureHandler(
217227
* new token is retrieved from the Authorization Server and used for future requests
218228
* to the Resource Server.
219229
* @param authorizedClientService the service used to manage authorized clients
230+
* @see #setAuthorizationFailureHandler(OAuth2AuthorizationFailureHandler)
220231
*/
221232
public static OAuth2AuthorizationFailureHandler authorizationFailureHandler(
222233
OAuth2AuthorizedClientService authorizedClientService) {

0 commit comments

Comments
 (0)