org.apache.shindig.gadgets.oauth2.persistence.sample

Class JSONOAuth2Persister

java.lang.Object

org.apache.shindig.gadgets.oauth2.persistence.sample.JSONOAuth2Persister

All Implemented Interfaces:

OAuth2Persister

public class JSONOAuth2Persister
extends Object
implements OAuth2Persister

Persistence implementation that reads config/oauth2.json on startup

Constructor Summary

Constructors

Constructor and Description
JSONOAuth2Persister(OAuth2Encrypter encrypter, Authority authority, String globalRedirectUri, String contextRoot)
JSONOAuth2Persister(OAuth2Encrypter encrypter, Authority authority, String globalRedirectUri, String contextRoot, JSONObject configFile)

Method Summary

Methods

Modifier and Type	Method and Description
OAuth2Token	createToken()
static OAuth2Client	findClient(Integer index)
OAuth2Client	findClient(String providerName, String gadgetUri) Retrieves a client from the persistence layer.
static OAuth2Provider	findProvider(Integer index)
static OAuth2Provider	findProvider(String providerName)
static OAuth2Token	findToken(Integer index)
OAuth2Token	findToken(String providerName, String gadgetUri, String user, String scope, OAuth2Token.Type type)
void	insertToken(OAuth2Token token) Inserts a new OAuth2Token into the persistence layer.
Set<OAuth2Client>	loadClients() Load all the clients from the persistence layer.
protected Map<String,OAuth2GadgetBinding>	loadGadgetBindings()
protected Map<String,OAuth2Provider>	loadProviders()
Set<OAuth2Token>	loadTokens() Load all the tokens from the persistence layer.
static boolean	removeToken(Integer index)
boolean	removeToken(String providerName, String gadgetUri, String user, String scope, OAuth2Token.Type type) Removes a token from the persistence layer.
void	updateToken(OAuth2Token token) Updates an existing OAuth2Token in the persistence layer.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONOAuth2Persister

@Inject
public JSONOAuth2Persister(OAuth2Encrypter encrypter,
                          Authority authority,
                          String globalRedirectUri,
                          String contextRoot)
                    throws OAuth2PersistenceException

Throws:

OAuth2PersistenceException

JSONOAuth2Persister

public JSONOAuth2Persister(OAuth2Encrypter encrypter,
                   Authority authority,
                   String globalRedirectUri,
                   String contextRoot,
                   JSONObject configFile)

Method Detail

createToken

public OAuth2Token createToken()

findClient

public static OAuth2Client findClient(Integer index)

findClient

public OAuth2Client findClient(String providerName,
                      String gadgetUri)
                        throws OAuth2PersistenceException

Description copied from interface: OAuth2Persister

Retrieves a client from the persistence layer. Returns null if not found.

Specified by:

findClient in interface OAuth2Persister

Returns:

the client in the given mapping, must return null if the client is not found

Throws:

OAuth2PersistenceException

findProvider

public static OAuth2Provider findProvider(Integer index)

findProvider

public static OAuth2Provider findProvider(String providerName)

findToken

public static OAuth2Token findToken(Integer index)

findToken

public OAuth2Token findToken(String providerName,
                    String gadgetUri,
                    String user,
                    String scope,
                    OAuth2Token.Type type)
                      throws OAuth2PersistenceException

Specified by:

findToken in interface OAuth2Persister

Returns:

the token in the given mapping

Throws:

OAuth2PersistenceException

insertToken

public void insertToken(OAuth2Token token)

Description copied from interface: OAuth2Persister

Inserts a new OAuth2Token into the persistence layer.

Specified by:

insertToken in interface OAuth2Persister

loadClients

public Set<OAuth2Client> loadClients()
                              throws OAuth2PersistenceException

Description copied from interface: OAuth2Persister

Load all the clients from the persistence layer. The BasicOAuth2Store.init() method will call this to prepopulate the cache.

Specified by:

loadClients in interface OAuth2Persister

Returns:

Throws:

OAuth2PersistenceException

loadGadgetBindings

protected Map<String,OAuth2GadgetBinding> loadGadgetBindings()
                                                      throws OAuth2PersistenceException

Throws:

OAuth2PersistenceException

loadProviders

protected Map<String,OAuth2Provider> loadProviders()
                                            throws OAuth2PersistenceException

Throws:

OAuth2PersistenceException

loadTokens

public Set<OAuth2Token> loadTokens()
                            throws OAuth2PersistenceException

Description copied from interface: OAuth2Persister

Load all the tokens from the persistence layer. The BasicOAuth2Store.init() method will call this to prepopulate the cache.

Specified by:

loadTokens in interface OAuth2Persister

Returns:

Throws:

OAuth2PersistenceException

removeToken

public static boolean removeToken(Integer index)

removeToken

public boolean removeToken(String providerName,
                  String gadgetUri,
                  String user,
                  String scope,
                  OAuth2Token.Type type)

Description copied from interface: OAuth2Persister

Removes a token from the persistence layer.

Specified by:

removeToken in interface OAuth2Persister

Returns:

updateToken

public void updateToken(OAuth2Token token)

Description copied from interface: OAuth2Persister

Updates an existing OAuth2Token in the persistence layer.

Specified by:

updateToken in interface OAuth2Persister