org.opensocial.explorer.server.oauth

Class OSEOAuthStore

java.lang.Object

org.opensocial.explorer.server.oauth.OSEOAuthStore

All Implemented Interfaces:

org.apache.shindig.gadgets.oauth.OAuthStore

public class OSEOAuthStore
extends Object
implements org.apache.shindig.gadgets.oauth.OAuthStore

Basic OAuth store for OAuth 1.0a keys and secrets and tokens. The current implementation reads from a JSON file for the initial set of service providers. Unlike the Shindig implementation of OAuthStore we don't restrict a service provider to a single gadget. Instead any gadget may use and service provider as long as it uses the correct service name. This is probably not something you want to do in a production environment but for development it should be OK.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.shindig.gadgets.oauth.OAuthStore

org.apache.shindig.gadgets.oauth.OAuthStore.ConsumerInfo, org.apache.shindig.gadgets.oauth.OAuthStore.TokenInfo

Constructor Summary

Constructors

Constructor and Description
OSEOAuthStore() Token store for the OpenSocial Explorer.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.shindig.gadgets.oauth.OAuthStore.ConsumerInfo	getConsumerKeyAndSecret(org.apache.shindig.auth.SecurityToken securityToken, String serviceName, net.oauth.OAuthServiceProvider provider)
org.apache.shindig.gadgets.oauth.OAuthStore.TokenInfo	getTokenInfo(org.apache.shindig.auth.SecurityToken securityToken, org.apache.shindig.gadgets.oauth.OAuthStore.ConsumerInfo consumerInfo, String serviceName, String tokenName)
void	init(String config) Initializes the key and secret store from a JSON string.
void	removeToken(org.apache.shindig.auth.SecurityToken securityToken, org.apache.shindig.gadgets.oauth.OAuthStore.ConsumerInfo consumerInfo, String serviceName, String tokenName)
void	setAuthority(org.apache.shindig.common.servlet.Authority authority) Sets the authority to use for OAuth services.
void	setDefaultCallbackUrl(String url) Sets the default callback URL to use for OAuth services.
void	setTokenInfo(org.apache.shindig.auth.SecurityToken securityToken, org.apache.shindig.gadgets.oauth.OAuthStore.ConsumerInfo consumerInfo, String serviceName, String tokenName, org.apache.shindig.gadgets.oauth.OAuthStore.TokenInfo tokenInfo)

Methods inherited from class java.lang.Object

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

Constructor Detail

OSEOAuthStore

public OSEOAuthStore()

Token store for the OpenSocial Explorer.

Method Detail

init

public void init(String config)

Initializes the key and secret store from a JSON string. The JSON should follow this format:

 {
   "ServiceName" : {
     "consumer_key" : "<Your Consumer Key>",
     "consumer_secret" : "<Your Consumer Secret>",
     "key_type" : "HMAC_SYMMETRIC",
     "callback_url" : "http://localhost:8080/gadgets/oauthcallback"
   }
 }
 
 

Parameters:

config - JSON configuration String.

getConsumerKeyAndSecret

public org.apache.shindig.gadgets.oauth.OAuthStore.ConsumerInfo getConsumerKeyAndSecret(org.apache.shindig.auth.SecurityToken securityToken,
                                                                               String serviceName,
                                                                               net.oauth.OAuthServiceProvider provider)
                                                                                 throws org.apache.shindig.gadgets.GadgetException

Specified by:

getConsumerKeyAndSecret in interface org.apache.shindig.gadgets.oauth.OAuthStore

Throws:

org.apache.shindig.gadgets.GadgetException

getTokenInfo

public org.apache.shindig.gadgets.oauth.OAuthStore.TokenInfo getTokenInfo(org.apache.shindig.auth.SecurityToken securityToken,
                                                                 org.apache.shindig.gadgets.oauth.OAuthStore.ConsumerInfo consumerInfo,
                                                                 String serviceName,
                                                                 String tokenName)
                                                                   throws org.apache.shindig.gadgets.GadgetException

Specified by:

getTokenInfo in interface org.apache.shindig.gadgets.oauth.OAuthStore

Throws:

org.apache.shindig.gadgets.GadgetException

setTokenInfo

public void setTokenInfo(org.apache.shindig.auth.SecurityToken securityToken,
                org.apache.shindig.gadgets.oauth.OAuthStore.ConsumerInfo consumerInfo,
                String serviceName,
                String tokenName,
                org.apache.shindig.gadgets.oauth.OAuthStore.TokenInfo tokenInfo)
                  throws org.apache.shindig.gadgets.GadgetException

Specified by:

setTokenInfo in interface org.apache.shindig.gadgets.oauth.OAuthStore

Throws:

org.apache.shindig.gadgets.GadgetException

removeToken

public void removeToken(org.apache.shindig.auth.SecurityToken securityToken,
               org.apache.shindig.gadgets.oauth.OAuthStore.ConsumerInfo consumerInfo,
               String serviceName,
               String tokenName)
                 throws org.apache.shindig.gadgets.GadgetException

Specified by:

removeToken in interface org.apache.shindig.gadgets.oauth.OAuthStore

Throws:

org.apache.shindig.gadgets.GadgetException

setDefaultCallbackUrl

public void setDefaultCallbackUrl(String url)

Sets the default callback URL to use for OAuth services.

Parameters:

url - Default callback URL.

setAuthority

public void setAuthority(org.apache.shindig.common.servlet.Authority authority)

Sets the authority to use for OAuth services.

Parameters:

authority - The authority.