OAuth2AccessTokenEntity (MITREid Connect MITREid Connect v. 1.3.2)

java.lang.Object
- org.mitre.oauth2.model.OAuth2AccessTokenEntity

All Implemented Interfaces:: org.springframework.security.oauth2.common.OAuth2AccessToken

@Entity
public class OAuth2AccessTokenEntity
extends Object
implements org.springframework.security.oauth2.common.OAuth2AccessToken

Author:: jricher

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ID_TOKEN_FIELD_NAME`
`static String`	`PARAM_APPROVED_SITE`
`static String`	`PARAM_CLIENT`
`static String`	`PARAM_DATE`
`static String`	`PARAM_REFERSH_TOKEN`
`static String`	`PARAM_RESOURCE_SET_ID`
`static String`	`PARAM_TOKEN_VALUE`
`static String`	`QUERY_ALL`
`static String`	`QUERY_BY_APPROVED_SITE`
`static String`	`QUERY_BY_CLIENT`
`static String`	`QUERY_BY_REFRESH_TOKEN`
`static String`	`QUERY_BY_RESOURCE_SET`
`static String`	`QUERY_BY_TOKEN_VALUE`
`static String`	`QUERY_EXPIRED_BY_DATE`

Fields inherited from interface org.springframework.security.oauth2.common.OAuth2AccessToken
ACCESS_TOKEN, BEARER_TYPE, EXPIRES_IN, OAUTH2_TYPE, REFRESH_TOKEN, SCOPE, TOKEN_TYPE

Constructor Summary

Constructors
Constructor and Description

OAuth2AccessTokenEntity()
Create a new, blank access token

Constructors
Constructor and Description
`OAuth2AccessTokenEntity()` Create a new, blank access token

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`getAdditionalInformation()` Get all additional information to be sent to the serializer as part of the token response.
`ApprovedSite`	`getApprovedSite()`
`AuthenticationHolderEntity`	`getAuthenticationHolder()` The authentication in place when this token was created.
`ClientDetailsEntity`	`getClient()`
`Date`	`getExpiration()`
`int`	`getExpiresIn()`
`Long`	`getId()`
`com.nimbusds.jwt.JWT`	`getJwt()`
`Set<Permission>`	`getPermissions()`
`OAuth2RefreshTokenEntity`	`getRefreshToken()`
`Set<String>`	`getScope()`
`String`	`getTokenType()`
`String`	`getValue()` Get the string-encoded value of this access token.
`boolean`	`isExpired()`
`void`	`setApprovedSite(ApprovedSite approvedSite)`
`void`	`setAuthenticationHolder(AuthenticationHolderEntity authenticationHolder)`
`void`	`setClient(ClientDetailsEntity client)`
`void`	`setExpiration(Date expiration)`
`void`	`setId(Long id)`
`void`	`setIdToken(com.nimbusds.jwt.JWT idToken)` Add the ID Token to the additionalInformation map for a token response.
`void`	`setJwt(com.nimbusds.jwt.JWT jwt)`
`void`	`setPermissions(Set<Permission> permissions)`
`void`	`setRefreshToken(org.springframework.security.oauth2.common.OAuth2RefreshToken refreshToken)`
`void`	`setRefreshToken(OAuth2RefreshTokenEntity refreshToken)`
`void`	`setScope(Set<String> scope)`
`void`	`setTokenType(String tokenType)`

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

- Field Detail
  - QUERY_BY_APPROVED_SITE
```
public static final String QUERY_BY_APPROVED_SITE
```
    See Also:
    
    Constant Field Values
  - QUERY_BY_TOKEN_VALUE
```
public static final String QUERY_BY_TOKEN_VALUE
```
    See Also:
    
    Constant Field Values
  - QUERY_BY_CLIENT
```
public static final String QUERY_BY_CLIENT
```
    See Also:
    
    Constant Field Values
  - QUERY_BY_REFRESH_TOKEN
```
public static final String QUERY_BY_REFRESH_TOKEN
```
    See Also:
    
    Constant Field Values
  - QUERY_EXPIRED_BY_DATE
```
public static final String QUERY_EXPIRED_BY_DATE
```
    See Also:
    
    Constant Field Values
  - QUERY_ALL
```
public static final String QUERY_ALL
```
    See Also:
    
    Constant Field Values
  - QUERY_BY_RESOURCE_SET
```
public static final String QUERY_BY_RESOURCE_SET
```
    See Also:
    
    Constant Field Values
  - PARAM_TOKEN_VALUE
```
public static final String PARAM_TOKEN_VALUE
```
    See Also:
    
    Constant Field Values
  - PARAM_CLIENT
```
public static final String PARAM_CLIENT
```
    See Also:
    
    Constant Field Values
  - PARAM_REFERSH_TOKEN
```
public static final String PARAM_REFERSH_TOKEN
```
    See Also:
    
    Constant Field Values
  - PARAM_DATE
```
public static final String PARAM_DATE
```
    See Also:
    
    Constant Field Values
  - PARAM_RESOURCE_SET_ID
```
public static final String PARAM_RESOURCE_SET_ID
```
    See Also:
    
    Constant Field Values
  - PARAM_APPROVED_SITE
```
public static final String PARAM_APPROVED_SITE
```
    See Also:
    
    Constant Field Values
  - ID_TOKEN_FIELD_NAME
```
public static final String ID_TOKEN_FIELD_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OAuth2AccessTokenEntity
```
public OAuth2AccessTokenEntity()
```
    Create a new, blank access token
- Method Detail
  - getId
```
public Long getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(Long id)
```
    Parameters:
    
    id - the id to set
  - getAdditionalInformation
```
public Map<String,Object> getAdditionalInformation()
```
    Get all additional information to be sent to the serializer as part of the token response. This map is not persisted to the database.
    
    Specified by:
    
    getAdditionalInformation in interface org.springframework.security.oauth2.common.OAuth2AccessToken
  - getAuthenticationHolder
```
public AuthenticationHolderEntity getAuthenticationHolder()
```
    The authentication in place when this token was created.
    
    Returns:
    
    the authentication
  - setAuthenticationHolder
```
public void setAuthenticationHolder(AuthenticationHolderEntity authenticationHolder)
```
    Parameters:
    
    authentication - the authentication to set
  - getClient
```
public ClientDetailsEntity getClient()
```
    Returns:
    
    the client
  - setClient
```
public void setClient(ClientDetailsEntity client)
```
    Parameters:
    
    client - the client to set
  - getValue
```
public String getValue()
```
    Get the string-encoded value of this access token.
    
    Specified by:
    
    getValue in interface org.springframework.security.oauth2.common.OAuth2AccessToken
  - getExpiration
```
public Date getExpiration()
```
    Specified by:
    
    getExpiration in interface org.springframework.security.oauth2.common.OAuth2AccessToken
  - setExpiration
```
public void setExpiration(Date expiration)
```
  - getTokenType
```
public String getTokenType()
```
    Specified by:
    
    getTokenType in interface org.springframework.security.oauth2.common.OAuth2AccessToken
  - setTokenType
```
public void setTokenType(String tokenType)
```
  - getRefreshToken
```
public OAuth2RefreshTokenEntity getRefreshToken()
```
    Specified by:
    
    getRefreshToken in interface org.springframework.security.oauth2.common.OAuth2AccessToken
  - setRefreshToken
```
public void setRefreshToken(OAuth2RefreshTokenEntity refreshToken)
```
  - setRefreshToken
```
public void setRefreshToken(org.springframework.security.oauth2.common.OAuth2RefreshToken refreshToken)
```
  - getScope
```
public Set<String> getScope()
```
    Specified by:
    
    getScope in interface org.springframework.security.oauth2.common.OAuth2AccessToken
  - setScope
```
public void setScope(Set<String> scope)
```
  - isExpired
```
public boolean isExpired()
```
    Specified by:
    
    isExpired in interface org.springframework.security.oauth2.common.OAuth2AccessToken
  - getJwt
```
public com.nimbusds.jwt.JWT getJwt()
```
    Returns:
    
    the jwtValue
  - setJwt
```
public void setJwt(com.nimbusds.jwt.JWT jwt)
```
    Parameters:
    
    jwtValue - the jwtValue to set
  - getExpiresIn
```
public int getExpiresIn()
```
    Specified by:
    
    getExpiresIn in interface org.springframework.security.oauth2.common.OAuth2AccessToken
  - getPermissions
```
public Set<Permission> getPermissions()
```
    Returns:
    
    the permissions
  - setPermissions
```
public void setPermissions(Set<Permission> permissions)
```
    Parameters:
    
    permissions - the permissions to set
  - getApprovedSite
```
public ApprovedSite getApprovedSite()
```
  - setApprovedSite
```
public void setApprovedSite(ApprovedSite approvedSite)
```
  - setIdToken
```
public void setIdToken(com.nimbusds.jwt.JWT idToken)
```
    Add the ID Token to the additionalInformation map for a token response.
    
    Parameters:
    
    idToken -

Class OAuth2AccessTokenEntity

Field Summary

Fields inherited from interface org.springframework.security.oauth2.common.OAuth2AccessToken

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

QUERY_BY_APPROVED_SITE

QUERY_BY_TOKEN_VALUE

QUERY_BY_CLIENT

QUERY_BY_REFRESH_TOKEN

QUERY_EXPIRED_BY_DATE

QUERY_ALL

QUERY_BY_RESOURCE_SET

PARAM_TOKEN_VALUE

PARAM_CLIENT

PARAM_REFERSH_TOKEN

PARAM_DATE

PARAM_RESOURCE_SET_ID

PARAM_APPROVED_SITE

ID_TOKEN_FIELD_NAME

Constructor Detail

OAuth2AccessTokenEntity

Method Detail

getId

setId

getAdditionalInformation

getAuthenticationHolder

setAuthenticationHolder

getClient

setClient

getValue

getExpiration

setExpiration

getTokenType

setTokenType

getRefreshToken

setRefreshToken

setRefreshToken

getScope

setScope

isExpired

getJwt

setJwt

getExpiresIn

getPermissions

setPermissions

getApprovedSite

setApprovedSite

setIdToken