com.atlassian.bamboo.plugins.rest.admin.configuration

Class GeneralConfigurationResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.admin.configuration.GeneralConfigurationResource

public class GeneralConfigurationResource
extends Object

REST resource for accessing/updating bamboo general configurations.

Since:

5.9

Constructor Summary

Constructors

Constructor and Description
GeneralConfigurationResource(GeneralConfigurationService generalConfigurationService, GeneralConfigurationConversionFunction function)

Method Summary

Modifier and Type	Method and Description
RestGeneralConfiguration	getGeneralConfiguration(Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) The REST endpoint to retrieve bamboo server general configurations
RestGeneralConfiguration	updateGeneralConfiguration(RestGeneralConfiguration restGeneralConfiguration, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) The REST endpoint to update bamboo server general configurations.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralConfigurationResource

public GeneralConfigurationResource(GeneralConfigurationService generalConfigurationService,
                                    GeneralConfigurationConversionFunction function)

Method Detail

getGeneralConfiguration

public RestGeneralConfiguration getGeneralConfiguration(@NotNull @Context
                                                        Expansion expansion,
                                                        @NotNull @Context
                                                        javax.ws.rs.core.UriInfo uriInfo)
                                                 throws URISyntaxException,
                                                        InternalError

The REST endpoint to retrieve bamboo server general configurations

Returns:

RestGeneralConfiguration

Throws:

URISyntaxException

InternalError

updateGeneralConfiguration

public RestGeneralConfiguration updateGeneralConfiguration(RestGeneralConfiguration restGeneralConfiguration,
                                                           @Nullable @Context
                                                           Expansion expansion,
                                                           @NotNull @Context
                                                           javax.ws.rs.core.UriInfo uriInfo)
                                                    throws WebValidationException,
                                                           UnauthorisedException

The REST endpoint to update bamboo server general configurations.

Parameters:

restGeneralConfiguration - Configuration to be updated. Partially update supported.

Returns:

Status of the update operation.

Throws:

WebValidationException - if there's validation errors, which maps into a 400 Bad Request

UnauthorisedException