org.apache.shindig.auth

Class DefaultSecurityTokenCodec

java.lang.Object

org.apache.shindig.auth.DefaultSecurityTokenCodec

All Implemented Interfaces:

SecurityTokenCodec

public class DefaultSecurityTokenCodec
extends Object
implements SecurityTokenCodec

Default implementation of security tokens. Decides based on default container configuration whether to use real crypto for security tokens or to use a simple insecure implementation that is useful for testing. Example configuration in container.js for insecure security tokens: gadgets.securityTokenType = insecure Example configuration in container.js for blob crypter based security tokens: gadgets.securityTokenType = secure The insecure implementation is BasicSecurityTokenCodec. The secure implementation is BlobCrypterSecurityTokenCodec.

Since:

2.0.0

Field Summary

Fields inherited from interface org.apache.shindig.auth.SecurityTokenCodec

ACTIVE_URL_NAME, SECURITY_TOKEN_NAME, SECURITY_TOKEN_TTL_CONFIG

Constructor Summary

Constructors

Constructor and Description
DefaultSecurityTokenCodec(ContainerConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
SecurityToken	createToken(Map<String,String> tokenParameters) Decrypts and verifies a gadget security token to return a gadget token.
String	encodeToken(SecurityToken token)
protected SecurityTokenCodec	getCodec()
int	getTokenTimeToLive() This method is deprecated in favor of SecurityTokenCodec.getTokenTimeToLive(String).
int	getTokenTimeToLive(String container)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSecurityTokenCodec

@Inject
public DefaultSecurityTokenCodec(ContainerConfig config)

Method Detail

createToken

public SecurityToken createToken(Map<String,String> tokenParameters)
                          throws SecurityTokenException

Description copied from interface: SecurityTokenCodec

Decrypts and verifies a gadget security token to return a gadget token.

Specified by:

createToken in interface SecurityTokenCodec

Parameters:

tokenParameters - Map containing a entry 'token' in wire format (probably encrypted.)

Returns:

the decrypted and verified token.

Throws:

SecurityTokenException - If tokenString is not a valid token

encodeToken

public String encodeToken(SecurityToken token)
                   throws SecurityTokenException

Specified by:

encodeToken in interface SecurityTokenCodec

Throws:

SecurityTokenException

getCodec

protected SecurityTokenCodec getCodec()

getTokenTimeToLive

public int getTokenTimeToLive()

Description copied from interface: SecurityTokenCodec

This method is deprecated in favor of SecurityTokenCodec.getTokenTimeToLive(String). Implementations should only rely on this method to return the default time-to-live of tokens generated by this codec in the case where getTokenTimeToLive(String) fails.

Specified by:

getTokenTimeToLive in interface SecurityTokenCodec

Returns:

The default amount of time a token generated by this codec can be expected to live.

See Also:

SecurityTokenCodec.getTokenTimeToLive(String)

getTokenTimeToLive

public int getTokenTimeToLive(String container)

Specified by:

getTokenTimeToLive in interface SecurityTokenCodec

Parameters:

container - The container the token is for

Returns:

The amount of time a token generated by this codec within the given container can be expected to live.