org.apache.shindig.gadgets.oauth2

Class BasicOAuth2Store

java.lang.Object

org.apache.shindig.gadgets.oauth2.BasicOAuth2Store

All Implemented Interfaces:

OAuth2Store

public class BasicOAuth2Store
extends Object
implements OAuth2Store

see OAuth2Store Default OAuth2Store. Handles a persistence scenario with a separate cache and persistence layer. Uses 3 Guice bindings to achieve storage implementation. 1) OAuth2Persister 2) OAuth2Cache 3) OAuth2Encrypter

Constructor Summary

Constructors

Constructor and Description
BasicOAuth2Store(OAuth2Cache cache, OAuth2Persister persister, OAuth2Encrypter encrypter, String globalRedirectUri, Authority authority, String contextRoot, BlobCrypter stateCrypter)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAccessorCache() Clears all currently cached OAuth2Accessors.
boolean	clearCache() Clears any in-memory caching of OAuth2Accessors or Tokens.
void	clearClientCache() Clears all currently cache OAuth2Clients.
void	clearTokenCache() Clears all currently cached OAuth2Tokens.
OAuth2Token	createToken() Creates, but does not store, an OAuth2Token.
OAuth2Client	getClient(String gadgetUri, String serviceName)
protected String	getGadgetUri(String gadgetUri, String serviceName)
OAuth2Accessor	getOAuth2Accessor(OAuth2CallbackState state) Given an OAuth2CallbackState, see OAuth2Store.getOAuth2CallbackState, the store will return the OAuth2Accessor if it exists in storage but will not create a new one.
OAuth2Accessor	getOAuth2Accessor(String gadgetUri, String serviceName, String user, String scope) Will look for an accessor with the supplied mapping and return it.
BlobCrypter	getStateCrypter() Gets the OAuth2 state encrypter/decrypter
OAuth2Token	getToken(String gadgetUri, String serviceName, String user, String scope, OAuth2Token.Type type) Gets a token, if it exists, from the store.
boolean	init() Cues the store to clear it's current state and reload from persistence.
protected OAuth2Token	internalCreateToken()
OAuth2Client	invalidateClient(OAuth2Client client) Invalidate a cached client and force it to be reloaded from persistence.
OAuth2Token	invalidateToken(OAuth2Token token) Invalidate a cached token and force it to be reloaded from persistence.
OAuth2Accessor	removeOAuth2Accessor(OAuth2Accessor accessor) Removes an OAuth2Accessor from the store.
OAuth2Token	removeToken(OAuth2Token token) Removes an OAuth2Token from the store.
static boolean	runImport(OAuth2Persister source, OAuth2Persister target, boolean clean)
void	setToken(OAuth2Token token) Either inserts updates an OAuth2Token in the store.
void	storeOAuth2Accessor(OAuth2Accessor accessor) Either inserts updates an OAuth2Accessor in the store.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicOAuth2Store

@Inject
public BasicOAuth2Store(OAuth2Cache cache,
                       OAuth2Persister persister,
                       OAuth2Encrypter encrypter,
                       String globalRedirectUri,
                       Authority authority,
                       String contextRoot,
                       BlobCrypter stateCrypter)

Method Detail

clearCache

public boolean clearCache()
                   throws GadgetException

Description copied from interface: OAuth2Store

Clears any in-memory caching of OAuth2Accessors or Tokens.

Specified by:

clearCache in interface OAuth2Store

Returns:

true if the clear succeeded

Throws:

GadgetException - if the clear could not happen

createToken

public OAuth2Token createToken()

Description copied from interface: OAuth2Store

Creates, but does not store, an OAuth2Token. The token can then be initialized and stored.

Specified by:

createToken in interface OAuth2Store

Returns:

a new OAuth2Token

getClient

public OAuth2Client getClient(String gadgetUri,
                     String serviceName)
                       throws GadgetException

Throws:

GadgetException

getOAuth2Accessor

public OAuth2Accessor getOAuth2Accessor(OAuth2CallbackState state)

Description copied from interface: OAuth2Store

Given an OAuth2CallbackState, see OAuth2Store.getOAuth2CallbackState, the store will return the OAuth2Accessor if it exists in storage but will not create a new one.

Specified by:

getOAuth2Accessor in interface OAuth2Store

Parameters:

state - OAuth2CallbackState index of the accessor to get

Returns:

the OAuth2Accessor or null if it cannot be located

getOAuth2Accessor

public OAuth2Accessor getOAuth2Accessor(String gadgetUri,
                               String serviceName,
                               String user,
                               String scope)
                                 throws GadgetException

Description copied from interface: OAuth2Store

Will look for an accessor with the supplied mapping and return it. If one is not already stored a new one will be created and stored.

Specified by:

getOAuth2Accessor in interface OAuth2Store

Parameters:

gadgetUri - String URI of the gadget issuing the request

serviceName - String name of the OAuth2 service from the gadget spec

user - user userid of the page viewer

scope - String optional scope of the request. Supplied by the request or the gadget spec

Returns:

the OAuth2Accessor , never null

Throws:

GadgetException - if a lookup or creation error occurs

getToken

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

Description copied from interface: OAuth2Store

Gets a token, if it exists, from the store.

Specified by:

getToken in interface OAuth2Store

Parameters:

gadgetUri - String URI of the gadget issuing the request

serviceName - String name of the OAuth2 service from the gadget spec

user - user userid of the page viewer

scope - String optional scope of the request. Supplied by the request or the gadget spec

type - Type if the token, ACCESS or REFRESH

Returns:

the OAuth2Token for the supplied mapping, null if it isn't stored

Throws:

GadgetException - if something goes wrong

init

public boolean init()
             throws GadgetException

Description copied from interface: OAuth2Store

Cues the store to clear it's current state and reload from persistence.

Specified by:

init in interface OAuth2Store

Returns:

Throws:

GadgetException

removeOAuth2Accessor

public OAuth2Accessor removeOAuth2Accessor(OAuth2Accessor accessor)

Description copied from interface: OAuth2Store

Removes an OAuth2Accessor from the store.

Specified by:

removeOAuth2Accessor in interface OAuth2Store

Parameters:

accessor - to remove

Returns:

the accessor that was removed, or null if the accessor was already removed

removeToken

public OAuth2Token removeToken(OAuth2Token token)
                        throws GadgetException

Description copied from interface: OAuth2Store

Removes an OAuth2Token from the store.

Specified by:

removeToken in interface OAuth2Store

Parameters:

token - to remove

Returns:

the token that was removed, or null if the token was already removed\

Throws:

GadgetException - if something goes wrong

runImport

public static boolean runImport(OAuth2Persister source,
                OAuth2Persister target,
                boolean clean)

setToken

public void setToken(OAuth2Token token)
              throws GadgetException

Description copied from interface: OAuth2Store

Either inserts updates an OAuth2Token in the store.

Specified by:

setToken in interface OAuth2Store

Parameters:

token - to store

Throws:

GadgetException - if something goes wrong

storeOAuth2Accessor

public void storeOAuth2Accessor(OAuth2Accessor accessor)

Description copied from interface: OAuth2Store

Either inserts updates an OAuth2Accessor in the store.

Specified by:

storeOAuth2Accessor in interface OAuth2Store

Parameters:

accessor - to store

getGadgetUri

protected String getGadgetUri(String gadgetUri,
                  String serviceName)
                       throws GadgetException

Throws:

GadgetException

internalCreateToken

protected OAuth2Token internalCreateToken()

getStateCrypter

public BlobCrypter getStateCrypter()

Description copied from interface: OAuth2Store

Gets the OAuth2 state encrypter/decrypter

Specified by:

getStateCrypter in interface OAuth2Store

invalidateClient

public OAuth2Client invalidateClient(OAuth2Client client)

Description copied from interface: OAuth2Store

Invalidate a cached client and force it to be reloaded from persistence.

Specified by:

invalidateClient in interface OAuth2Store

Parameters:

client - to be invalidated

Returns:

the client that was invalidated, or null> if client could not be found

invalidateToken

public OAuth2Token invalidateToken(OAuth2Token token)

Description copied from interface: OAuth2Store

Invalidate a cached token and force it to be reloaded from persistence.

Specified by:

invalidateToken in interface OAuth2Store

Parameters:

token - to be invalidated

Returns:

the token that was invalidated, or null if token could not be found

clearAccessorCache

public void clearAccessorCache()
                        throws GadgetException

Description copied from interface: OAuth2Store

Clears all currently cached OAuth2Accessors.

Specified by:

clearAccessorCache in interface OAuth2Store

Throws:

GadgetException

clearTokenCache

public void clearTokenCache()
                     throws GadgetException

Description copied from interface: OAuth2Store

Clears all currently cached OAuth2Tokens. Does not remove them from persistence.

Specified by:

clearTokenCache in interface OAuth2Store

Throws:

GadgetException

clearClientCache

public void clearClientCache()
                      throws GadgetException

Description copied from interface: OAuth2Store

Clears all currently cache OAuth2Clients. Does not remove the from persistence.

Specified by:

clearClientCache in interface OAuth2Store

Throws:

GadgetException