Package com.atlassian.jira.bc.whitelist

Interface InternalWhitelistManager

All Known Implementing Classes:
DefaultWhitelistManager
@Internal public interface InternalWhitelistManager
Since:
6.1

  • Method Summary

    Modifier and Type
    Method
    Description
    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()
     
    List<String>
    updateRules(List<String> rules, boolean disabled)
    Used to update the whitelist configuration.

  • Method Details

    • getRules

      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

    • updateRules

      List<String> updateRules(List<String> rules, 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:
      rules - List of rules to persist
      disabled - True if the whitelist should be switched off
      Returns:
      A list of persisted rules

    • isAllowed

      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

    • isDisabled

      boolean isDisabled()
      Returns:
      true if the whitelist is currently disabled (meaning all requests are allowed)