Cwikius-Spring/spring-security
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-security.git synced 2025-06-01 09:42:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update clockSkew javadoc according to implementation

Browse Source 
Closes gh-10174
This commit is contained in:
Dávid Kováč 2021-10-09 13:56:25 +02:00 committed by Eleftheria Stein
parent 16a21264d0
commit aa1ef46d84
2 changed files with 26 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/OAuth2AuthorizedClientProviderBuilder.java
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.
@ -204,10 +204,12 @@ public final class OAuth2AuthorizedClientProviderBuilder {
/** /**
* Sets the maximum acceptable clock skew, which is used when checking the access * Sets the maximum acceptable clock skew, which is used when checking the access
* token expiry. An access token is considered expired if it's before * token expiry. An access token is considered expired if
* {@code Instant.now(this.clock) - clockSkew}. * {@code OAuth2Token#getExpiresAt() - clockSkew} is before the current time
* {@code clock#instant()}.
* @param clockSkew the maximum acceptable clock skew * @param clockSkew the maximum acceptable clock skew
* @return the {@link PasswordGrantBuilder} * @return the {@link PasswordGrantBuilder}
* @see PasswordOAuth2AuthorizedClientProvider#setClockSkew(Duration)
*/ */
public PasswordGrantBuilder clockSkew(Duration clockSkew) { public PasswordGrantBuilder clockSkew(Duration clockSkew) {
this.clockSkew = clockSkew; this.clockSkew = clockSkew;
@ -275,10 +277,12 @@ public final class OAuth2AuthorizedClientProviderBuilder {
/** /**
* Sets the maximum acceptable clock skew, which is used when checking the access * Sets the maximum acceptable clock skew, which is used when checking the access
* token expiry. An access token is considered expired if it's before * token expiry. An access token is considered expired if
* {@code Instant.now(this.clock) - clockSkew}. * {@code OAuth2Token#getExpiresAt() - clockSkew} is before the current time
* {@code clock#instant()}.
* @param clockSkew the maximum acceptable clock skew * @param clockSkew the maximum acceptable clock skew
* @return the {@link ClientCredentialsGrantBuilder} * @return the {@link ClientCredentialsGrantBuilder}
* @see ClientCredentialsOAuth2AuthorizedClientProvider#setClockSkew(Duration)
*/ */
public ClientCredentialsGrantBuilder clockSkew(Duration clockSkew) { public ClientCredentialsGrantBuilder clockSkew(Duration clockSkew) {
this.clockSkew = clockSkew; this.clockSkew = clockSkew;
@ -365,10 +369,12 @@ public final class OAuth2AuthorizedClientProviderBuilder {
/** /**
* Sets the maximum acceptable clock skew, which is used when checking the access * Sets the maximum acceptable clock skew, which is used when checking the access
* token expiry. An access token is considered expired if it's before * token expiry. An access token is considered expired if
* {@code Instant.now(this.clock) - clockSkew}. * {@code OAuth2Token#getExpiresAt() - clockSkew} is before the current time
* {@code clock#instant()}.
* @param clockSkew the maximum acceptable clock skew * @param clockSkew the maximum acceptable clock skew
* @return the {@link RefreshTokenGrantBuilder} * @return the {@link RefreshTokenGrantBuilder}
* @see RefreshTokenOAuth2AuthorizedClientProvider#setClockSkew(Duration)
*/ */
public RefreshTokenGrantBuilder clockSkew(Duration clockSkew) { public RefreshTokenGrantBuilder clockSkew(Duration clockSkew) {
this.clockSkew = clockSkew; this.clockSkew = clockSkew;

20
oauth2/oauth2-client/src/main/java/org/springframework/security/oauth2/client/ReactiveOAuth2AuthorizedClientProviderBuilder.java
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.
@ -225,10 +225,12 @@ public final class ReactiveOAuth2AuthorizedClientProviderBuilder {
/** /**
* Sets the maximum acceptable clock skew, which is used when checking the access * Sets the maximum acceptable clock skew, which is used when checking the access
* token expiry. An access token is considered expired if it's before * token expiry. An access token is considered expired if
* {@code Instant.now(this.clock) - clockSkew}. * {@code OAuth2Token#getExpiresAt() - clockSkew} is before the current time
* {@code clock#instant()}.
* @param clockSkew the maximum acceptable clock skew * @param clockSkew the maximum acceptable clock skew
* @return the {@link ClientCredentialsGrantBuilder} * @return the {@link ClientCredentialsGrantBuilder}
* @see ClientCredentialsReactiveOAuth2AuthorizedClientProvider#setClockSkew(Duration)
*/ */
public ClientCredentialsGrantBuilder clockSkew(Duration clockSkew) { public ClientCredentialsGrantBuilder clockSkew(Duration clockSkew) {
this.clockSkew = clockSkew; this.clockSkew = clockSkew;
@ -297,10 +299,12 @@ public final class ReactiveOAuth2AuthorizedClientProviderBuilder {
/** /**
* Sets the maximum acceptable clock skew, which is used when checking the access * Sets the maximum acceptable clock skew, which is used when checking the access
* token expiry. An access token is considered expired if it's before * token expiry. An access token is considered expired if
* {@code Instant.now(this.clock) - clockSkew}. * {@code OAuth2Token#getExpiresAt() - clockSkew} is before the current time
* {@code clock#instant()}.
* @param clockSkew the maximum acceptable clock skew * @param clockSkew the maximum acceptable clock skew
* @return the {@link PasswordGrantBuilder} * @return the {@link PasswordGrantBuilder}
* @see PasswordReactiveOAuth2AuthorizedClientProvider#setClockSkew(Duration)
*/ */
public PasswordGrantBuilder clockSkew(Duration clockSkew) { public PasswordGrantBuilder clockSkew(Duration clockSkew) {
this.clockSkew = clockSkew; this.clockSkew = clockSkew;
@ -368,10 +372,12 @@ public final class ReactiveOAuth2AuthorizedClientProviderBuilder {
/** /**
* Sets the maximum acceptable clock skew, which is used when checking the access * Sets the maximum acceptable clock skew, which is used when checking the access
* token expiry. An access token is considered expired if it's before * token expiry. An access token is considered expired if
* {@code Instant.now(this.clock) - clockSkew}. * {@code OAuth2Token#getExpiresAt() - clockSkew} is before the current time
* {@code clock#instant()}.
* @param clockSkew the maximum acceptable clock skew * @param clockSkew the maximum acceptable clock skew
* @return the {@link RefreshTokenGrantBuilder} * @return the {@link RefreshTokenGrantBuilder}
* @see RefreshTokenReactiveOAuth2AuthorizedClientProvider#setClockSkew(Duration)
*/ */
public RefreshTokenGrantBuilder clockSkew(Duration clockSkew) { public RefreshTokenGrantBuilder clockSkew(Duration clockSkew) {
this.clockSkew = clockSkew; this.clockSkew = clockSkew;