Skip to content

Commit 1d38255

Browse files
authored
docs: fix SsoOidcTokenProvider.Builder Javadoc defaults and typos (#7178)
- staleTime doc claimed "5 minute", actual default is 1 minute (DEFAULT_STALE_DURATION) - prefetchTime doc was missing the default-value statement (actual: 5 minutes) - Add missing "expiration" wording to align with peer providers (STS, SSO, Login, WebIdentity, CachedTokenRefresher all use "... token expiration ...") - Fix "Sso-Oidc" -> "SSO OIDC" capitalization for consistency with sessionName and ssoOidcClient Javadocs in the same class - Fix cosmetic Javadoc issues (spacing, punctuation, blank * lines) - Fix "token are loaded" -> "tokens are loaded" typo in asyncTokenUpdateEnabled No source-code / API changes.
1 parent 378771e commit 1d38255

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

services/ssooidc/src/main/java/software/amazon/awssdk/services/ssooidc/SsoOidcTokenProvider.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,29 +116,29 @@ public interface Builder {
116116
Builder sessionName(String sessionName);
117117

118118
/**
119-
*
120119
* Client to fetch token from SSO OIDC service.
121120
*/
122121
Builder ssoOidcClient(SsoOidcClient ssoOidcClient);
123122

124123
/**
125-
* Configure the amount of time, relative to Sso-Oidc token , that the cached tokens in refresher are considered
124+
* Configure the amount of time, relative to SSO OIDC token expiration, that the cached tokens in refresher are considered
126125
* stale and should no longer be used.
127126
*
128-
* <p>By default, this is 5 minute.</p>
127+
* <p>By default, this is 1 minute.</p>
129128
*/
130129
Builder staleTime(Duration onDiskStaleDuration);
131130

132131
/**
132+
* Configure the amount of time, relative to SSO OIDC token expiration, that the cached tokens in refresher are considered
133+
* close to stale and should be prefetched from the service.
133134
*
134-
* Configure the amount of time, relative to Sso-Oidc token , that the cached tokens in refresher are considered
135-
* prefetched from service..
135+
* <p>By default, this is 5 minutes.</p>
136136
*/
137137
Builder prefetchTime(Duration prefetchTime);
138138

139139
/**
140140
* Configure whether the provider should fetch tokens asynchronously in the background. If this is true,
141-
* threads are less likely to block when token are loaded, but additional resources are used to maintain
141+
* threads are less likely to block when tokens are loaded, but additional resources are used to maintain
142142
* the provider.
143143
*
144144
* <p>By default, this is disabled.</p>

0 commit comments

Comments
 (0)