public class

DefaultWhitelistManager

extends Object
implements WhitelistManager
java.lang.Object
   ↳ com.atlassian.jira.bc.whitelist.DefaultWhitelistManager

Class Overview

Default implementation that delegates to the WhitelistManager in jira-gadgets-plugin

Summary

Public Constructors
DefaultWhitelistManager()
Public Methods
List<String> getRules()
Returns a list of rules that are currently allowed in the whitelist.
boolean isAllowed(URI uri)
Checks if requests to the provided URI are allowed according to the current whitelist configuration
boolean isDisabled()
Returns true if the whitelist is currently disabled (meaning all requests are allowed).
List<String> updateRules(List<String> newRules, boolean disabled)
Used to update the whitelist configuration.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.bc.whitelist.WhitelistManager

Public Constructors

public DefaultWhitelistManager ()

Public Methods

public List<String> getRules ()

Returns a list of rules that are currently allowed in the whitelist. The list will contain entries like:

  • http://www.atlassian.com/
  • http://www.google.com/*
  • =http://jira.atlassian.com/
  • \/.*www.*\/

Returns
  • a list of allowed rules

public boolean isAllowed (URI uri)

Checks if requests to the provided URI are allowed according to the current whitelist configuration

Parameters
uri The uri a http request is made to
Returns
  • true if requests are allowed, false otherwise

public boolean isDisabled ()

Returns true if the whitelist is currently disabled (meaning all requests are allowed).

Returns
  • true if the whitelist is currently disabled (meaning all requests are allowed)

public List<String> updateRules (List<String> newRules, boolean disabled)

Used to update the whitelist configuration. Takes a list of rules as well as a boolean flag that allows switching the whitelist off completely.

The method then returns the peristed rules

Parameters
newRules List of rules to persist
disabled True if the whitelist should be switched off
Returns
  • A list of persisted rules