org.apache.shindig.gadgets.servlet

Class ModuleIdManagerImpl

java.lang.Object

org.apache.shindig.gadgets.servlet.ModuleIdManagerImpl

All Implemented Interfaces:

ModuleIdManager

public class ModuleIdManagerImpl
extends Object
implements ModuleIdManager

Override this class to provide meaningful moduleId validation and generation for gadgets.

Constructor Summary

Constructors

Constructor and Description
ModuleIdManagerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Long	generate(Uri gadgetUri, GadgetsHandlerApi.AuthContext containerAuthContext) Generate and persist a new moduleId for the given gadgetUri and container auth context.
Long	validate(Uri gadgetUri, GadgetsHandlerApi.AuthContext containerAuthContext, Long moduleId) Checks to make sure that the proposed moduleId for this gadget is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleIdManagerImpl

public ModuleIdManagerImpl()

Method Detail

validate

public Long validate(Uri gadgetUri,
            GadgetsHandlerApi.AuthContext containerAuthContext,
            Long moduleId)

Description copied from interface: ModuleIdManager

Checks to make sure that the proposed moduleId for this gadget is valid. This data is not 100% trustworthy becaue we can't extract it from a token, so we validate it here, usually against the AuthContext viewerId, gadgetUrl, moduleId combination. If the moduleId is invalid the implementation may return: null (in which case a null security token will be returned to the container) 0 (Default value for non-persisted gadgets) A newly generated moduleId If the supplied moduleId is valid, this function is expected to return the value of the moduleId param.

Specified by:

validate in interface ModuleIdManager

Parameters:

gadgetUri - The location of the gadget xml to validate the token for

containerAuthContext - The Auth context. Basically, the container security token.

moduleId - The moduleId sent by the container page.

Returns:

moduleId.

generate

public Long generate(Uri gadgetUri,
            GadgetsHandlerApi.AuthContext containerAuthContext)

Description copied from interface: ModuleIdManager

Generate and persist a new moduleId for the given gadgetUri and container auth context.

Specified by:

generate in interface ModuleIdManager

Parameters:

gadgetUri - The location of the gadget xml to generate the token for

containerAuthContext - The Auth context. Basically, the container security token.

Returns:

moduleId.