OAuth2Store (Apache Shindig Gadget Renderer 2.5.2 API)

All Known Implementing Classes:

BasicOAuth2Store
```
public interface OAuth2Store
```
Interface to an OAuth 2.0 Data Store. A shindig gadget server can act as an OAuth 2.0 consumer, using OAuth 2.0 tokens to talk to OAuth 2.0 service providers on behalf of the gadgets it is proxying requests for. An OAuth 2.0 consumer needs to permanently store gadgets it has collected, and retrieve the appropriate tokens when proxying a request for a gadget. Access and Refresh OAuth2Token may be store in memory or pesisted out to a file system or database. OAuth2Store implementors are responsible for handling the gadgeturi, serviceName, user, scope mappings in the manor most effective for their environment. OAuth2Accessor storage should be cluster safe so it can be referenced by OAuth2CallbackServlet

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearAccessorCache()` Clears all currently cached `OAuth2Accessor`s.
`boolean`	`clearCache()` Clears any in-memory caching of OAuth2Accessors or Tokens.
`void`	`clearClientCache()` Clears all currently cache `OAuth2Client`s.
`void`	`clearTokenCache()` Clears all currently cached `OAuth2Token`s.
`OAuth2Token`	`createToken()` Creates, but does not store, an `OAuth2Token`.
`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.
`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.
`void`	`setToken(OAuth2Token token)` Either inserts updates an `OAuth2Token` in the store.
`void`	`storeOAuth2Accessor(OAuth2Accessor accessor)` Either inserts updates an `OAuth2Accessor` in the store.

- Method Detail
  - clearCache
```
boolean clearCache()
                   throws GadgetException
```
    Clears any in-memory caching of OAuth2Accessors or Tokens.
    
    Returns:
    true if the clear succeeded
    
    Throws:
    
    GadgetException - if the clear could not happen
  - createToken
```
OAuth2Token createToken()
```
    Creates, but does not store, an OAuth2Token. The token can then be initialized and stored.
    
    Returns:
    a new OAuth2Token
  - getOAuth2Accessor
```
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.
    
    Parameters:
    state - OAuth2CallbackState index of the accessor to get
    
    Returns:
    the OAuth2Accessor or null if it cannot be located
  - getOAuth2Accessor
```
OAuth2Accessor getOAuth2Accessor(String gadgetUri,
                               String serviceName,
                               String user,
                               String scope)
                                 throws GadgetException
```
    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.
    
    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
  - getStateCrypter
```
BlobCrypter getStateCrypter()
```
    Gets the OAuth2 state encrypter/decrypter
  - getToken
```
OAuth2Token getToken(String gadgetUri,
                   String serviceName,
                   String user,
                   String scope,
                   OAuth2Token.Type type)
                     throws GadgetException
```
    Gets a token, if it exists, from the store.
    
    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
```
boolean init()
             throws GadgetException
```
    Cues the store to clear it's current state and reload from persistence.
    
    Returns:
    
    Throws:
    
    GadgetException
  - removeOAuth2Accessor
```
OAuth2Accessor removeOAuth2Accessor(OAuth2Accessor accessor)
```
    Removes an OAuth2Accessor from the store.
    
    Parameters:
    accessor - to remove
    
    Returns:
    the accessor that was removed, or null if the accessor was already removed
  - removeToken
```
OAuth2Token removeToken(OAuth2Token token)
                        throws GadgetException
```
    Removes an OAuth2Token from the store.
    
    Parameters:
    token - to remove
    
    Returns:
    the token that was removed, or null if the token was already removed\
    
    Throws:
    
    GadgetException - if something goes wrong
  - setToken
```
void setToken(OAuth2Token token)
              throws GadgetException
```
    Either inserts updates an OAuth2Token in the store.
    
    Parameters:
    token - to store
    
    Throws:
    
    GadgetException - if something goes wrong
  - storeOAuth2Accessor
```
void storeOAuth2Accessor(OAuth2Accessor accessor)
```
    Either inserts updates an OAuth2Accessor in the store.
    
    Parameters:
    accessor - to store
  - invalidateClient
```
OAuth2Client invalidateClient(OAuth2Client client)
```
    Invalidate a cached client and force it to be reloaded from persistence.
    
    Parameters:
    client - to be invalidated
    
    Returns:
    the client that was invalidated, or null> if client could not be found
  - invalidateToken
```
OAuth2Token invalidateToken(OAuth2Token token)
```
    Invalidate a cached token and force it to be reloaded from persistence.
    
    Parameters:
    token - to be invalidated
    
    Returns:
    the token that was invalidated, or null if token could not be found
  - clearAccessorCache
```
void clearAccessorCache()
                        throws GadgetException
```
    Clears all currently cached OAuth2Accessors.
    
    Throws:
    
    GadgetException
  - clearTokenCache
```
void clearTokenCache()
                     throws GadgetException
```
    Clears all currently cached OAuth2Tokens. Does not remove them from persistence.
    
    Throws:
    
    GadgetException
  - clearClientCache
```
void clearClientCache()
                      throws GadgetException
```
    Clears all currently cache OAuth2Clients. Does not remove the from persistence.
    
    Throws:
    
    GadgetException

Interface OAuth2Store

Method Summary

Method Detail

clearCache

createToken

getOAuth2Accessor

getOAuth2Accessor

getStateCrypter

getToken

init

removeOAuth2Accessor

removeToken

setToken

storeOAuth2Accessor

invalidateClient

invalidateToken

clearAccessorCache

clearTokenCache

clearClientCache