org.apache.shindig.gadgets.oauth2.persistence

Class MapCache

java.lang.Object

org.apache.shindig.gadgets.oauth2.persistence.MapCache

All Implemented Interfaces:

OAuth2Cache

Direct Known Subclasses:

InMemoryCache

public abstract class MapCache
extends Object
implements OAuth2Cache

Constructor Summary

Constructors

Constructor and Description
MapCache()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAccessors() Clears all cached OAuth2Clients.
void	clearClients() Clears all cached OAuth2Clients.
void	clearTokens() Clears all cached OAuth2Tokens.
protected String	getAccessorKey(OAuth2Accessor accessor)
protected String	getAccessorKey(OAuth2CallbackState state)
protected String	getAccessorKey(String gadgetUri, String serviceName, String user, String scope)
protected abstract Map<String,OAuth2Accessor>	getAccessorMap()
OAuth2Client	getClient(String gadgetUri, String serviceName) Find an OAuth2Client.
protected String	getClientKey(OAuth2Client client)
protected String	getClientKey(String gadgetUri, String serviceName)
protected abstract Map<String,OAuth2Client>	getClientMap()
OAuth2Accessor	getOAuth2Accessor(OAuth2CallbackState state) Find an OAuth2Accessor by state.
OAuth2Token	getToken(String gadgetUri, String serviceName, String user, String scope, OAuth2Token.Type type) Find an OAuth2Token based on index
protected String	getTokenKey(OAuth2Token token)
protected String	getTokenKey(String gadgetUri, String serviceName, String user, String scope, OAuth2Token.Type type)
protected abstract Map<String,OAuth2Token>	getTokenMap()
boolean	isPrimed()
OAuth2Client	removeClient(OAuth2Client client) Remove the given client;
OAuth2Accessor	removeOAuth2Accessor(OAuth2Accessor accessor) Remove the given accessor.
OAuth2Token	removeToken(OAuth2Token token) Remove the given token;
void	storeClient(OAuth2Client client) Stores the given client.
void	storeClients(Collection<OAuth2Client> clients) Store all clients in the collection.
void	storeOAuth2Accessor(OAuth2Accessor accessor) Stores the given accessor.
void	storeToken(OAuth2Token token) Stores the given token.
void	storeTokens(Collection<OAuth2Token> storeTokens) Stores all tokens in the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapCache

public MapCache()

Method Detail

getClientMap

protected abstract Map<String,OAuth2Client> getClientMap()

getTokenMap

protected abstract Map<String,OAuth2Token> getTokenMap()

getAccessorMap

protected abstract Map<String,OAuth2Accessor> getAccessorMap()

clearClients

public void clearClients()
                  throws OAuth2CacheException

Description copied from interface: OAuth2Cache

Clears all cached OAuth2Clients.

Specified by:

clearClients in interface OAuth2Cache

Throws:

OAuth2CacheException

clearTokens

public void clearTokens()
                 throws OAuth2CacheException

Description copied from interface: OAuth2Cache

Clears all cached OAuth2Tokens.

Specified by:

clearTokens in interface OAuth2Cache

Throws:

OAuth2CacheException

clearAccessors

public void clearAccessors()

Description copied from interface: OAuth2Cache

Clears all cached OAuth2Clients.

Specified by:

clearAccessors in interface OAuth2Cache

storeTokens

public void storeTokens(Collection<OAuth2Token> storeTokens)
                 throws OAuth2CacheException

Description copied from interface: OAuth2Cache

Stores all tokens in the collection.

Specified by:

storeTokens in interface OAuth2Cache

Throws:

OAuth2CacheException

isPrimed

public boolean isPrimed()

Specified by:

isPrimed in interface OAuth2Cache

Returns:

true if the cache has already been primed. (presumably by another node.)

getClient

public OAuth2Client getClient(String gadgetUri,
                     String serviceName)

Description copied from interface: OAuth2Cache

Find an OAuth2Client.

Specified by:

getClient in interface OAuth2Cache

Returns:

OAuth2Client

getOAuth2Accessor

public OAuth2Accessor getOAuth2Accessor(OAuth2CallbackState state)

Description copied from interface: OAuth2Cache

Find an OAuth2Accessor by state.

Specified by:

getOAuth2Accessor in interface OAuth2Cache

Returns:

OAuth2Accessor

getToken

public OAuth2Token getToken(String gadgetUri,
                   String serviceName,
                   String user,
                   String scope,
                   OAuth2Token.Type type)

Description copied from interface: OAuth2Cache

Find an OAuth2Token based on index

Specified by:

getToken in interface OAuth2Cache

Returns:

an OAuth2Token

removeClient

public OAuth2Client removeClient(OAuth2Client client)

Description copied from interface: OAuth2Cache

Remove the given client;

Specified by:

removeClient in interface OAuth2Cache

Returns:

the client that was removed, or null if removal failed

removeOAuth2Accessor

public OAuth2Accessor removeOAuth2Accessor(OAuth2Accessor accessor)

Description copied from interface: OAuth2Cache

Remove the given accessor.

Specified by:

removeOAuth2Accessor in interface OAuth2Cache

Returns:

the accessor that was removed, or null if removal failed

removeToken

public OAuth2Token removeToken(OAuth2Token token)

Description copied from interface: OAuth2Cache

Remove the given token;

Specified by:

removeToken in interface OAuth2Cache

Returns:

the token that was removed, or null if removal failed

storeClient

public void storeClient(OAuth2Client client)
                 throws OAuth2CacheException

Description copied from interface: OAuth2Cache

Stores the given client.

Specified by:

storeClient in interface OAuth2Cache

Throws:

OAuth2CacheException

storeClients

public void storeClients(Collection<OAuth2Client> clients)
                  throws OAuth2CacheException

Description copied from interface: OAuth2Cache

Store all clients in the collection.

Specified by:

storeClients in interface OAuth2Cache

Throws:

OAuth2CacheException

storeOAuth2Accessor

public void storeOAuth2Accessor(OAuth2Accessor accessor)

Description copied from interface: OAuth2Cache

Stores the given accessor.

Specified by:

storeOAuth2Accessor in interface OAuth2Cache

storeToken

public void storeToken(OAuth2Token token)
                throws OAuth2CacheException

Description copied from interface: OAuth2Cache

Stores the given token.

Specified by:

storeToken in interface OAuth2Cache

Throws:

OAuth2CacheException

getClientKey

protected String getClientKey(OAuth2Client client)

getClientKey

protected String getClientKey(String gadgetUri,
                  String serviceName)

getAccessorKey

protected String getAccessorKey(OAuth2CallbackState state)

getAccessorKey

protected String getAccessorKey(String gadgetUri,
                    String serviceName,
                    String user,
                    String scope)

getAccessorKey

protected String getAccessorKey(OAuth2Accessor accessor)

getTokenKey

protected String getTokenKey(String gadgetUri,
                 String serviceName,
                 String user,
                 String scope,
                 OAuth2Token.Type type)

getTokenKey

protected String getTokenKey(OAuth2Token token)