TokenStore (OpenAM Project 15.1.7-SNAPSHOT API)

All Known Subinterfaces:

OpenIdConnectTokenStore

All Known Implementing Classes:

OAuth2GuiceModule.RealmAgnosticStatefulTokenStore, OAuth2GuiceModule.RealmAgnosticStatelessTokenStore, OpenAMTokenStore, StatefulTokenStore, StatelessTokenStore
```
public interface TokenStore
```
Interface for a Token Store which the OAuth2 Provider will implement.
The Token Store will be where all types of OAuth2 tokens will be stored and later retrieved.

Since:

12.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`REALM_AGNOSTIC_TOKEN_STORE` A constant to identify the realm agnostic version of the `TokenStore` implementation when using dependency injection.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AccessToken`	`createAccessToken(String grantType, String accessTokenType, String authorizationCode, String resourceOwnerId, String clientId, String redirectUri, Set<String> scope, RefreshToken refreshToken, String nonce, String claims, OAuth2Request request)` Creates an Access Token and stores it in the OAuth2 Provider's store.
`AccessToken`	`createAccessToken(String grantType, String accessTokenType, String authorizationCode, String resourceOwnerId, String clientId, String redirectUri, Set<String> scope, RefreshToken refreshToken, String nonce, String claims, OAuth2Request request, long authTime)` Creates an Access Token and stores it in the OAuth2 Provider's store.
`AuthorizationCode`	`createAuthorizationCode(Set<String> scope, ResourceOwner resourceOwner, String clientId, String redirectUri, String nonce, OAuth2Request request, String codeChallenge, String codeChallengeMethod)` Creates an Authorization Code and stores it in the OAuth2 Provider's store.
`DeviceCode`	`createDeviceCode(Set<String> scope, ResourceOwner resourceOwner, String clientId, String nonce, String responseType, String state, String acrValues, String prompt, String uiLocales, String loginHint, Integer maxAge, String claims, OAuth2Request request, String codeChallenge, String codeChallengeMethod)` Creates a new device code token.
`RefreshToken`	`createRefreshToken(String grantType, String clientId, String resourceOwnerId, String redirectUri, Set<String> scope, OAuth2Request request)` Creates a Refresh Token and stores it in the OAuth2 Provider's store.
`RefreshToken`	`createRefreshToken(String grantType, String clientId, String resourceOwnerId, String redirectUri, Set<String> scope, OAuth2Request request, String validatedClaims)` Creates a Refresh Token and stores it in the OAuth2 Provider's store.
`RefreshToken`	`createRefreshToken(String grantType, String clientId, String resourceOwnerId, String redirectUri, Set<String> scope, OAuth2Request request, String validatedClaims, long authTime)` Creates a Refresh Token and stores it in the OAuth2 Provider's store.
`RefreshToken`	`createRefreshToken(String grantType, String clientId, String resourceOwnerId, String redirectUri, Set<String> scope, OAuth2Request request, String validatedClaims, String authGrantId)` Creates a Refresh Token and stores it in the OAuth2 Provider's store.
`RefreshToken`	`createRefreshToken(String grantType, String clientId, String resourceOwnerId, String redirectUri, Set<String> scope, OAuth2Request request, String validatedClaims, String authGrantId, long authTime)` Creates a Refresh Token and stores it in the OAuth2 Provider's store.
`void`	`delete(String realm, String tokenId)` Deletes the Token from the OAuth2 Provider's store with the specified identifier.
`void`	`deleteAccessToken(OAuth2Request request, String accessTokenId)` Deletes an Access Token from the OAuth2 Provider's store.
`void`	`deleteAuthorizationCode(OAuth2Request request, String authorizationCode)` Deletes an Authorization Code from the OAuth2 Provider's store.
`void`	`deleteDeviceCode(String clientId, String code, OAuth2Request request)` Deletes a device code token.
`void`	`deleteRefreshToken(OAuth2Request request, String refreshTokenId)` Deletes a Refresh Token from the OAuth2 Provider's store.
`org.forgerock.json.JsonValue`	`queryForToken(String realm, org.forgerock.util.query.QueryFilter<CoreTokenField> queryFilter)` Queries the OAuth2 Provider's store for tokens.
`org.forgerock.json.JsonValue`	`read(String tokenId)` Reads the Token from the OAuth2 Provider's store with the specified identifier.
`AccessToken`	`readAccessToken(OAuth2Request request, String tokenId)` Reads an Access Token from the OAuth2 Provider's store with the specified identifier.
`AuthorizationCode`	`readAuthorizationCode(OAuth2Request request, String code)` Creates an Authorization Code and stores it in the OAuth2 Provider's store.
`DeviceCode`	`readDeviceCode(String userCode, OAuth2Request request)` Reads a device code token.
`DeviceCode`	`readDeviceCode(String clientId, String code, OAuth2Request request)` Reads a device code token.
`RefreshToken`	`readRefreshToken(OAuth2Request request, String tokenId)` Reads a Refresh Token from the OAuth2 Provider's store with the specified identifier.
`void`	`updateAccessToken(OAuth2Request request, AccessToken accessToken)` Updates an Access Token.
`void`	`updateAuthorizationCode(OAuth2Request request, AuthorizationCode authorizationCode)` Updates an Authorization Code.
`void`	`updateDeviceCode(DeviceCode code, OAuth2Request request)` Updates a device code token.

Field Detail
- REALM_AGNOSTIC_TOKEN_STORE
```
static final String REALM_AGNOSTIC_TOKEN_STORE
```
  A constant to identify the realm agnostic version of the TokenStore implementation when using dependency injection. The realm agnostic TokenStore does not verify whether the incoming OAuth2Request's realm is the same as the OAuth2 access token's realm.
  
  See Also:
  
  Constant Field Values

Method Detail

createAuthorizationCode

AuthorizationCode createAuthorizationCode(Set<String> scope,
                                          ResourceOwner resourceOwner,
                                          String clientId,
                                          String redirectUri,
                                          String nonce,
                                          OAuth2Request request,
                                          String codeChallenge,
                                          String codeChallengeMethod)
                                   throws ServerException,
                                          NotFoundException

Creates an Authorization Code and stores it in the OAuth2 Provider's store.

Parameters:: scope - The requested scope.; resourceOwner - The resource owner.; clientId - The client's id.; redirectUri - The redirect uri.; nonce - The nonce.; request - The OAuth2 request.; codeChallenge -; codeChallengeMethod -
Returns:: An AuthorizationCode.
Throws:: ServerException - If any internal server error occurs.; NotFoundException - If the realm does not have an OAuth 2.0 provider service.

createAccessToken

AccessToken createAccessToken(String grantType,
                              String accessTokenType,
                              String authorizationCode,
                              String resourceOwnerId,
                              String clientId,
                              String redirectUri,
                              Set<String> scope,
                              RefreshToken refreshToken,
                              String nonce,
                              String claims,
                              OAuth2Request request)
                       throws ServerException,
                              NotFoundException

Creates an Access Token and stores it in the OAuth2 Provider's store.

Parameters:: grantType - The grant type.; accessTokenType - The access token type.; authorizationCode - The authorization code.; resourceOwnerId - The resource owner's id.; clientId - The client's id.; redirectUri - The redirect uri.; scope - The requested scope.; refreshToken - The refresh token. May be null.; nonce - The nonce.; claims - Additional claims requested (for id_token or userinfo).; request - The OAuth2 request.
Returns:: An Access Token.
Throws:: ServerException - If any internal server error occurs.; NotFoundException - If the realm does not have an OAuth 2.0 provider service.

createAccessToken

AccessToken createAccessToken(String grantType,
                              String accessTokenType,
                              String authorizationCode,
                              String resourceOwnerId,
                              String clientId,
                              String redirectUri,
                              Set<String> scope,
                              RefreshToken refreshToken,
                              String nonce,
                              String claims,
                              OAuth2Request request,
                              long authTime)
                       throws ServerException,
                              NotFoundException

Creates an Access Token and stores it in the OAuth2 Provider's store.

Parameters:: grantType - The grant type.; accessTokenType - The access token type.; authorizationCode - The authorization code.; resourceOwnerId - The resource owner's id.; clientId - The client's id.; redirectUri - The redirect uri.; scope - The requested scope.; refreshToken - The refresh token. May be null.; nonce - The nonce.; claims - Additional claims requested (for id_token or userinfo).; request - The OAuth2 request.; authTime - The end user's authentication time.
Returns:: An Access Token.
Throws:: ServerException - If any internal server error occurs.; NotFoundException - If the realm does not have an OAuth 2.0 provider service.