com.atlassian.gadgets.renderer.internal
Class GadgetSpecUrlCheckerImpl

java.lang.Object
  com.atlassian.gadgets.renderer.internal.GadgetSpecUrlCheckerImpl

All Implemented Interfaces:

GadgetSpecUrlChecker

public class GadgetSpecUrlCheckerImpl
extends Object
implements GadgetSpecUrlChecker

Default implementation which uses GadgetSpecUrlRenderPermission implementations provided by OSGi to see if gadgets may be rendered.

The permission handling scheme implemented here follows these rules:

• Any one DENY is cause for refusing to render the gadget.
• At least one permission must vote to ALLOW the gadget to render. If all permissions PASS on the decision, rendering will be refused.
• A vote to DENY overrides any number of votes to ALLOW.
• If no permissions are defined, no gadget may render.

Constructor Summary

GadgetSpecUrlCheckerImpl(Iterable<GadgetSpecUrlRenderPermission> permissions)
Constructor.

Method Summary

void	assertRenderable(String gadgetSpecUri) Returns normally if the specified gadget spec is permitted to render.

Methods inherited from class java.lang.Object

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

Constructor Detail

GadgetSpecUrlCheckerImpl

public GadgetSpecUrlCheckerImpl(Iterable<GadgetSpecUrlRenderPermission> permissions)

Constructor. Empty permissions are permitted, but they must point to instances or proxies when assertRenderable() is called. Null permissions are an error.

Parameters:

permissions - an Iterable of permissions to use for accepting or rejecting a request to render a gadget

Throws:

NullPointerException - if permissions is null

Method Detail

assertRenderable

public void assertRenderable(String gadgetSpecUri)

Description copied from interface: GadgetSpecUrlChecker

Returns normally if the specified gadget spec is permitted to render.

Specified by:

assertRenderable in interface GadgetSpecUrlChecker

Parameters:

gadgetSpecUri - the gadget spec to render