org.apache.shindig.gadgets.oauth

Class OAuthClientState

java.lang.Object

org.apache.shindig.auth.AbstractSecurityToken

org.apache.shindig.gadgets.oauth.OAuthClientState

All Implemented Interfaces:

SecurityToken

public class OAuthClientState
extends AbstractSecurityToken

Class to handle OAuth fetcher state stored client side. The state is stored as a signed, encrypted, time stamped blob.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.shindig.auth.AbstractSecurityToken

AbstractSecurityToken.Keys

Field Summary

Fields inherited from class org.apache.shindig.auth.AbstractSecurityToken

DEFAULT_MAX_TOKEN_TTL

Constructor Summary

Constructors

Constructor and Description
OAuthClientState(BlobCrypter crypter) Create a new, empty client state blob.
OAuthClientState(BlobCrypter crypter, String stateBlob) Initialize client state based on an encrypted blob passed by the client.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccessToken() OAuth access token.
String	getAccessTokenSecret() OAuth access token secret.
String	getAuthenticationMode()
String	getEncryptedState()
protected EnumSet<AbstractSecurityToken.Keys>	getMapKeys()
String	getOwner() Owner of the OAuth token.
String	getRequestToken() OAuth request token
String	getRequestTokenSecret() OAuth request token secret
String	getSessionHandle() Session handle (http://oauth.googlecode.com/svn/spec/ext/session/1.0/drafts/1/spec.html)
long	getTokenExpireMillis() Expiration of access token (http://oauth.googlecode.com/svn/spec/ext/session/1.0/drafts/1/spec.html)
String	getUpdatedToken()
boolean	isAnonymous()
boolean	isEmpty()
void	setAccessToken(String accessToken)
void	setAccessTokenSecret(String accessTokenSecret)
void	setOwner(String owner)
void	setRequestToken(String requestToken)
void	setRequestTokenSecret(String requestTokenSecret)
void	setSessionHandle(String sessionHandle)
protected AbstractSecurityToken	setTimeSource(TimeSource timeSource)
void	setTokenExpireMillis(long expirationMillis)

Methods inherited from class org.apache.shindig.auth.AbstractSecurityToken

enforceNotExpired, getActiveUrl, getAppId, getAppUrl, getContainer, getDomain, getExpiresAt, getMaxTokenTTL, getModuleId, getOwnerId, getTimeSource, getTrustedJson, getViewerId, isExpired, loadFromMap, setActiveUrl, setAppId, setAppUrl, setContainer, setDomain, setExpires, setExpires, setExpiresAt, setModuleId, setOwnerId, setTrustedJson, setViewerId, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthClientState

public OAuthClientState(BlobCrypter crypter)

Create a new, empty client state blob.

Parameters:

crypter -

OAuthClientState

public OAuthClientState(BlobCrypter crypter,
                String stateBlob)

Initialize client state based on an encrypted blob passed by the client.

Parameters:

crypter -

stateBlob -

Method Detail

isEmpty

public boolean isEmpty()

Returns:

true if there is no state to store with the client.

getEncryptedState

public String getEncryptedState()
                         throws BlobCrypterException

Returns:

an encrypted blob of state to store with the client.

Throws:

BlobCrypterException

getRequestToken

public String getRequestToken()

OAuth request token

setRequestToken

public void setRequestToken(String requestToken)

getRequestTokenSecret

public String getRequestTokenSecret()

OAuth request token secret

setRequestTokenSecret

public void setRequestTokenSecret(String requestTokenSecret)

getAccessToken

public String getAccessToken()

OAuth access token.

setAccessToken

public void setAccessToken(String accessToken)

getAccessTokenSecret

public String getAccessTokenSecret()

OAuth access token secret.

setAccessTokenSecret

public void setAccessTokenSecret(String accessTokenSecret)

getSessionHandle

public String getSessionHandle()

Session handle (http://oauth.googlecode.com/svn/spec/ext/session/1.0/drafts/1/spec.html)

setSessionHandle

public void setSessionHandle(String sessionHandle)

getTokenExpireMillis

public long getTokenExpireMillis()

Expiration of access token (http://oauth.googlecode.com/svn/spec/ext/session/1.0/drafts/1/spec.html)

setTokenExpireMillis

public void setTokenExpireMillis(long expirationMillis)

getOwner

public String getOwner()

Owner of the OAuth token.

setOwner

public void setOwner(String owner)

getUpdatedToken

public String getUpdatedToken()

getAuthenticationMode

public String getAuthenticationMode()

isAnonymous

public boolean isAnonymous()

getMapKeys

protected EnumSet<AbstractSecurityToken.Keys> getMapKeys()

Specified by:

getMapKeys in class AbstractSecurityToken

setTimeSource

protected AbstractSecurityToken setTimeSource(TimeSource timeSource)

Overrides:

setTimeSource in class AbstractSecurityToken