Package org.springframework.security.oauth2.client

Class OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder

java.lang.Object

org.springframework.security.oauth2.client.OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder

Enclosing class:

OAuth2AuthorizedClientProviderBuilder

public final class OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder
extends Object

A builder for the password grant.

Method Summary

Modifier and Type	Method	Description
OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder	accessTokenResponseClient(OAuth2AccessTokenResponseClient<OAuth2PasswordGrantRequest> accessTokenResponseClient)	Sets the client used when requesting an access token credential at the Token Endpoint.
OAuth2AuthorizedClientProvider	build()	Builds an instance of PasswordOAuth2AuthorizedClientProvider.
OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder	clock(Clock clock)	Sets the Clock used in Instant.now(Clock) when checking the access token expiry.
OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder	clockSkew(Duration clockSkew)	Sets the maximum acceptable clock skew, which is used when checking the access token expiry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

accessTokenResponseClient

public OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder accessTokenResponseClient(OAuth2AccessTokenResponseClient<OAuth2PasswordGrantRequest> accessTokenResponseClient)

Sets the client used when requesting an access token credential at the Token Endpoint.

Parameters:

accessTokenResponseClient - the client used when requesting an access token credential at the Token Endpoint

Returns:

the OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder

clockSkew

public OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder clockSkew(Duration clockSkew)

Sets the maximum acceptable clock skew, which is used when checking the access token expiry. An access token is considered expired if OAuth2Token#getExpiresAt() - clockSkew is before the current time clock#instant().

Parameters:

clockSkew - the maximum acceptable clock skew

Returns:

the OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder

See Also:

• PasswordOAuth2AuthorizedClientProvider.setClockSkew(Duration)

clock

public OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder clock(Clock clock)

Sets the Clock used in Instant.now(Clock) when checking the access token expiry.

Parameters:

clock - the clock

Returns:

the OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder

build

public OAuth2AuthorizedClientProvider build()

Builds an instance of PasswordOAuth2AuthorizedClientProvider.

Returns:

the PasswordOAuth2AuthorizedClientProvider