forgerock-auth

4.4.0

forgerock-auth/org.forgerock.android.auth/DefaultTokenManager

DefaultTokenManager

open class DefaultTokenManager : TokenManager

Default implementation for TokenManager. By default this class uses SecuredSharedPreferences to persist the token locally on the device. However, it can be overridden by the builder For example, it can replaced with Android JetPack androidx.security.crypto.EncryptedSharedPreferences

This TokenManager supports AccessToken in-memory caching. To control the caching interval use builder. with the encryption/decryption, disk and Keystore IO, it may drains device CPU and Battery resources. If Application intensively with network operation, setting the this attribute may improve performance.

Constructors

DefaultTokenManager

constructor(@NonNull context: Context, oAuth2Client: OAuth2Client, sharedPreferences: SharedPreferences, cacheIntervalMillis: Long, threshold: Long)

Properties

private val accessTokenRef: AtomicReference<CacheEntry<AccessToken>>

cacheIntervalMillis

private val cacheIntervalMillis: Long

private val oAuth2Client: OAuth2Client

The OAuth2Client to auto refresh AccessToken

ORG_FORGEROCK_V_1_KEYS

val ORG_FORGEROCK_V_1_KEYS: String = "org.forgerock.v1.KEYS"

ORG_FORGEROCK_V_1_TOKENS

val ORG_FORGEROCK_V_1_TOKENS: String = "org.forgerock.v1.TOKENS"

sharedPreferences

private open var sharedPreferences: SharedPreferences

The SharedPreferences to store the tokens

private val TAG: String = "DefaultTokenManager"

private val threshold: Long

Threshold to refresh the AccessToken

private val worker: ScheduledExecutorService

Functions

private open fun cache(accessToken: AccessToken)

Cache the AccessToken in memory and setup a worker thread to clear it after.

open fun clear()

Remove the stored AccessToken

open fun exchangeToken(@NonNull token: SSOToken, @NonNull additionalParameters: Map<String, String>, listener: FRListener<AccessToken>)

open fun exchangeToken(code: String, pkce: PKCE, additionalParameters: Map<String, String>, listener: FRListener<AccessToken>)

Sends an authorization request to the authorization service.

open fun getAccessToken(verifier: AccessTokenVerifier, tokenListener: FRListener<AccessToken>)

Get the AccessToken asynchronously, If the stored AccessToken is expired, auto refresh the token

getAccessTokenLocally

private open fun getAccessTokenLocally(): AccessToken

Retrieve AccessToken from cache or from storage.

open fun hasToken(): Boolean

Check if token exists in the storage.

open fun persist(@NonNull accessToken: AccessToken)

Persist the AccessToken to storage

open fun refresh(@NonNull accessToken: AccessToken, listener: FRListener<AccessToken>)

Refresh the AccessToken asynchronously, force token refresh, no matter the stored AccessToken is expired or not refresh the token and persist it.

open fun revoke(listener: FRListener<Void>)

OAuth2 Token Revocation