oauth1.strategy

Interface TokenMapStrategy

All Known Implementing Classes:

HashMapTokenMapStrategy

public interface TokenMapStrategy

An interface which provides a strategy to persistently map temporary tokens to temporary token secrets.

Method Summary

Modifier and Type	Method and Description
String	fetchTemporaryTokenSecretForTemporaryToken(String temporaryToken) Retrieve the value of a temporary token secret mapped to the given temporary token, which was mapped in the past via mapTemporaryTokenToTemporaryTokenSecret(String, String).
void	mapTemporaryTokenToTemporaryTokenSecret(String temporaryToken, String temporaryTokenSecret) Persistently map the given temporary token to the given temporary token secret.

Method Detail

mapTemporaryTokenToTemporaryTokenSecret

void mapTemporaryTokenToTemporaryTokenSecret(@Nonnull
                                             String temporaryToken,
                                             @Nonnull
                                             String temporaryTokenSecret)
                                      throws TokenMapException

Persistently map the given temporary token to the given temporary token secret.
This mapping should persist for the maximal permissible duration of the OAuth handshake procedure (e.g. 5 mins).
To be safe, the implementation would use a database and persist the mapping for a long duration, or permanently.

Parameters:

temporaryToken - The temporary token, i.e. the "key" of the mapping. In the future, we will fetch from the map this key, and return its corresponding temporary token secret.

temporaryTokenSecret - The temporary token secret, i.e. the "value" of the mapping. In the future, this value will be returned from the map after fetching its corresponding temporary token.

Throws:

TokenMapException - If the mapping failed.

fetchTemporaryTokenSecretForTemporaryToken

@Nullable
String fetchTemporaryTokenSecretForTemporaryToken(@Nonnull
                                                             String temporaryToken)
                                                      throws TokenMapException

Retrieve the value of a temporary token secret mapped to the given temporary token, which was mapped in the past via mapTemporaryTokenToTemporaryTokenSecret(String, String).

Parameters:

temporaryToken - The temporary token, i.e. the "key" which we would like to retrieve the value of in the map.

Returns:

The temporary token secret corresponding to the given temporary token, if such a mapping exists, otherwise null.

Throws:

TokenMapException - If the lookup failed.