mitreid-connect
公開メンバ関数 | 静的公開変数類 | 非公開変数類 | 全メンバ一覧
org.mitre.oauth2.model.OAuth2AccessTokenEntity クラス
org.mitre.oauth2.model.OAuth2AccessTokenEntity の継承関係図
Inheritance graph
org.mitre.oauth2.model.OAuth2AccessTokenEntity 連携図
Collaboration graph

公開メンバ関数

 OAuth2AccessTokenEntity ()
 
Long getId ()
 
void setId (Long id)
 
Map< String, Object > getAdditionalInformation ()
 
AuthenticationHolderEntity getAuthenticationHolder ()
 
void setAuthenticationHolder (AuthenticationHolderEntity authenticationHolder)
 
ClientDetailsEntity getClient ()
 
void setClient (ClientDetailsEntity client)
 
String getValue ()
 
Date getExpiration ()
 
void setExpiration (Date expiration)
 
String getTokenType ()
 
void setTokenType (String tokenType)
 
OAuth2RefreshTokenEntity getRefreshToken ()
 
void setRefreshToken (OAuth2RefreshTokenEntity refreshToken)
 
void setRefreshToken (OAuth2RefreshToken refreshToken)
 
Set< String > getScope ()
 
void setScope (Set< String > scope)
 
boolean isExpired ()
 
JWT getJwt ()
 
void setJwt (JWT jwt)
 
int getExpiresIn ()
 
Set< PermissiongetPermissions ()
 
void setPermissions (Set< Permission > permissions)
 
ApprovedSite getApprovedSite ()
 
void setApprovedSite (ApprovedSite approvedSite)
 
void setIdToken (JWT idToken)
 

静的公開変数類

static final String QUERY_BY_APPROVED_SITE = "OAuth2AccessTokenEntity.getByApprovedSite"
 
static final String QUERY_BY_TOKEN_VALUE = "OAuth2AccessTokenEntity.getByTokenValue"
 
static final String QUERY_BY_CLIENT = "OAuth2AccessTokenEntity.getByClient"
 
static final String QUERY_BY_REFRESH_TOKEN = "OAuth2AccessTokenEntity.getByRefreshToken"
 
static final String QUERY_EXPIRED_BY_DATE = "OAuth2AccessTokenEntity.getAllExpiredByDate"
 
static final String QUERY_ALL = "OAuth2AccessTokenEntity.getAll"
 
static final String QUERY_BY_RESOURCE_SET = "OAuth2AccessTokenEntity.getByResourceSet"
 
static final String PARAM_TOKEN_VALUE = "tokenValue"
 
static final String PARAM_CLIENT = "client"
 
static final String PARAM_REFERSH_TOKEN = "refreshToken"
 
static final String PARAM_DATE = "date"
 
static final String PARAM_RESOURCE_SET_ID = "rsid"
 
static final String PARAM_APPROVED_SITE = "approvedSite"
 
static final String ID_TOKEN_FIELD_NAME = "id_token"
 

非公開変数類

Long id
 
ClientDetailsEntity client
 
AuthenticationHolderEntity authenticationHolder
 
JWT jwtValue
 
Date expiration
 
String tokenType = OAuth2AccessToken.BEARER_TYPE
 
OAuth2RefreshTokenEntity refreshToken
 
Set< String > scope
 
Set< Permissionpermissions
 
ApprovedSite approvedSite
 
Map< String, Object > additionalInformation = new HashMap<>()
 

詳解

著者
jricher

構築子と解体子

◆ OAuth2AccessTokenEntity()

org.mitre.oauth2.model.OAuth2AccessTokenEntity.OAuth2AccessTokenEntity ( )
inline

Create a new, blank access token

124  {
125 
126  }

関数詳解

◆ getAdditionalInformation()

Map<String, Object> org.mitre.oauth2.model.OAuth2AccessTokenEntity.getAdditionalInformation ( )
inline

Get all additional information to be sent to the serializer as part of the token response. This map is not persisted to the database.

151  {
152  return additionalInformation;
153  }
Map< String, Object > additionalInformation
Definition: OAuth2AccessTokenEntity.java:119

◆ getApprovedSite()

ApprovedSite org.mitre.oauth2.model.OAuth2AccessTokenEntity.getApprovedSite ( )
inline
314  {
315  return approvedSite;
316  }
ApprovedSite approvedSite
Definition: OAuth2AccessTokenEntity.java:117

◆ getAuthenticationHolder()

AuthenticationHolderEntity org.mitre.oauth2.model.OAuth2AccessTokenEntity.getAuthenticationHolder ( )
inline

The authentication in place when this token was created.

戻り値
the authentication
161  {
162  return authenticationHolder;
163  }
AuthenticationHolderEntity authenticationHolder
Definition: OAuth2AccessTokenEntity.java:103

◆ getClient()

ClientDetailsEntity org.mitre.oauth2.model.OAuth2AccessTokenEntity.getClient ( )
inline
戻り値
the client
177  {
178  return client;
179  }
ClientDetailsEntity client
Definition: OAuth2AccessTokenEntity.java:101

◆ getExpiration()

Date org.mitre.oauth2.model.OAuth2AccessTokenEntity.getExpiration ( )
inline
201  {
202  return expiration;
203  }
Date expiration
Definition: OAuth2AccessTokenEntity.java:107

◆ getExpiresIn()

int org.mitre.oauth2.model.OAuth2AccessTokenEntity.getExpiresIn ( )
inline
278  {
279 
280  if (getExpiration() == null) {
281  return -1; // no expiration time
282  } else {
283  int secondsRemaining = (int) ((getExpiration().getTime() - System.currentTimeMillis()) / 1000);
284  if (isExpired()) {
285  return 0; // has an expiration time and expired
286  } else { // has an expiration time and not expired
287  return secondsRemaining;
288  }
289  }
290  }
boolean isExpired()
Definition: OAuth2AccessTokenEntity.java:255
Date getExpiration()
Definition: OAuth2AccessTokenEntity.java:201

◆ getId()

Long org.mitre.oauth2.model.OAuth2AccessTokenEntity.getId ( )
inline
戻り値
the id
134  {
135  return id;
136  }
Long id
Definition: OAuth2AccessTokenEntity.java:99

◆ getJwt()

JWT org.mitre.oauth2.model.OAuth2AccessTokenEntity.getJwt ( )
inline
戻り値
the jwtValue
265  {
266  return jwtValue;
267  }
JWT jwtValue
Definition: OAuth2AccessTokenEntity.java:105

◆ getPermissions()

Set<Permission> org.mitre.oauth2.model.OAuth2AccessTokenEntity.getPermissions ( )
inline
戻り値
the permissions
301  {
302  return permissions;
303  }
Set< Permission > permissions
Definition: OAuth2AccessTokenEntity.java:115

◆ getRefreshToken()

OAuth2RefreshTokenEntity org.mitre.oauth2.model.OAuth2AccessTokenEntity.getRefreshToken ( )
inline
223  {
224  return refreshToken;
225  }
OAuth2RefreshTokenEntity refreshToken
Definition: OAuth2AccessTokenEntity.java:111

◆ getScope()

Set<String> org.mitre.oauth2.model.OAuth2AccessTokenEntity.getScope ( )
inline
245  {
246  return scope;
247  }
Set< String > scope
Definition: OAuth2AccessTokenEntity.java:113

◆ getTokenType()

String org.mitre.oauth2.model.OAuth2AccessTokenEntity.getTokenType ( )
inline
212  {
213  return tokenType;
214  }
String tokenType
Definition: OAuth2AccessTokenEntity.java:109

◆ getValue()

String org.mitre.oauth2.model.OAuth2AccessTokenEntity.getValue ( )
inline

Get the string-encoded value of this access token.

193  {
194  return jwtValue.serialize();
195  }
JWT jwtValue
Definition: OAuth2AccessTokenEntity.java:105

◆ isExpired()

boolean org.mitre.oauth2.model.OAuth2AccessTokenEntity.isExpired ( )
inline
255  {
256  return getExpiration() == null ? false : System.currentTimeMillis() > getExpiration().getTime();
257  }
Date getExpiration()
Definition: OAuth2AccessTokenEntity.java:201

◆ setApprovedSite()

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setApprovedSite ( ApprovedSite  approvedSite)
inline
318  {
319  this.approvedSite = approvedSite;
320  }
ApprovedSite approvedSite
Definition: OAuth2AccessTokenEntity.java:117

◆ setAuthenticationHolder()

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setAuthenticationHolder ( AuthenticationHolderEntity  authenticationHolder)
inline
引数
authenticationthe authentication to set
168  {
170  }
AuthenticationHolderEntity authenticationHolder
Definition: OAuth2AccessTokenEntity.java:103

◆ setClient()

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setClient ( ClientDetailsEntity  client)
inline
引数
clientthe client to set
184  {
185  this.client = client;
186  }
ClientDetailsEntity client
Definition: OAuth2AccessTokenEntity.java:101

◆ setExpiration()

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setExpiration ( Date  expiration)
inline
205  {
206  this.expiration = expiration;
207  }
Date expiration
Definition: OAuth2AccessTokenEntity.java:107

◆ setId()

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setId ( Long  id)
inline
引数
idthe id to set
141  {
142  this.id = id;
143  }
Long id
Definition: OAuth2AccessTokenEntity.java:99

◆ setIdToken()

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setIdToken ( JWT  idToken)
inline

Add the ID Token to the additionalInformation map for a token response.

引数
idToken
327  {
328  if (idToken != null) {
329  additionalInformation.put(ID_TOKEN_FIELD_NAME, idToken.serialize());
330  }
331  }
static final String ID_TOKEN_FIELD_NAME
Definition: OAuth2AccessTokenEntity.java:97
Map< String, Object > additionalInformation
Definition: OAuth2AccessTokenEntity.java:119

◆ setJwt()

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setJwt ( JWT  jwt)
inline
引数
jwtValuethe jwtValue to set
272  {
273  this.jwtValue = jwt;
274  }
JWT jwtValue
Definition: OAuth2AccessTokenEntity.java:105

◆ setPermissions()

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setPermissions ( Set< Permission permissions)
inline
引数
permissionsthe permissions to set
308  {
309  this.permissions = permissions;
310  }
Set< Permission > permissions
Definition: OAuth2AccessTokenEntity.java:115

◆ setRefreshToken() [1/2]

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setRefreshToken ( OAuth2RefreshTokenEntity  refreshToken)
inline
227  {
228  this.refreshToken = refreshToken;
229  }
OAuth2RefreshTokenEntity refreshToken
Definition: OAuth2AccessTokenEntity.java:111

◆ setRefreshToken() [2/2]

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setRefreshToken ( OAuth2RefreshToken  refreshToken)
inline
231  {
232  if (!(refreshToken instanceof OAuth2RefreshTokenEntity)) {
233  throw new IllegalArgumentException("Not a storable refresh token entity!");
234  }
235  // force a pass through to the entity version
236  setRefreshToken((OAuth2RefreshTokenEntity)refreshToken);
237  }
OAuth2RefreshTokenEntity refreshToken
Definition: OAuth2AccessTokenEntity.java:111
void setRefreshToken(OAuth2RefreshTokenEntity refreshToken)
Definition: OAuth2AccessTokenEntity.java:227

◆ setScope()

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setScope ( Set< String >  scope)
inline
249  {
250  this.scope = scope;
251  }
Set< String > scope
Definition: OAuth2AccessTokenEntity.java:113

◆ setTokenType()

void org.mitre.oauth2.model.OAuth2AccessTokenEntity.setTokenType ( String  tokenType)
inline
216  {
217  this.tokenType = tokenType;
218  }
String tokenType
Definition: OAuth2AccessTokenEntity.java:109

メンバ詳解

◆ additionalInformation

Map<String, Object> org.mitre.oauth2.model.OAuth2AccessTokenEntity.additionalInformation = new HashMap<>()
private

◆ approvedSite

ApprovedSite org.mitre.oauth2.model.OAuth2AccessTokenEntity.approvedSite
private

◆ authenticationHolder

AuthenticationHolderEntity org.mitre.oauth2.model.OAuth2AccessTokenEntity.authenticationHolder
private

◆ client

ClientDetailsEntity org.mitre.oauth2.model.OAuth2AccessTokenEntity.client
private

◆ expiration

Date org.mitre.oauth2.model.OAuth2AccessTokenEntity.expiration
private

◆ id

Long org.mitre.oauth2.model.OAuth2AccessTokenEntity.id
private

◆ ID_TOKEN_FIELD_NAME

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.ID_TOKEN_FIELD_NAME = "id_token"
static

◆ jwtValue

JWT org.mitre.oauth2.model.OAuth2AccessTokenEntity.jwtValue
private

◆ PARAM_APPROVED_SITE

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.PARAM_APPROVED_SITE = "approvedSite"
static

◆ PARAM_CLIENT

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.PARAM_CLIENT = "client"
static

◆ PARAM_DATE

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.PARAM_DATE = "date"
static

◆ PARAM_REFERSH_TOKEN

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.PARAM_REFERSH_TOKEN = "refreshToken"
static

◆ PARAM_RESOURCE_SET_ID

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.PARAM_RESOURCE_SET_ID = "rsid"
static

◆ PARAM_TOKEN_VALUE

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.PARAM_TOKEN_VALUE = "tokenValue"
static

◆ permissions

Set<Permission> org.mitre.oauth2.model.OAuth2AccessTokenEntity.permissions
private

◆ QUERY_ALL

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.QUERY_ALL = "OAuth2AccessTokenEntity.getAll"
static

◆ QUERY_BY_APPROVED_SITE

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.QUERY_BY_APPROVED_SITE = "OAuth2AccessTokenEntity.getByApprovedSite"
static

◆ QUERY_BY_CLIENT

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.QUERY_BY_CLIENT = "OAuth2AccessTokenEntity.getByClient"
static

◆ QUERY_BY_REFRESH_TOKEN

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.QUERY_BY_REFRESH_TOKEN = "OAuth2AccessTokenEntity.getByRefreshToken"
static

◆ QUERY_BY_RESOURCE_SET

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.QUERY_BY_RESOURCE_SET = "OAuth2AccessTokenEntity.getByResourceSet"
static

◆ QUERY_BY_TOKEN_VALUE

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.QUERY_BY_TOKEN_VALUE = "OAuth2AccessTokenEntity.getByTokenValue"
static

◆ QUERY_EXPIRED_BY_DATE

final String org.mitre.oauth2.model.OAuth2AccessTokenEntity.QUERY_EXPIRED_BY_DATE = "OAuth2AccessTokenEntity.getAllExpiredByDate"
static

◆ refreshToken

OAuth2RefreshTokenEntity org.mitre.oauth2.model.OAuth2AccessTokenEntity.refreshToken
private

◆ scope

Set<String> org.mitre.oauth2.model.OAuth2AccessTokenEntity.scope
private

◆ tokenType

String org.mitre.oauth2.model.OAuth2AccessTokenEntity.tokenType = OAuth2AccessToken.BEARER_TYPE
private

このクラス詳解は次のファイルから抽出されました: