public class

DefaultWhitelistService

extends Object
implements WhitelistService
java.lang.Object
   ↳ com.atlassian.jira.bc.whitelist.DefaultWhitelistService

Summary

Public Constructors
DefaultWhitelistService(PermissionManager permissionManager, WhitelistManager whitelistManager, I18nHelper.BeanFactory beanFactory)
Public Methods
WhitelistService.WhitelistResult getRules(JiraServiceContext context)
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).
WhitelistService.WhitelistResult updateRules(WhitelistService.WhitelistUpdateValidationResult result)
Takes the validation result from validateUpdateRules(com.atlassian.jira.bc.JiraServiceContext, java.util.List, boolean) and persists the new rules.
WhitelistService.WhitelistUpdateValidationResult validateUpdateRules(JiraServiceContext context, List<String> rules, boolean disabled)
Validates that the current user is allowed to update the whitelist by checking if they are a system administrator.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.bc.whitelist.WhitelistService

Public Constructors

public DefaultWhitelistService (PermissionManager permissionManager, WhitelistManager whitelistManager, I18nHelper.BeanFactory beanFactory)

Public Methods

public WhitelistService.WhitelistResult getRules (JiraServiceContext context)

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.*\/

Parameters
context The service context with the current user & error collection
Returns
  • Result containing the list of rules or an error message

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 WhitelistService.WhitelistResult updateRules (WhitelistService.WhitelistUpdateValidationResult result)

Takes the validation result from validateUpdateRules(com.atlassian.jira.bc.JiraServiceContext, java.util.List, boolean) and persists the new rules.

Parameters
result a validation result obtained by calling validateUpdateRules(com.atlassian.jira.bc.JiraServiceContext, java.util.List, boolean)
Returns
  • Result containing the newly peristed whitelist

public WhitelistService.WhitelistUpdateValidationResult validateUpdateRules (JiraServiceContext context, List<String> rules, boolean disabled)

Validates that the current user is allowed to update the whitelist by checking if they are a system administrator.

Parameters
context The service context with the current user & error collection
rules List of rule strings
disabled true if the whitelist should be turned off
Returns
  • A validation result that can be used to persist the new whitelist rules.