fish.payara.security.oauth2.api

Interface OAuth2AccessToken

All Superinterfaces:

Serializable

All Known Implementing Classes:

OAuth2StateHolder

public interface OAuth2AccessToken
extends Serializable

Interface for the access token response returned by the OAuth provider

Since:

4.1.2.182

Author:

jonathan coustick

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() Gets the authorisation token that was received from the OAuth provider
Optional<Long>	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(Long 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

Method Detail

getAccessToken

String getAccessToken()

Gets the authorisation token that was received from the OAuth provider

Returns:

setAccessToken

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.

Parameters:

token -

getScope

Optional<String> getScope()

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

Returns:

getRefreshToken

Optional<String> getRefreshToken()

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

Returns:

setRefreshToken

void setRefreshToken(String refreshToken)

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

Parameters:

refreshToken -

getExpiresIn

Optional<Long> getExpiresIn()

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

Returns:

setExpiresIn

void setExpiresIn(Long expiresIn)

Sets the time that the access token is granted for

Parameters:

expiresIn -

getTimeSet

Instant getTimeSet()

Gets the time that the access token was last set

Returns: