fish.payara.security.openid.api

Interface AccessToken

All Known Implementing Classes:

AccessTokenImpl

public interface AccessToken

The Access Token is used by an application to access protected resources.

Author:

jGauravGupta

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AccessToken.Type

Method Summary

Modifier and Type	Method and Description
Object	getClaim(String key) Gets the identity token's claim based on requested key type.
Map<String,Object>	getClaims() Gets the access token's claims that was received from the OpenId Connect provider
Long	getExpirationTime() Optional.
Scope	getScope() Optional.
String	getToken() The access token
AccessToken.Type	getType() Type of the Access Token.
boolean	isExpired() Checks if the Access Token is expired, taking into account the min validity time configured by the user.

Method Detail

getToken

String getToken()

The access token

Returns:

getClaims

Map<String,Object> getClaims()

Gets the access token's claims that was received from the OpenId Connect provider

Returns:

getClaim

Object getClaim(String key)

Gets the identity token's claim based on requested key type.

Parameters:

key -

Returns:

getExpirationTime

Long getExpirationTime()

Optional. Expiration time of the Access Token in seconds since the response was generated.

Returns:

isExpired

boolean isExpired()

Checks if the Access Token is expired, taking into account the min validity time configured by the user.

Returns:

true, if access token is expired or it will be expired in the next X milliseconds configured by user.

getScope

Scope getScope()

Optional. Scope of the Access Token.

Returns:

getType

AccessToken.Type getType()

Type of the Access Token.

Returns: