Summary: Methods | [Expand All]
public interface

ConfluenceGadgetWhitelistManager

com.atlassian.confluence.plugins.gadgets.whitelist.ConfluenceGadgetWhitelistManager
Known Indirect Subclasses

Summary

Public Methods
abstract void add(String uri)
Add the given uri to the whitelist.
abstract boolean allows(URI uri)
Checks if the uri given should be allowed or not
abstract Set<String> getAllUserConfiguredRules()
Returns a set with all the rules configured in this whitelist.
abstract void remove(String uri)
Remove the given uri from the whitelist.

Public Methods

public abstract void add (String uri)

Add the given uri to the whitelist. If the whitelist already contains the uri this method should not do anything.

Parameters
uri uri to add.

public abstract boolean allows (URI uri)

Checks if the uri given should be allowed or not

Parameters
uri uri to check.
Returns
  • true if the passed in uri is allowed.

public abstract Set<String> getAllUserConfiguredRules ()

Returns a set with all the rules configured in this whitelist. Implementations should ensure the returned value is immutable.

Returns
  • an immutable set with all the rules.

public abstract void remove (String uri)

Remove the given uri from the whitelist. If the whitelist does not contain the uri this method should not do anything.

Parameters
uri uri to remove.