java.lang.Object
- org.gcube.oidc.rest.JWTToken

All Implemented Interfaces:

Serializable
```
public class JWTToken
extends Object
implements Serializable
```
JWT token wrapper.

Author:

Mauro Mugnaini

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static String ACCOUNT_RESOURCE
Account resource.

protected static org.slf4j.Logger logger
Logger.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static JWTToken`	`fromString(String tokenString)`	Creates a `JWTToken` from a string.
`String`	`getAccessTokenAsBearer()`	Returns the access token as bearer.
`String`	`getAccessTokenString()`	Returns the access token string.
`String`	`getAsBearer()`	Deprecated. Use `getAccessTokenAsBearer()` method instead.
`List<String>`	`getAud()`	Returns the aud.
`List<String>`	`getAuthorizationPermissionRSNameResourceScopes(String rsname)`	Returns the authorization permission RS name resource scopes.
`List<String>`	`getAuthorizationPermissionRSNames()`	Returns the authorization permission RS names.
`Map<String,List<String>>`	`getAuthorizationPermissionRSNameToResourceScopesMap()`	Returns the authorization permission RS name to resource scopes map.
`protected org.json.simple.JSONArray`	`getAuthorizationPermissions()`	Returns the authorization permissions.
`String`	`getAzp()`	Returns the azp.
`String`	`getD4SContext()`	Returns the `d4s_context`.
`String`	`getDisplayName()`	Returns the name.
`String`	`getEmail()`	Returns the email.
`Long`	`getExp()`	Returns the exp.
`Calendar`	`getExpAsCalendar()`	Returns the exp as calendar.
`Date`	`getExpAsDate()`	Returns the exp as date.
`String`	`getFamily()`	Returns the family name.
`String`	`getGiven()`	Returns the given name.
`String`	`getJti()`	Returns the jti.
`org.json.simple.JSONObject`	`getPayload()`	Returns the payload.
`String`	`getRaw()`	Returns the raw token string.
`org.json.simple.JSONObject`	`getRefreshToken()`	Returns the refresh token.
`Long`	`getRefreshTokenExp()`	Returns the refresh token exp.
`Date`	`getRefreshTokenExpAsDate()`	Returns the refresh token exp as date.
`String`	`getRefreshTokenString()`	Returns the refresh token string.
`protected org.json.simple.JSONObject`	`getResourceAccess()`	Returns the resource access.
`protected Iterator<String>`	`getResourceAccessKeys()`	Returns the resource access keys.
`List<String>`	`getResourceAccessRoles(String resource)`	Returns the resource access roles.
`Map<String,List<String>>`	`getResourceNameToAccessRolesMap(List<String> resourcesToSkip)`	Returns the resource name to access roles map.
`String`	`getSub()`	Returns the sub.
`String`	`getTokenEssentials()`	Returns the token essentials.
`String`	`getUserName()`	Returns the preferred username.
`boolean`	`hasRefreshToken()`	Checks if a refresh token exists.
`boolean`	`isExpired()`	Checks if the token is expired.
`boolean`	`isRefreshTokenExpired()`	Checks if the refresh token is expired.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - logger
```
protected static org.slf4j.Logger logger
```
    Logger.
  - ACCOUNT_RESOURCE
```
public static final String ACCOUNT_RESOURCE
```
    Account resource.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - fromString
```
public static JWTToken fromString(String tokenString)
```
    Creates a JWTToken from a string.
    
    Parameters:
    
    tokenString - the token string.
    
    Returns:
    
    the JWTToken.
  - getRaw
```
public String getRaw()
```
    Returns the raw token string.
    
    Returns:
    
    the raw token string.
  - getAccessTokenString
```
public String getAccessTokenString()
```
    Returns the access token string.
    
    Returns:
    
    the access token string.
  - getRefreshTokenString
```
public String getRefreshTokenString()
```
    Returns the refresh token string.
    
    Returns:
    
    the refresh token string.
  - getAsBearer
```
@Deprecated
public String getAsBearer()
```
    Deprecated.
    Use getAccessTokenAsBearer() method instead.
    
    Returns the access token as bearer.
    
    Returns:
    
    the access token as bearer.
  - getAccessTokenAsBearer
```
public String getAccessTokenAsBearer()
```
    Returns the access token as bearer.
    
    Returns:
    
    the access token as bearer.
  - getPayload
```
public org.json.simple.JSONObject getPayload()
```
    Returns the payload.
    
    Returns:
    
    the payload.
  - hasRefreshToken
```
public boolean hasRefreshToken()
```
    Checks if a refresh token exists.
    
    Returns:
    
    true if a refresh token exists, false otherwise.
  - getRefreshToken
```
public org.json.simple.JSONObject getRefreshToken()
```
    Returns the refresh token.
    
    Returns:
    
    the refresh token.
  - getAzp
```
public String getAzp()
```
    Returns the azp.
    
    Returns:
    
    the azp.
  - getExp
```
public Long getExp()
```
    Returns the exp.
    
    Returns:
    
    the exp.
  - getRefreshTokenExp
```
public Long getRefreshTokenExp()
```
    Returns the refresh token exp.
    
    Returns:
    
    the refresh token exp.
  - getExpAsDate
```
public Date getExpAsDate()
```
    Returns the exp as date.
    
    Returns:
    
    the exp as date.
  - getRefreshTokenExpAsDate
```
public Date getRefreshTokenExpAsDate()
```
    Returns the refresh token exp as date.
    
    Returns:
    
    the refresh token exp as date.
  - getExpAsCalendar
```
public Calendar getExpAsCalendar()
```
    Returns the exp as calendar.
    
    Returns:
    
    the exp as calendar.
  - isExpired
```
public boolean isExpired()
```
    Checks if the token is expired.
    
    Returns:
    
    true if the token is expired, false otherwise.
  - isRefreshTokenExpired
```
public boolean isRefreshTokenExpired()
```
    Checks if the refresh token is expired.
    
    Returns:
    
    true if the refresh token is expired, false otherwise.
  - getAud
```
public List<String> getAud()
```
    Returns the aud.
    
    Returns:
    
    the aud.
  - getJti
```
public String getJti()
```
    Returns the jti.
    
    Returns:
    
    the jti.
  - getSub
```
public String getSub()
```
    Returns the sub.
    
    Returns:
    
    the sub.
  - getEmail
```
public String getEmail()
```
    Returns the email.
    
    Returns:
    
    the email.
  - getFamily
```
public String getFamily()
```
    Returns the family name.
    
    Returns:
    
    the family name.
  - getGiven
```
public String getGiven()
```
    Returns the given name.
    
    Returns:
    
    the given name.
  - getUserName
```
public String getUserName()
```
    Returns the preferred username.
    
    Returns:
    
    the preferred username.
  - getDisplayName
```
public String getDisplayName()
```
    Returns the name.
    
    Returns:
    
    the name.
  - getResourceAccess
```
protected org.json.simple.JSONObject getResourceAccess()
```
    Returns the resource access.
    
    Returns:
    
    the resource access.
  - getResourceAccessKeys
```
protected Iterator<String> getResourceAccessKeys()
```
    Returns the resource access keys.
    
    Returns:
    
    the resource access keys.
  - getResourceAccessRoles
```
public List<String> getResourceAccessRoles(String resource)
```
    Returns the resource access roles.
    
    Parameters:
    
    resource - the resource.
    
    Returns:
    
    the roles.
  - getResourceNameToAccessRolesMap
```
public Map<String,List<String>> getResourceNameToAccessRolesMap(List<String> resourcesToSkip)
```
    Returns the resource name to access roles map.
    
    Parameters:
    
    resourcesToSkip - the resources to skip.
    
    Returns:
    
    the map.
  - getAuthorizationPermissions
```
protected org.json.simple.JSONArray getAuthorizationPermissions()
```
    Returns the authorization permissions.
    
    Returns:
    
    the permissions.
  - getAuthorizationPermissionRSNames
```
public List<String> getAuthorizationPermissionRSNames()
```
    Returns the authorization permission RS names.
    
    Returns:
    
    the names.
  - getAuthorizationPermissionRSNameResourceScopes
```
public List<String> getAuthorizationPermissionRSNameResourceScopes(String rsname)
```
    Returns the authorization permission RS name resource scopes.
    
    Parameters:
    
    rsname - the RS name.
    
    Returns:
    
    the scopes.
  - getAuthorizationPermissionRSNameToResourceScopesMap
```
public Map<String,List<String>> getAuthorizationPermissionRSNameToResourceScopesMap()
```
    Returns the authorization permission RS name to resource scopes map.
    
    Returns:
    
    the map.
  - getD4SContext
```
public String getD4SContext()
```
    Returns the d4s_context.
    
    Returns:
    
    the d4s_context or null if the dynamic scope is not used.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getTokenEssentials
```
public String getTokenEssentials()
```
    Returns the token essentials.
    
    Returns:
    
    the token essentials.

Modifier and Type	Field	Description
`static String`	`ACCOUNT_RESOURCE`	Account resource.
`protected static org.slf4j.Logger`	`logger`	Logger.

Class JWTToken

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

ACCOUNT_RESOURCE

Method Detail

fromString

getRaw

getAccessTokenString

getRefreshTokenString

getAsBearer

getAccessTokenAsBearer

getPayload

hasRefreshToken

getRefreshToken

getAzp

getExp

getRefreshTokenExp

getExpAsDate

getRefreshTokenExpAsDate

getExpAsCalendar

isExpired

isRefreshTokenExpired

getAud

getJti

getSub

getEmail

getFamily

getGiven

getUserName

getDisplayName

getResourceAccess

getResourceAccessKeys

getResourceAccessRoles

getResourceNameToAccessRolesMap

getAuthorizationPermissions

getAuthorizationPermissionRSNames

getAuthorizationPermissionRSNameResourceScopes

getAuthorizationPermissionRSNameToResourceScopesMap

getD4SContext

toString

getTokenEssentials