org.forgerock.authz.modules.oauth2

Class AccessTokenValidationResponse

java.lang.Object

org.forgerock.authz.modules.oauth2.AccessTokenValidationResponse

public class AccessTokenValidationResponse
extends Object

Models the result of an access token validation.

Since:

1.4.0

Constructor Summary

Constructors

Constructor and Description
AccessTokenValidationResponse(long expiryTime) Constructs a new AccessTokenValidationResponse, without any user profile information or scope.
AccessTokenValidationResponse(long expiryTime, Map<String,Object> profileInfo, Set<String> scope) Constructs a new AccessTokenValidationResponse.
AccessTokenValidationResponse(long expiryTime, Set<String> scope) Constructs a new AccessTokenValidationResponse, without any user profile information.

Method Summary

Modifier and Type	Method and Description
long	getExpiryTime() Returns the expiry time of the access token.
Map<String,Object>	getProfileInformation() Returns the users profile information.
Set<String>	getTokenScopes() Returns the scope associated with the access token.
boolean	isTokenValid() Returns whether the access token is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessTokenValidationResponse

public AccessTokenValidationResponse(long expiryTime,
                                     Map<String,Object> profileInfo,
                                     Set<String> scope)

Constructs a new AccessTokenValidationResponse.

Parameters:

expiryTime - The time at which the access token becomes invalid.

profileInfo - The user profile information for the user who authorized the access token.

scope - The scope of the access token.

AccessTokenValidationResponse

public AccessTokenValidationResponse(long expiryTime,
                                     Set<String> scope)

Constructs a new AccessTokenValidationResponse, without any user profile information.

Parameters:

expiryTime - The time at which the access token becomes invalid.

scope - The scope of the access token.

AccessTokenValidationResponse

public AccessTokenValidationResponse(long expiryTime)

Constructs a new AccessTokenValidationResponse, without any user profile information or scope.

Parameters:

expiryTime - The time at which the access token becomes invalid.

Method Detail

isTokenValid

public boolean isTokenValid()

Returns whether the access token is valid.

Returns:

true if the access token is valid.

getExpiryTime

public long getExpiryTime()

Returns the expiry time of the access token.

Returns:

The access token expiry time.

getProfileInformation

public Map<String,Object> getProfileInformation()

Returns the users profile information.

Returns:

The users profile information.

getTokenScopes

public Set<String> getTokenScopes()

Returns the scope associated with the access token.

Returns:

The access token scope.