org.apache.shindig.auth

Interface SecurityTokenCodec

All Known Implementing Classes:

BasicSecurityTokenCodec, BlobCrypterSecurityTokenCodec, DefaultSecurityTokenCodec

public interface SecurityTokenCodec

Handles verification of gadget security tokens.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE_URL_NAME Active URL for the request.
static String	SECURITY_TOKEN_NAME The security token value must be passed on a map value referenced by this key.
static String	SECURITY_TOKEN_TTL_CONFIG The configuration parameter for security token time-to-lives.

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)
int	getTokenTimeToLive() Deprecated.
int	getTokenTimeToLive(String container)

Field Detail

SECURITY_TOKEN_NAME

static final String SECURITY_TOKEN_NAME

The security token value must be passed on a map value referenced by this key. Additional parameters can be passed as seen fit.

See Also:

Constant Field Values

ACTIVE_URL_NAME

static final String ACTIVE_URL_NAME

Active URL for the request. Must include protocol, host, and port. May include path and may include query.

See Also:

Constant Field Values

SECURITY_TOKEN_TTL_CONFIG

static final String SECURITY_TOKEN_TTL_CONFIG

The configuration parameter for security token time-to-lives.

See Also:

Constant Field Values

Method Detail

createToken

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

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

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

String encodeToken(SecurityToken token)
                   throws SecurityTokenException

Throws:

SecurityTokenException

getTokenTimeToLive

@Deprecated
int getTokenTimeToLive()

Deprecated.

This method is deprecated in favor of 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.

Returns:

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

See Also:

getTokenTimeToLive(String)

getTokenTimeToLive

int getTokenTimeToLive(String container)

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.