org.apache.shindig.gadgets

Interface LockedDomainService

All Known Implementing Classes:

AbstractLockedDomainService, HashLockedDomainService

public interface LockedDomainService

Interface for locked domain, a security mechanism that ensures that a gadget is always registered on a fixed, unique domain. This prevents attacks from other gadgets that are rendered on the same domain, since all modern web browsers implement a same origin policy that prevents pages served from different hosts from accessing each other's data.

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	isEnabled() Check whether locked domains feature is enabled on the server.
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.
boolean	isRefererCheckEnabled()
boolean	isSafeForOpenProxy(String host)

Method Detail

isEnabled

boolean isEnabled()

Check whether locked domains feature is enabled on the server.

Returns:

If locked domains is enabled on the server.

isSafeForOpenProxy

boolean isSafeForOpenProxy(String host)

Returns:

True if the host is safe for use with the open proxy.

isGadgetValidForHost

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

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

Parameters:

host - host name for the content

gadget - URL of the gadget

container - container

Returns:

true if the gadget can render

getLockedDomainForGadget

String getLockedDomainForGadget(Gadget gadget,
                              String container)
                                throws GadgetException

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

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

isHostUsingLockedDomain

boolean isHostUsingLockedDomain(String host)

Check whether a host is using a locked domain.

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.

isRefererCheckEnabled

boolean isRefererCheckEnabled()

Returns:

If referrer check is enabled, return true. Otherwise, return false.