Package com.atlassian.jira.rest.v2.admin

Class ApplicationPropertiesResource

java.lang.Object

com.atlassian.jira.rest.v2.admin.ApplicationPropertiesResource

@Path("application-properties")
@Produces("application/json")
public class ApplicationPropertiesResource
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApplicationPropertiesResource.Property

Constructor Summary

Constructors

Constructor	Description
ApplicationPropertiesResource(JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, ApplicationPropertiesService applicationPropertiesService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getAdvancedSettings()	Returns the properties that are displayed on the "General Configuration > Advanced Settings" page.
javax.ws.rs.core.Response	getProperty(String key, String permissionLevel, String keyFilter)	Returns an application property.
javax.ws.rs.core.Response	setProperty(String key, String value)
javax.ws.rs.core.Response	setPropertyViaRestfulTable(String key, ApplicationPropertyBean applicationPropertyBean)	Modify an application property via PUT.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ApplicationPropertiesResource

@Inject
public ApplicationPropertiesResource(JiraAuthenticationContext authenticationContext,
 PermissionManager permissionManager,
 ApplicationPropertiesService applicationPropertiesService)

Method Details

getProperty

@GET
public javax.ws.rs.core.Response getProperty(@QueryParam("key")
 String key,
 @QueryParam("permissionLevel")
 String permissionLevel,
 @QueryParam("keyFilter")
 String keyFilter)

Returns an application property.

Parameters:

key - a String containing the property key

permissionLevel - when fetching a list specifies the permission level of all items in the list see ApplicationPropertiesService.EditPermissionLevel

keyFilter - when fetching a list allows the list to be filtered by the property's start of key e.g. "jira.lf.*" whould fetch only those permissions that are editable and whose keys start with "jira.lf.". This is a regex.

Returns:

an application property.

getAdvancedSettings

@Path("advanced-settings")
@GET
public javax.ws.rs.core.Response getAdvancedSettings()

Returns the properties that are displayed on the "General Configuration > Advanced Settings" page.

setPropertyViaRestfulTable

@PUT
@Path("{id}")
public javax.ws.rs.core.Response setPropertyViaRestfulTable(@PathParam("id")
 String key,
 ApplicationPropertyBean applicationPropertyBean)

Modify an application property via PUT. The "value" field present in the PUT will override the existing value.

setProperty

public javax.ws.rs.core.Response setProperty(String key,
 String value)