org.apache.shindig.auth

Class BasicSecurityToken

java.lang.Object

org.apache.shindig.auth.AbstractSecurityToken

org.apache.shindig.auth.BasicSecurityToken

All Implemented Interfaces:

SecurityToken

public class BasicSecurityToken
extends AbstractSecurityToken

Primitive token implementation that uses strings as tokens.

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
BasicSecurityToken()
BasicSecurityToken(String owner, String viewer, String app, String domain, String appUrl, String moduleId, String container, String activeUrl, Long expiresAt)

Method Summary

Methods

Modifier and Type	Method and Description
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()

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, setTimeSource, setTrustedJson, setViewerId, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicSecurityToken

public BasicSecurityToken(String owner,
                  String viewer,
                  String app,
                  String domain,
                  String appUrl,
                  String moduleId,
                  String container,
                  String activeUrl,
                  Long expiresAt)

BasicSecurityToken

public BasicSecurityToken()

Method Detail

getUpdatedToken

public String getUpdatedToken()

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()

Returns:

the authentication mechanism used to generate this security token

See Also:

AuthenticationMode

isAnonymous

public boolean isAnonymous()

Returns:

true if the token is for an anonymous viewer/owner

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.