Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Grammar Fixes in OAuth 2.0 JavaDoc #16619

Merged
merged 2 commits into from
Feb 25, 2025
Merged

Grammar Fixes in OAuth 2.0 JavaDoc #16619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e72ab0b
Add fourth oauth grant type to javadoc
pat-mccusker Feb 18, 2025
1779760
Use possessive pronoun rather contraction
pat-mccusker Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .../org/springframework/security/oauth2/client/DelegatingOAuth2AuthorizedClientProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -26,7 +26,7 @@

/**
* An implementation of an {@link OAuth2AuthorizedClientProvider} that simply delegates to
* it's internal {@code List} of {@link OAuth2AuthorizedClientProvider}(s).
* its internal {@code List} of {@link OAuth2AuthorizedClientProvider}(s).
* <p>
* Each provider is given a chance to
* {@link OAuth2AuthorizedClientProvider#authorize(OAuth2AuthorizationContext) authorize}
Expand Down
4 changes: 2 additions & 2 deletions ...ingframework/security/oauth2/client/DelegatingReactiveOAuth2AuthorizedClientProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -28,7 +28,7 @@

/**
* An implementation of a {@link ReactiveOAuth2AuthorizedClientProvider} that simply
* delegates to it's internal {@code List} of
* delegates to its internal {@code List} of
* {@link ReactiveOAuth2AuthorizedClientProvider}(s).
* <p>
* Each provider is given a chance to
Expand Down
4 changes: 2 additions & 2 deletions ...ient/src/main/java/org/springframework/security/oauth2/client/OAuth2AuthorizedClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -29,7 +29,7 @@
* A representation of an OAuth 2.0 &quot;Authorized Client&quot;.
* <p>
* A client is considered &quot;authorized&quot; when the End-User (Resource Owner) has
* granted authorization to the client to access it's protected resources.
* granted authorization to the client to access its protected resources.
* <p>
* This class associates the {@link #getClientRegistration() Client} to the
* {@link #getAccessToken() Access Token} granted/authorized by the
Expand Down
4 changes: 2 additions & 2 deletions .../org/springframework/security/oauth2/client/authentication/OAuth2AuthenticationToken.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -32,7 +32,7 @@
* <p>
* The {@link Authentication} associates an {@link OAuth2User} {@code Principal} to the
* identifier of the {@link #getAuthorizedClientRegistrationId() Authorized Client}, which
* the End-User ({@code Principal}) granted authorization to so that it can access it's
* the End-User ({@code Principal}) granted authorization to so that it can access its
* protected resources at the UserInfo Endpoint.
*
* @author Joe Grandja
Expand Down
6 changes: 3 additions & 3 deletions ...java/org/springframework/security/oauth2/client/userinfo/DelegatingOAuth2UserService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -26,8 +26,8 @@
import org.springframework.util.Assert;

/**
* An implementation of an {@link OAuth2UserService} that simply delegates to it's
* internal {@code List} of {@link OAuth2UserService}(s).
* An implementation of an {@link OAuth2UserService} that simply delegates to its internal
* {@code List} of {@link OAuth2UserService}(s).
* <p>
* Each {@link OAuth2UserService} is given a chance to
* {@link OAuth2UserService#loadUser(OAuth2UserRequest) load} an {@link OAuth2User} with
Expand Down
4 changes: 2 additions & 2 deletions ...springframework/security/oauth2/client/web/DefaultOAuth2AuthorizationRequestResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -52,7 +52,7 @@
*
* <p>
* <b>NOTE:</b> The default base {@code URI} {@code /oauth2/authorization} may be
* overridden via it's constructor
* overridden via its constructor
* {@link #DefaultOAuth2AuthorizationRequestResolver(ClientRegistrationRepository, String)}.
*
* @author Joe Grandja
Expand Down
8 changes: 4 additions & 4 deletions ...2-core/src/main/java/org/springframework/security/oauth2/core/AuthorizationGrantType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2023 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -23,13 +23,13 @@

/**
* An authorization grant is a credential representing the resource owner's authorization
* (to access it's protected resources) to the client and used by the client to obtain an
* (to access its protected resources) to the client and used by the client to obtain an
* access token.
*
* <p>
* The OAuth 2.0 Authorization Framework defines four standard grant types: authorization
* code, resource owner password credentials, and client credentials. It also provides an
* extensibility mechanism for defining additional grant types.
* code, implicit, resource owner password credentials, and client credentials. It also
* provides an extensibility mechanism for defining additional grant types.
*
* @author Joe Grandja
* @author Steve Riesenberg
Expand Down
4 changes: 2 additions & 2 deletions oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtDecoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -44,7 +44,7 @@
public interface JwtDecoder {

/**
* Decodes the JWT from it's compact claims representation format and returns a
* Decodes the JWT from its compact claims representation format and returns a
* {@link Jwt}.
* @param token the JWT value
* @return a {@link Jwt}
Expand Down
6 changes: 3 additions & 3 deletions oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtEncoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2021 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -18,7 +18,7 @@

/**
* Implementations of this interface are responsible for encoding a JSON Web Token (JWT)
* to it's compact claims representation format.
* to its compact claims representation format.
*
* <p>
* JWTs may be represented using the JWS Compact Serialization format for a JSON Web
Expand Down Expand Up @@ -47,7 +47,7 @@
public interface JwtEncoder {

/**
* Encode the JWT to it's compact claims representation format.
* Encode the JWT to its compact claims representation format.
* @param parameters the parameters containing the JOSE header and JWT Claims Set
* @return a {@link Jwt}
* @throws JwtEncodingException if an error occurs while attempting to encode the JWT
Expand Down
4 changes: 2 additions & 2 deletions ...-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusReactiveJwtDecoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -70,7 +70,7 @@

/**
* An implementation of a {@link ReactiveJwtDecoder} that &quot;decodes&quot; a JSON Web
* Token (JWT) and additionally verifies it's digital signature if the JWT is a JSON Web
* Token (JWT) and additionally verifies its digital signature if the JWT is a JSON Web
* Signature (JWS).
*
* <p>
Expand Down
6 changes: 3 additions & 3 deletions ...oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/ReactiveJwtDecoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -20,7 +20,7 @@

/**
* Implementations of this interface are responsible for &quot;decoding&quot; a JSON Web
* Token (JWT) from it's compact claims representation format to a {@link Jwt}.
* Token (JWT) from its compact claims representation format to a {@link Jwt}.
*
* <p>
* JWTs may be represented using the JWS Compact Serialization format for a JSON Web
Expand All @@ -46,7 +46,7 @@
public interface ReactiveJwtDecoder {

/**
* Decodes the JWT from it's compact claims representation format and returns a
* Decodes the JWT from its compact claims representation format and returns a
* {@link Jwt}.
* @param token the JWT value
* @return a {@link Jwt}
Expand Down