org.apache.shindig.gadgets.oauth2.persistence

Interface OAuth2Persister

All Known Implementing Classes:

JSONOAuth2Persister

public interface OAuth2Persister

Interface, used primarily by OAuth2Store, to manage OAuth2Accessor and OAuth2Token storage. An OAuth2Accessor has the same basic information as the OAuth2Client, merged with gadget spec and request prefs. OAuth2Accessor is short lived, for the life of one request. OAuth2Clients is intended to be persisted and cached. The default persister for shindig is JSONOAuth2Persister

Method Summary

Methods

Modifier and Type	Method and Description
OAuth2Client	findClient(String gadgetUri, String serviceName) Retrieves a client from the persistence layer.
OAuth2Token	findToken(String gadgetUri, String serviceName, 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.
Set<OAuth2Token>	loadTokens() Load all the tokens from the persistence layer.
boolean	removeToken(String gadgetUri, String serviceName, 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.

Method Detail

findClient

OAuth2Client findClient(String gadgetUri,
                      String serviceName)
                        throws OAuth2PersistenceException

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

Parameters:

gadgetUri -

serviceName -

Returns:

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

Throws:

OAuth2PersistenceException

findToken

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

Parameters:

gadgetUri -

serviceName -

user -

scope -

type -

Returns:

the token in the given mapping

Throws:

OAuth2PersistenceException

insertToken

void insertToken(OAuth2Token token)
                 throws OAuth2PersistenceException

Inserts a new OAuth2Token into the persistence layer.

Parameters:

token -

Throws:

OAuth2PersistenceException

loadClients

Set<OAuth2Client> loadClients()
                              throws OAuth2PersistenceException

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

Returns:

Throws:

OAuth2PersistenceException

loadTokens

Set<OAuth2Token> loadTokens()
                            throws OAuth2PersistenceException

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

Returns:

Throws:

OAuth2PersistenceException

removeToken

boolean removeToken(String gadgetUri,
                  String serviceName,
                  String user,
                  String scope,
                  OAuth2Token.Type type)
                    throws OAuth2PersistenceException

Removes a token from the persistence layer.

Parameters:

gadgetUri -

serviceName -

user -

scope -

type -

Returns:

Throws:

OAuth2PersistenceException

updateToken

void updateToken(OAuth2Token token)
                 throws OAuth2PersistenceException

Updates an existing OAuth2Token in the persistence layer.

Parameters:

token -

Throws:

OAuth2PersistenceException