com.atlassian.bamboo.plugins.rest.admin.globalvariable

Class GlobalVariableResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.admin.globalvariable.GlobalVariableResource

public class GlobalVariableResource
extends Object

REST endpoint to manage bamboo global variables

Since:

5.9

Field Summary

Fields

Modifier and Type	Field and Description
static RestGlobalVariable	REST_GLOBAL_VARIABLE

Constructor Summary

Constructors

Constructor and Description
GlobalVariableResource(RestGlobalVariableService restGlobalVariableService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createGlobalVariable(javax.ws.rs.core.UriInfo uriInfo, RestGlobalVariable restGlobalVariable) Create a single global variable.
javax.ws.rs.core.Response	deleteGlobalVariable(javax.ws.rs.core.UriInfo uriInfo, long variableId) Delete a global variable
RestGlobalVariable	getGlobalVariable(javax.ws.rs.core.UriInfo uriInfo, long variableId) Retrieve a global variable definition.
RestGlobalVariables	getGlobalVariables(javax.ws.rs.core.UriInfo uriInfo) Return collection of all global variables.
RestGlobalVariable	updateGlobalVariable(javax.ws.rs.core.UriInfo uriInfo, long variableId, RestGlobalVariable restGlobalVariable) Update value of a global variable
javax.ws.rs.core.Response	verifyGlobalVariableValue(RestVerificationRequest request) Verify if variable value was changed or not.

Methods inherited from class java.lang.Object

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

Field Detail

REST_GLOBAL_VARIABLE

public static final RestGlobalVariable REST_GLOBAL_VARIABLE

Constructor Detail

GlobalVariableResource

public GlobalVariableResource(RestGlobalVariableService restGlobalVariableService)

Method Detail

getGlobalVariables

public RestGlobalVariables getGlobalVariables(@Context
                                              javax.ws.rs.core.UriInfo uriInfo)

Return collection of all global variables. Value of variables that contain password in name will be encrypted with salted hash.

Parameters:

uriInfo - Provides access to request URI information

Returns:

Collection of all global variables

getGlobalVariable

public RestGlobalVariable getGlobalVariable(@Context
                                            javax.ws.rs.core.UriInfo uriInfo,
                                            long variableId)

Retrieve a global variable definition. Value will be encrypted if variable name contains key word password

Parameters:

uriInfo - Object that provides access to information of http request to the REST endpoint

variableId - Id of the variable

Returns:

Variable definition which contains name, value and link to the variable

createGlobalVariable

public javax.ws.rs.core.Response createGlobalVariable(@Context
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      RestGlobalVariable restGlobalVariable)
                                               throws WebValidationException

Create a single global variable.

Parameters:

uriInfo - Object that provides access to information of http request to the REST endpoint

restGlobalVariable - The variable to be created

Returns:

Variable that is created

Throws:

WebValidationException

deleteGlobalVariable

public javax.ws.rs.core.Response deleteGlobalVariable(@Context
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      long variableId)
                                               throws WebValidationException

Delete a global variable

Parameters:

uriInfo - Object that provides access to information of http request

variableId - Id of the variable to be deleted

Returns:

Response with status code 204, no content.

Throws:

WebValidationException

updateGlobalVariable

public RestGlobalVariable updateGlobalVariable(@Context
                                               javax.ws.rs.core.UriInfo uriInfo,
                                               long variableId,
                                               RestGlobalVariable restGlobalVariable)
                                        throws WebValidationException

Update value of a global variable

Parameters:

uriInfo - Object that provides access to information of http request

variableId - Id of the variable

restGlobalVariable - RestGlobalVariable that contains new value

Returns:

The updated variable

Throws:

WebValidationException

verifyGlobalVariableValue

public javax.ws.rs.core.Response verifyGlobalVariableValue(RestVerificationRequest request)

Verify if variable value was changed or not.

Parameters:

request - defines variable and and raw unencoded value to be checked against the server storage.