public interface

ApplicationPropertiesService

com.atlassian.jira.bc.admin.ApplicationPropertiesService
Known Indirect Subclasses

Class Overview

Service level implementation of CRUD for ApplicationProperties which are administrative level configuration settings that boil down to a key and a value. In addition to key and value are other metadata properties as modelled by ApplicationPropertyMetadata including default value, type and i18n keys etc.

Summary

Nested Classes
enum ApplicationPropertiesService.EditPermissionLevel  
Public Methods
ApplicationProperty getApplicationProperty(String key)
Retrieves a property with the given key.
List<ApplicationProperty> getEditableApplicationProperties(String permissionLevel, String keyFilter)
Retrieves all properties that can be edited dynamically by the user.
List<ApplicationProperty> getEditableApplicationProperties(ApplicationPropertiesService.EditPermissionLevel permissionLevel, String keyFilter)
Retrieves all properties that can be edited dynamically by the user.
boolean hasPermissionForLevel(String permissionLevel)
Checks if the user has the permission to fetch values at the permissionLevel requested.
Validated<ApplicationProperty> setApplicationProperty(String key, String value)
Stores the given value for the given key in the underlying data store.

Public Methods

public ApplicationProperty getApplicationProperty (String key)

Retrieves a property with the given key.

Parameters
key the property's key.
Returns
  • the property or null if there is no property with that key.
Throws
DataAccessException if there is a problem with the backing store.

public List<ApplicationProperty> getEditableApplicationProperties (String permissionLevel, String keyFilter)

Retrieves all properties that can be edited dynamically by the user.

Parameters
permissionLevel the level EditPermissionLevel as a string the all returned values should contain
keyFilter may be null. Filter the list of properties by which keys start with keyFilter
Returns
  • the properties.
Throws
DataAccessException if there is a problem with the backing store.

public List<ApplicationProperty> getEditableApplicationProperties (ApplicationPropertiesService.EditPermissionLevel permissionLevel, String keyFilter)

Retrieves all properties that can be edited dynamically by the user.

Parameters
permissionLevel the level EditPermissionLevel as a string the all returned values should contain
keyFilter may be null. Filter the list of properties by which keys start with keyFilter
Returns
  • the properties.
Throws
DataAccessException if there is a problem with the backing store.

public boolean hasPermissionForLevel (String permissionLevel)

Checks if the user has the permission to fetch values at the permissionLevel requested.

Returns
  • true if they are allowed the list

public Validated<ApplicationProperty> setApplicationProperty (String key, String value)

Stores the given value for the given key in the underlying data store.

Parameters
key the key.
value the string representation of the value.
Returns
  • the property in full that corresponds to the new state of the property.
Throws
DataAccessException if the key cannot be stored due to a problem with the backing store.