org.apache.shindig.auth

Class AnonymousSecurityToken

java.lang.Object

org.apache.shindig.auth.AbstractSecurityToken

org.apache.shindig.auth.AnonymousSecurityToken

All Implemented Interfaces:

SecurityToken

public class AnonymousSecurityToken
extends AbstractSecurityToken
implements SecurityToken

A special class of Token representing the anonymous viewer/owner

Nested Class Summary

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

AbstractSecurityToken.Keys

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS_ID The user ID for anonymous users.

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

DEFAULT_MAX_TOKEN_TTL

Constructor Summary

Constructors

Constructor and Description
AnonymousSecurityToken()
AnonymousSecurityToken(String container)
AnonymousSecurityToken(String container, Long moduleId, String appUrl)

Method Summary

Methods

Modifier and Type	Method and Description
String	getActiveUrl()
String	getAppId()
String	getAuthenticationMode()
protected EnumSet<AbstractSecurityToken.Keys>	getMapKeys() This method will govern the effectiveness of the protected AbstractSecurityToken.toMap() and #loadFromMap(SecurityToken, Map) helper methods.
String	getUpdatedToken()
boolean	isAnonymous()
protected AbstractSecurityToken	setExpires() Compute and set the expiration time for this token using the default TTL.
protected AbstractSecurityToken	setExpiresAt(Long expiresAt) Set the expiration time for this token.

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.shindig.auth.SecurityToken

getAppUrl, getContainer, getDomain, getExpiresAt, getModuleId, getOwnerId, getTrustedJson, getViewerId, isExpired

Field Detail

ANONYMOUS_ID

public static final String ANONYMOUS_ID

The user ID for anonymous users.

See Also:

Constant Field Values

Constructor Detail

AnonymousSecurityToken

public AnonymousSecurityToken()

AnonymousSecurityToken

public AnonymousSecurityToken(String container)

AnonymousSecurityToken

public AnonymousSecurityToken(String container,
                      Long moduleId,
                      String appUrl)

Method Detail

getAppId

public String getAppId()

Specified by:

getAppId in interface SecurityToken

Overrides:

getAppId in class AbstractSecurityToken

Returns:

the application id from the token, or null if there is none.

setExpires

protected AbstractSecurityToken setExpires()

Description copied from class: AbstractSecurityToken

Compute and set the expiration time for this token using the default TTL.

Overrides:

setExpires in class AbstractSecurityToken

Returns:

This security token.

See Also:

AbstractSecurityToken.setExpires(int)

setExpiresAt

protected AbstractSecurityToken setExpiresAt(Long expiresAt)

Description copied from class: AbstractSecurityToken

Set the expiration time for this token.

Overrides:

setExpiresAt in class AbstractSecurityToken

Parameters:

expiresAt - When this token expires, in seconds since epoch.

Returns:

This security token.

isAnonymous

public boolean isAnonymous()

Specified by:

isAnonymous in interface SecurityToken

Returns:

true if the token is for an anonymous viewer/owner

getUpdatedToken

public String getUpdatedToken()

Specified by:

getUpdatedToken in interface SecurityToken

Returns:

an updated version of the token to return to the gadget, or null if there is no need to update the token.

getAuthenticationMode

public String getAuthenticationMode()

Specified by:

getAuthenticationMode in interface SecurityToken

Returns:

the authentication mechanism used to generate this security token

See Also:

AuthenticationMode

getActiveUrl

public String getActiveUrl()

Specified by:

getActiveUrl in interface SecurityToken

Overrides:

getActiveUrl in class AbstractSecurityToken

Returns:

the URL being used by the current request and null if not specified. The returned URL must contain at least protocol, host, and port. The returned URL may contain path or query parameters.

getMapKeys

protected EnumSet<AbstractSecurityToken.Keys> getMapKeys()

Description copied from class: AbstractSecurityToken

This method will govern the effectiveness of the protected AbstractSecurityToken.toMap() and #loadFromMap(SecurityToken, Map) helper methods.

If your implementation throws an exception on any of the get methods, you should not include the associated key here, and those values should be handled in an overridden implementation of AbstractSecurityToken.toMap() if they might contain useful information.

Specified by:

getMapKeys in class AbstractSecurityToken

Returns:

An EnumSet of the Enums supported by the implementation of this AbstractSecurityToken.