org.apache.shindig.gadgets

Class HashLockedDomainService

java.lang.Object

org.apache.shindig.gadgets.AbstractLockedDomainService

org.apache.shindig.gadgets.HashLockedDomainService

All Implemented Interfaces:

LockedDomainService

public class HashLockedDomainService
extends AbstractLockedDomainService

Locked domain implementation based on sha. The generated domain takes the form: base32(sha(gadget url)). Other domain locking schemes are possible as well.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCKED_DOMAIN_SUFFIX_KEY

Fields inherited from class org.apache.shindig.gadgets.AbstractLockedDomainService

LOCKED_DOMAIN_FEATURE, LOCKED_DOMAIN_REQUIRED_KEY, PERMITTED_REFERER_DOMAINS_KEY, permittedRefererDomains, required

Constructor Summary

Constructors

Constructor and Description
HashLockedDomainService(ContainerConfig config, boolean enabled, LockedDomainPrefixGenerator ldGen) Create a LockedDomainService

Method Summary

Methods

Modifier and Type	Method and Description
String	getLockedDomainForGadget(Gadget gadget, String container) Calculate the locked domain for a particular gadget on a particular container.
boolean	isGadgetValidForHost(String host, Gadget gadget, String container) Check whether a gadget should be allowed to render on a particular host.
boolean	isHostUsingLockedDomain(String host) Check whether a host is using a locked domain.
void	setAuthority(Authority authority)

Methods inherited from class org.apache.shindig.gadgets.AbstractLockedDomainService

isDomainLockingEnforced, isEnabled, isExcludedFromLockedDomain, isGadgetReqestingLocking, isRefererCheckEnabled, isSafeForOpenProxy, isValidReferer, setLockSecurityTokens, setRefererCheckEnabled

Methods inherited from class java.lang.Object

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

Field Detail

LOCKED_DOMAIN_SUFFIX_KEY

public static final String LOCKED_DOMAIN_SUFFIX_KEY

See Also:

Constant Field Values

Constructor Detail

HashLockedDomainService

@Inject
public HashLockedDomainService(ContainerConfig config,
                              boolean enabled,
                              LockedDomainPrefixGenerator ldGen)

Create a LockedDomainService

Parameters:

config - per-container configuration

enabled - whether this service should do anything at all.

Method Detail

getLockedDomainForGadget

public String getLockedDomainForGadget(Gadget gadget,
                              String container)
                                throws GadgetException

Description copied from interface: LockedDomainService

Calculate the locked domain for a particular gadget on a particular container.

Specified by:

getLockedDomainForGadget in interface LockedDomainService

Specified by:

getLockedDomainForGadget in class AbstractLockedDomainService

Parameters:

gadget - URL of the gadget

container - name of the container page

Returns:

the host name on which the gadget should render, or null if locked domain should not be used to render this gadget.

Throws:

GadgetException

isGadgetValidForHost

public boolean isGadgetValidForHost(String host,
                           Gadget gadget,
                           String container)

Description copied from interface: LockedDomainService

Check whether a gadget should be allowed to render on a particular host.

Specified by:

isGadgetValidForHost in interface LockedDomainService

Specified by:

isGadgetValidForHost in class AbstractLockedDomainService

Parameters:

host - host name for the content

gadget - URL of the gadget

container - container

Returns:

true if the gadget can render

isHostUsingLockedDomain

public boolean isHostUsingLockedDomain(String host)

Description copied from interface: LockedDomainService

Check whether a host is using a locked domain.

Specified by:

isHostUsingLockedDomain in interface LockedDomainService

Specified by:

isHostUsingLockedDomain in class AbstractLockedDomainService

Parameters:

host - Host to inspect for locked domain suffix.

Returns:

If the supplied host is using a locked domain. Returns false if locked domains are not enabled on the server.

setAuthority

@Inject(optional=true)
public void setAuthority(Authority authority)