fish.payara.security.oauth2

Class OAuth2StateHolder

java.lang.Object

fish.payara.security.oauth2.OAuth2StateHolder

All Implemented Interfaces:

OAuth2AccessToken, Serializable

public class OAuth2StateHolder
extends Object
implements OAuth2AccessToken

Class to hold state of OAuth2 token as returned by the provider

Since:

4.1.2.172

Author:

jonathan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OAuth2StateHolder()

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() Gets the authorisation token that was received from the OAuth provider
Optional<Integer>	getExpiresIn() Return the time that the access token is granted for, if it is set to expire
Optional<String>	getRefreshToken() Returns the refresh token that can be used to get a new access token
Optional<String>	getScope() Gets the scope that the user has been given permission for your application to use with the OAuth provider
Instant	getTimeSet() Gets the time that the access token was last set
void	setAccessToken(String token) Sets the access token that is to be used to verify the user with the OAuth provider once they are logged in.
void	setExpiresIn(Integer expiresIn) Sets the time that the access token is granted for
void	setRefreshToken(String refreshToken) Sets the refresh token that can be used to renew the access token
void	setScope(String scope)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2StateHolder

public OAuth2StateHolder()

Method Detail

getScope

public Optional<String> getScope()

Description copied from interface: OAuth2AccessToken

Gets the scope that the user has been given permission for your application to use with the OAuth provider

Specified by:

getScope in interface OAuth2AccessToken

Returns:

setScope

public void setScope(String scope)

getRefreshToken

public Optional<String> getRefreshToken()

Description copied from interface: OAuth2AccessToken

Returns the refresh token that can be used to get a new access token

Specified by:

getRefreshToken in interface OAuth2AccessToken

Returns:

setRefreshToken

public void setRefreshToken(String refreshToken)

Description copied from interface: OAuth2AccessToken

Sets the refresh token that can be used to renew the access token

Specified by:

setRefreshToken in interface OAuth2AccessToken

getExpiresIn

public Optional<Integer> getExpiresIn()

Description copied from interface: OAuth2AccessToken

Return the time that the access token is granted for, if it is set to expire

Specified by:

getExpiresIn in interface OAuth2AccessToken

Returns:

setExpiresIn

public void setExpiresIn(Integer expiresIn)

Description copied from interface: OAuth2AccessToken

Sets the time that the access token is granted for

Specified by:

setExpiresIn in interface OAuth2AccessToken

getAccessToken

public String getAccessToken()

Description copied from interface: OAuth2AccessToken

Gets the authorisation token that was received from the OAuth provider

Specified by:

getAccessToken in interface OAuth2AccessToken

Returns:

setAccessToken

public void setAccessToken(String token)

Description copied from interface: OAuth2AccessToken

Sets the access token that is to be used to verify the user with the OAuth provider once they are logged in.

Specified by:

setAccessToken in interface OAuth2AccessToken

getTimeSet

public Instant getTimeSet()

Description copied from interface: OAuth2AccessToken

Gets the time that the access token was last set

Specified by:

getTimeSet in interface OAuth2AccessToken

Returns: