From 7734d049ebf44a4583fc80e28f12ac38ae45c182 Mon Sep 17 00:00:00 2001 From: Joe Grandja Date: Mon, 24 Feb 2020 10:35:58 -0500 Subject: [PATCH] Polish javadoc gh-7511 --- .../ClientCredentialsOAuth2AuthorizedClientProvider.java | 5 ++++- ...entCredentialsReactiveOAuth2AuthorizedClientProvider.java | 5 ++++- .../client/PasswordOAuth2AuthorizedClientProvider.java | 5 ++++- .../PasswordReactiveOAuth2AuthorizedClientProvider.java | 5 ++++- .../client/RefreshTokenOAuth2AuthorizedClientProvider.java | 5 ++++- .../RefreshTokenReactiveOAuth2AuthorizedClientProvider.java | 5 ++++- 6 files changed, 24 insertions(+), 6 deletions(-) diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/ClientCredentialsOAuth2AuthorizedClientProvider.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/ClientCredentialsOAuth2AuthorizedClientProvider.java index 3e50fb6747..ae5975d27f 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/ClientCredentialsOAuth2AuthorizedClientProvider.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/ClientCredentialsOAuth2AuthorizedClientProvider.java @@ -108,7 +108,10 @@ public final class ClientCredentialsOAuth2AuthorizedClientProvider implements OA /** * Sets the maximum acceptable clock skew, which is used when checking the * {@link OAuth2AuthorizedClient#getAccessToken() access token} expiry. The default is 60 seconds. - * An access token is considered expired if it's before {@code Instant.now(this.clock) - clockSkew}. + * + *

+ * An access token is considered expired if {@code OAuth2AccessToken#getExpiresAt() - clockSkew} + * is before the current time {@code clock#instant()}. * * @param clockSkew the maximum acceptable clock skew */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/ClientCredentialsReactiveOAuth2AuthorizedClientProvider.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/ClientCredentialsReactiveOAuth2AuthorizedClientProvider.java index c4e9352ef2..71835832cb 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/ClientCredentialsReactiveOAuth2AuthorizedClientProvider.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/ClientCredentialsReactiveOAuth2AuthorizedClientProvider.java @@ -101,7 +101,10 @@ public final class ClientCredentialsReactiveOAuth2AuthorizedClientProvider imple /** * Sets the maximum acceptable clock skew, which is used when checking the * {@link OAuth2AuthorizedClient#getAccessToken() access token} expiry. The default is 60 seconds. - * An access token is considered expired if it's before {@code Instant.now(this.clock) - clockSkew}. + * + *

+ * An access token is considered expired if {@code OAuth2AccessToken#getExpiresAt() - clockSkew} + * is before the current time {@code clock#instant()}. * * @param clockSkew the maximum acceptable clock skew */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/PasswordOAuth2AuthorizedClientProvider.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/PasswordOAuth2AuthorizedClientProvider.java index 91cd6e81ff..e40522a7e5 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/PasswordOAuth2AuthorizedClientProvider.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/PasswordOAuth2AuthorizedClientProvider.java @@ -126,7 +126,10 @@ public final class PasswordOAuth2AuthorizedClientProvider implements OAuth2Autho /** * Sets the maximum acceptable clock skew, which is used when checking the * {@link OAuth2AuthorizedClient#getAccessToken() access token} expiry. The default is 60 seconds. - * An access token is considered expired if it's before {@code Instant.now(this.clock) - clockSkew}. + * + *

+ * An access token is considered expired if {@code OAuth2AccessToken#getExpiresAt() - clockSkew} + * is before the current time {@code clock#instant()}. * * @param clockSkew the maximum acceptable clock skew */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/PasswordReactiveOAuth2AuthorizedClientProvider.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/PasswordReactiveOAuth2AuthorizedClientProvider.java index c8a7f5ae4e..971170aef6 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/PasswordReactiveOAuth2AuthorizedClientProvider.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/PasswordReactiveOAuth2AuthorizedClientProvider.java @@ -121,7 +121,10 @@ public final class PasswordReactiveOAuth2AuthorizedClientProvider implements Rea /** * Sets the maximum acceptable clock skew, which is used when checking the * {@link OAuth2AuthorizedClient#getAccessToken() access token} expiry. The default is 60 seconds. - * An access token is considered expired if it's before {@code Instant.now(this.clock) - clockSkew}. + * + *

+ * An access token is considered expired if {@code OAuth2AccessToken#getExpiresAt() - clockSkew} + * is before the current time {@code clock#instant()}. * * @param clockSkew the maximum acceptable clock skew */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/RefreshTokenOAuth2AuthorizedClientProvider.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/RefreshTokenOAuth2AuthorizedClientProvider.java index 310e2a6cb1..f77a44809b 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/RefreshTokenOAuth2AuthorizedClientProvider.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/RefreshTokenOAuth2AuthorizedClientProvider.java @@ -116,7 +116,10 @@ public final class RefreshTokenOAuth2AuthorizedClientProvider implements OAuth2A /** * Sets the maximum acceptable clock skew, which is used when checking the * {@link OAuth2AuthorizedClient#getAccessToken() access token} expiry. The default is 60 seconds. - * An access token is considered expired if it's before {@code Instant.now(this.clock) - clockSkew}. + * + *

+ * An access token is considered expired if {@code OAuth2AccessToken#getExpiresAt() - clockSkew} + * is before the current time {@code clock#instant()}. * * @param clockSkew the maximum acceptable clock skew */ diff --git a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/RefreshTokenReactiveOAuth2AuthorizedClientProvider.java b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/RefreshTokenReactiveOAuth2AuthorizedClientProvider.java index 8a2203cdf9..f2526ed225 100644 --- a/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/RefreshTokenReactiveOAuth2AuthorizedClientProvider.java +++ b/oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/RefreshTokenReactiveOAuth2AuthorizedClientProvider.java @@ -112,7 +112,10 @@ public final class RefreshTokenReactiveOAuth2AuthorizedClientProvider implements /** * Sets the maximum acceptable clock skew, which is used when checking the * {@link OAuth2AuthorizedClient#getAccessToken() access token} expiry. The default is 60 seconds. - * An access token is considered expired if it's before {@code Instant.now(this.clock) - clockSkew}. + * + *

+ * An access token is considered expired if {@code OAuth2AccessToken#getExpiresAt() - clockSkew} + * is before the current time {@code clock#instant()}. * * @param clockSkew the maximum acceptable clock skew */