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

Class AbstractSyncOAuth2TokenStorage

java.lang.Object

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

All Implemented Interfaces:

OAuth2TokenStorage

public abstract class AbstractSyncOAuth2TokenStorage
extends java.lang.Object
implements OAuth2TokenStorage

This is an abstract implementation of OAuth2TokenStorage which can be used in case the token storage can be implemented synchronously. As this is the case most of the time, application developers are recommended to use this class as a base instead of trying to implement OAuth2TokenStorage directly.

All the methods of the OAuth2TokenStorage interface have their synchronous counterparts in the form of protected methods starting with the prefix do*. Consult the documentation of these methods for the details.

Constructor Summary

Constructors

Constructor and Description
AbstractSyncOAuth2TokenStorage()

Method Summary

Modifier and Type	Method and Description
protected abstract OAuth2TokenWrapper	doGetTokenForKey(java.lang.String tokenStorageKey) Performs the same operation as tokensForKey(String) but does it synchronously.
protected abstract boolean	doRemoveAllTokens() Performs the same operation as removeAllTokens() but does it synchronously.
protected abstract boolean	doSaveTokens(java.lang.String tokenStorageKey, OAuth2TokenWrapper tokens) Performs the same operation as saveTokens(String, OAuth2TokenWrapper) but does it synchronously.
java.util.concurrent.Future<java.lang.Boolean>	removeAllTokens() Deletes all the tokens in this storage.
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

AbstractSyncOAuth2TokenStorage

public AbstractSyncOAuth2TokenStorage()

Method Detail

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

doGetTokenForKey

protected abstract OAuth2TokenWrapper doGetTokenForKey(java.lang.String tokenStorageKey)

Performs the same operation as tokensForKey(String) but does it synchronously. This method is called exclusively by tokensForKey(String).

Parameters:

tokenStorageKey - the token storage key, must be non-null

Returns:

the OAuth2 tokens in the form of a wrapper or null if no tokens were found

doSaveTokens

protected abstract boolean doSaveTokens(java.lang.String tokenStorageKey,
                                        OAuth2TokenWrapper tokens)

Performs the same operation as saveTokens(String, OAuth2TokenWrapper) but does it synchronously. This method is called exclusively by saveTokens(String, OAuth2TokenWrapper).

Parameters:

tokenStorageKey - the token storage key, must be non-null

tokens - the token object to save or null to remove the tokens for the given key

Returns:

true if the operation succeeded, false otherwise

doRemoveAllTokens

protected abstract boolean doRemoveAllTokens()

Performs the same operation as removeAllTokens() but does it synchronously. This method is called exclusively by removeAllTokens().

Returns:

true if removal succeeded, false otherwise