com.sap.smp.client.httpc.authflows.oauth2

Class InMemoryOAuth2TokenStorage

java.lang.Object

com.sap.smp.client.httpc.authflows.oauth2.InMemoryOAuth2TokenStorage

All Implemented Interfaces:

OAuth2TokenStorage

public final class InMemoryOAuth2TokenStorage
extends java.lang.Object
implements OAuth2TokenStorage

Thread-safe, in-memory implementation of the OAuth2 token storage interface. This is used as the default if none is set externally.

This in-memory storage, as its name implies, lives as long as the application process is running. Internally, it uses a ConcurrentHashMap to store the tokens.

If you need to persist the tokens somehow then use the saveStorageToBundle(Bundle, String) method to save the data to a bundle and the readStorageFromBundle(Bundle, String) to restore it later. The best place to use this methods are the lifecycle callbacks of an Activity or Fragment.

Constructor Summary

Constructors

Constructor and Description
InMemoryOAuth2TokenStorage() Creates a new, empty in-memory storage.

Method Summary

Modifier and Type	Method and Description
static InMemoryOAuth2TokenStorage	readStorageFromBundle(android.os.Bundle bundle, java.lang.String storageName) Retrieve token storage from the specified bundle.
java.util.concurrent.Future<java.lang.Boolean>	removeAllTokens() Deletes all the tokens in this storage.
void	saveStorageToBundle(android.os.Bundle bundle, java.lang.String storageName) Save token storage into the specified bundle.
java.util.concurrent.Future<java.lang.Boolean>	saveTokens(java.lang.String tokenStorageKey, OAuth2TokenWrapper tokens) Saves the tokens carried by the specified wrapper for the given opaque token storage key.
java.util.concurrent.Future<OAuth2TokenWrapper>	tokensForKey(java.lang.String tokenStorageKey) Returns the token wrapper object for the specified opaque token storage key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InMemoryOAuth2TokenStorage

public InMemoryOAuth2TokenStorage()

Creates a new, empty in-memory storage.

Method Detail

readStorageFromBundle

public static InMemoryOAuth2TokenStorage readStorageFromBundle(android.os.Bundle bundle,
                                                               java.lang.String storageName)

Retrieve token storage from the specified bundle. If the specified bundle is null then this method does nothing.

Parameters:

bundle - bundle which contains the storage, can be null

storageName - storage name for retrieve the token storage, must be non-null

Returns:

the token storage or null if none could have been retrieved

tokensForKey

public java.util.concurrent.Future<OAuth2TokenWrapper> tokensForKey(java.lang.String tokenStorageKey)

Description copied from interface: OAuth2TokenStorage

Returns the token wrapper object for the specified opaque token storage key.

Specified by:

tokensForKey in interface OAuth2TokenStorage

Parameters:

tokenStorageKey - the opaque token storage key to return the tokens for, must be non-null

Returns:

the future object through which the token can be acquired, always non-null

saveTokens

public java.util.concurrent.Future<java.lang.Boolean> saveTokens(java.lang.String tokenStorageKey,
                                                                 OAuth2TokenWrapper tokens)

Description copied from interface: OAuth2TokenStorage

Saves the tokens carried by the specified wrapper for the given opaque token storage key. If the tokens argument is null then the tokens are deleted for the given key.

Specified by:

saveTokens in interface OAuth2TokenStorage

Parameters:

tokenStorageKey - the opaque token storage key to save the tokens for, must be non-null

tokens - the token wrapper whose contents are to be saved, can be null

Returns:

a future object returning whether the operation succeeded or not, always non-null

removeAllTokens

public java.util.concurrent.Future<java.lang.Boolean> removeAllTokens()

Description copied from interface: OAuth2TokenStorage

Deletes all the tokens in this storage.

Specified by:

removeAllTokens in interface OAuth2TokenStorage

Returns:

a future object returning whether the operation succeeded or not, always non-null

saveStorageToBundle

public void saveStorageToBundle(android.os.Bundle bundle,
                                java.lang.String storageName)

Save token storage into the specified bundle. If the specified bundle is null then this method does nothing.

Parameters:

bundle - save storage to the bundle, can be null

storageName - storage name to save the token storage, must be non-null