com.atlassian.jira.bc.whitelist
Interface WhitelistService

All Known Implementing Classes:
DefaultWhitelistService

@PublicApi
public interface WhitelistService

Service to control whitelist rules currently used for allowing which http requests gadgets are allowed to make. This can be used in future to whitelist any http requests! Only system administrators should be allowed to modify the whitelist implemenation

Since:
v4.3

Nested Class Summary
static class WhitelistService.WhitelistResult
           
static class WhitelistService.WhitelistUpdateValidationResult
           
 
Method Summary
 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.
 

Method Detail

getRules

WhitelistService.WhitelistResult getRules(JiraServiceContext context)
Returns a list of rules that are currently allowed in the whitelist. The list will contain entries like:

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

validateUpdateRules

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.

updateRules

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

isDisabled

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)

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


Copyright © 2002-2012 Atlassian. All Rights Reserved.