org.apache.shindig.gadgets

Class AbstractLockedDomainService

java.lang.Object

org.apache.shindig.gadgets.AbstractLockedDomainService

All Implemented Interfaces:

LockedDomainService

Direct Known Subclasses:

HashLockedDomainService

public abstract class AbstractLockedDomainService
extends Object
implements LockedDomainService

Provides a default implementation of much of the basic functionality for managing locked domains.

Since:

2.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	LOCKED_DOMAIN_FEATURE
protected static String	LOCKED_DOMAIN_REQUIRED_KEY
protected static String	PERMITTED_REFERER_DOMAINS_KEY
protected Map<String,List<Object>>	permittedRefererDomains
protected Map<String,Boolean>	required

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLockedDomainService(ContainerConfig config, boolean enabled) Create a LockedDomainService.

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getLockedDomainForGadget(Gadget gadget, String container) Calculate the locked domain for a particular gadget on a particular container.
protected boolean	isDomainLockingEnforced(String container) Returns true if domain locking is enforced for every gadget by the container
boolean	isEnabled() Check whether locked domains feature is enabled on the server.
protected boolean	isExcludedFromLockedDomain(Gadget gadget, String container) Override methods for custom behavior Allows you to override locked domain feature requests from a gadget.
protected boolean	isGadgetReqestingLocking(Gadget gadget) Returns true if the gadget is requesting to be on a locked domain.
abstract boolean	isGadgetValidForHost(String host, Gadget gadget, String container) Check whether a gadget should be allowed to render on a particular host.
abstract boolean	isHostUsingLockedDomain(String host) Check whether a host is using a locked domain.
boolean	isRefererCheckEnabled()
boolean	isSafeForOpenProxy(String host)
protected boolean	isValidReferer(Gadget gadget, String container) Check whether the referer value in the request head is in the permitted referer domain list or not.
void	setLockSecurityTokens(Boolean lockSecurityTokens) Allows a renderer to render all gadgets that require a security token on a locked domain.
void	setRefererCheckEnabled(boolean refererCheckEnabled)

Methods inherited from class java.lang.Object

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

Field Detail

LOCKED_DOMAIN_REQUIRED_KEY

protected static final String LOCKED_DOMAIN_REQUIRED_KEY

See Also:

Constant Field Values

PERMITTED_REFERER_DOMAINS_KEY

protected static final String PERMITTED_REFERER_DOMAINS_KEY

See Also:

Constant Field Values

LOCKED_DOMAIN_FEATURE

protected static final String LOCKED_DOMAIN_FEATURE

See Also:

Constant Field Values

required

protected final Map<String,Boolean> required

permittedRefererDomains

protected final Map<String,List<Object>> permittedRefererDomains

Constructor Detail

AbstractLockedDomainService

protected AbstractLockedDomainService(ContainerConfig config,
                           boolean enabled)

Create a LockedDomainService. This constructor should be called by implementors.

Parameters:

config - the container config that will be observed

enabled - true if locked domains are enabled; false otherwise

Method Detail

setRefererCheckEnabled

@Inject
public void setRefererCheckEnabled(boolean refererCheckEnabled)

getLockedDomainForGadget

public abstract 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

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

isEnabled

public boolean isEnabled()

Description copied from interface: LockedDomainService

Check whether locked domains feature is enabled on the server.

Specified by:

isEnabled in interface LockedDomainService

Returns:

If locked domains is enabled on the server.

isGadgetValidForHost

public abstract 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

Parameters:

host - host name for the content

gadget - URL of the gadget

container - container

Returns:

true if the gadget can render

isHostUsingLockedDomain

public abstract boolean isHostUsingLockedDomain(String host)

Description copied from interface: LockedDomainService

Check whether a host is using a locked domain.

Specified by:

isHostUsingLockedDomain in interface LockedDomainService

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.

isSafeForOpenProxy

public boolean isSafeForOpenProxy(String host)

Specified by:

isSafeForOpenProxy in interface LockedDomainService

Returns:

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

isRefererCheckEnabled

public boolean isRefererCheckEnabled()

Specified by:

isRefererCheckEnabled in interface LockedDomainService

Returns:

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

setLockSecurityTokens

@Inject(optional=true)
public void setLockSecurityTokens(Boolean lockSecurityTokens)

Allows a renderer to render all gadgets that require a security token on a locked domain. This is recommended security practice, as it secures the token from other gadgets, but because the "security-token" dependency on "locked-domain" is both implicit (added by GadgetSpec code for OAuth elements) and/or transitive (included by opensocial and opensocial-templates features), turning this behavior by default may take some by surprise. As such, we provide this flag. If false (by default), locked-domain will apply only when the gadget's Requires/Optional sections include it. Otherwise, the transitive dependency tree will be traversed to make this decision.

Parameters:

lockSecurityTokens - If true, locks domains for all gadgets requiring security-token.

isDomainLockingEnforced

protected boolean isDomainLockingEnforced(String container)

Returns true if domain locking is enforced for every gadget by the container

Parameters:

container - the container configuration, e.g., "default"

Returns:

true if domain locking is enforced by the container

isExcludedFromLockedDomain

protected boolean isExcludedFromLockedDomain(Gadget gadget,
                                 String container)

Override methods for custom behavior Allows you to override locked domain feature requests from a gadget.

isGadgetReqestingLocking

protected boolean isGadgetReqestingLocking(Gadget gadget)

Returns true if the gadget is requesting to be on a locked domain. If security token locking has been enabled via setLockSecurityTokens(Boolean), this method will return true if the gadget is explicitly or implicitly requesting locked domains; otherwise, this will return true only if the gadget is explicitly requesting locked domains.

Parameters:

gadget - the gadget

Returns:

true if the gadget is requesting to be on a locked domain

isValidReferer

protected boolean isValidReferer(Gadget gadget,
                     String container)

Check whether the referer value in the request head is in the permitted referer domain list or not.

Parameters:

gadget - the gadget

container - the container

Returns:

true if the referer is valid, otherwise return false.