org.apache.shindig.auth

Class BasicSecurityTokenCodec

java.lang.Object

org.apache.shindig.auth.BasicSecurityTokenCodec

All Implemented Interfaces:

SecurityTokenCodec, ContainerConfig.ConfigObserver

public class BasicSecurityTokenCodec
extends Object
implements SecurityTokenCodec, ContainerConfig.ConfigObserver

A SecurityTokenCodec implementation that just provides dummy data to satisfy tests and API calls. Do not use this for any security applications.

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
BasicSecurityTokenCodec() Creates a basic signer
BasicSecurityTokenCodec(ContainerConfig config) Creates a basic signer that can observe container configuration changes

Method Summary

Methods

Modifier and Type	Method and Description
void	containersChanged(ContainerConfig config, Collection<String> changed, Collection<String> removed) Notifies the object that some container configurations have been added or modified.
SecurityToken	createToken(Map<String,String> parameters) Decrypts and verifies a gadget security token to return a gadget token.
String	encodeToken(SecurityToken token) Encodes a token using the a plaintext dummy format.
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

BasicSecurityTokenCodec

public BasicSecurityTokenCodec()

Creates a basic signer

BasicSecurityTokenCodec

public BasicSecurityTokenCodec(ContainerConfig config)

Creates a basic signer that can observe container configuration changes

Parameters:

config - the container config to observe

Method Detail

encodeToken

public String encodeToken(SecurityToken token)

Encodes a token using the a plaintext dummy format.

Specified by:

encodeToken in interface SecurityTokenCodec

Parameters:

token - token to encode

Returns:

token with values separated by colons

createToken

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

Decrypts and verifies a gadget security token to return a gadget token. Returns a token with some faked out values.

Specified by:

createToken in interface SecurityTokenCodec

Parameters:

parameters - 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

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.

containersChanged

public void containersChanged(ContainerConfig config,
                     Collection<String> changed,
                     Collection<String> removed)

Notifies the object that some container configurations have been added or modified.

Specified by:

containersChanged in interface ContainerConfig.ConfigObserver

Parameters:

config - The ContainerConfig object where the configuration was changed.

changed - The names of the containers that have been added or modified.

removed - The names of the containers that have been removed.