com.atlassian.confluence.plugins.gadgets.whitelist
Interface ConfluenceGadgetWhitelistManager

All Known Implementing Classes:

ConfluenceURIWhitelist

public interface ConfluenceGadgetWhitelistManager

Method Summary

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

Method Detail

allows

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.

getAllUserConfiguredRules

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.

add

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.

remove

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.