com.atlassian.gadgets.opensocial.spi
Interface GadgetSpecUrlRenderPermission

public interface GadgetSpecUrlRenderPermission

Used to check if a gadget spec URI is allowed to render on a dashboard. This may be implemented in a number of ways:

• for static dashboards, always return Vote.DENY unless the spec is on a whitelist;
• for dashboards with the directory plugin, an implementation might check that the gadget is in the directory, thus allowing admins to remove malicious gadgets from all dashboards (the directory plugin has a GadgetSpecUrlRenderPermissionImpl that does this);
• check against a user-specific white/black list of allowable gadget spec URIs.

Syntactically invalid URIs must never be allowed to render.

Since:

2.0

Method Summary

com.atlassian.gadgets.Vote

voteOn(String gadgetSpecUri) Returns the implementation's Vote on whether the specified gadget spec should be allowed to render.

Method Detail

voteOn

com.atlassian.gadgets.Vote voteOn(String gadgetSpecUri)

Returns the implementation's Vote on whether the specified gadget spec should be allowed to render.

If DENY is returned, the gadget URI is explicitly forbidden to render, no matter what any other implementations vote may be.

If ALLOW is returned, the gadget URI is explicitly allowed to render unless another implementation explicitly denies the rendering permission.

PASS will be returned if the implementation has no opinion on whether the URI may render.

Parameters:

gadgetSpecUri - the gadget spec URI to evaluate

Returns:

this implementation's Vote on whether to render the gadget