com.atlassian.gadgets.spi
Interface GadgetSpecUrlRenderPermission

All Known Implementing Classes:

GadgetSpecUrlRenderPermissionImpl

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.

Nested Class Summary

static class

GadgetSpecUrlRenderPermission.Vote Possible responses when a GadgetSpecUrlRenderPermission implementation is asked if a URI can be rendered.

Method Summary

GadgetSpecUrlRenderPermission.Vote

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

Method Detail

voteOn

GadgetSpecUrlRenderPermission.Vote voteOn(String gadgetSpecUri)

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

Parameters:

gadgetSpecUri - the gadget spec URI to check

Returns:

this permission's Vote on whether to render the gadget