org.apache.shindig.gadgets.oauth2.persistence

Interface OAuth2Cache

All Known Implementing Classes:

InMemoryCache, MapCache

public interface OAuth2Cache

Used by OAuth2Store to cache OAuth2 data. Default implementation is in-memory HashMaps for shindig.

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.
OAuth2Client	getClient(String gadgetUri, String serviceName) Find an OAuth2Client.
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
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> tokens) Stores all tokens in the collection.

Method Detail

clearAccessors

void clearAccessors()
                    throws OAuth2CacheException

Clears all cached OAuth2Clients.

Throws:

OAuth2CacheException

clearClients

void clearClients()
                  throws OAuth2CacheException

Clears all cached OAuth2Clients.

Throws:

OAuth2CacheException

clearTokens

void clearTokens()
                 throws OAuth2CacheException

Clears all cached OAuth2Tokens.

Throws:

OAuth2CacheException

getClient

OAuth2Client getClient(String gadgetUri,
                     String serviceName)

Find an OAuth2Client.

Parameters:

gadgetUri -

serviceName -

Returns:

OAuth2Client

getOAuth2Accessor

OAuth2Accessor getOAuth2Accessor(OAuth2CallbackState state)

Find an OAuth2Accessor by state.

Parameters:

state -

Returns:

OAuth2Accessor

getToken

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

Find an OAuth2Token based on index

Parameters:

gadgetUri -

serviceName -

user -

scope -

type -

Returns:

an OAuth2Token

isPrimed

boolean isPrimed()

Returns:

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

removeClient

OAuth2Client removeClient(OAuth2Client client)

Remove the given client;

Parameters:

client -

Returns:

the client that was removed, or null if removal failed

removeOAuth2Accessor

OAuth2Accessor removeOAuth2Accessor(OAuth2Accessor accessor)

Remove the given accessor.

Parameters:

accessor -

Returns:

the accessor that was removed, or null if removal failed

removeToken

OAuth2Token removeToken(OAuth2Token token)

Remove the given token;

Parameters:

token -

Returns:

the token that was removed, or null if removal failed

storeClient

void storeClient(OAuth2Client client)
                 throws OAuth2CacheException

Stores the given client.

Parameters:

index -

client -

Throws:

OAuth2CacheException

storeClients

void storeClients(Collection<OAuth2Client> clients)
                  throws OAuth2CacheException

Store all clients in the collection.

Parameters:

clients -

Throws:

OAuth2CacheException

storeOAuth2Accessor

void storeOAuth2Accessor(OAuth2Accessor accessor)

Stores the given accessor.

Parameters:

accessor -

storeToken

void storeToken(OAuth2Token token)
                throws OAuth2CacheException

Stores the given token.

Throws:

OAuth2CacheException

storeTokens

void storeTokens(Collection<OAuth2Token> tokens)
                 throws OAuth2CacheException

Stores all tokens in the collection.

Parameters:

tokens -

Throws:

OAuth2CacheException