com.atlassian.bamboo.plugins.rest.admin.expiry

Class CombinedExpiryResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.admin.expiry.CombinedExpiryResource

@Singleton
public class CombinedExpiryResource
extends Object

REST resource for accessing and modifying global build and deployment expiry configurations combined.

Only available for users with system admin credentials (RestHelper.assertSystemAdminPermission()).

Constructor Summary

Constructors

Constructor and Description
CombinedExpiryResource(AdministrationConfigurationAccessor administrationConfigurationAccessor, AdministrationConfigurationPersister administrationConfigurationPersister, com.atlassian.sal.api.ApplicationProperties applicationProperties, BuildExpiryBean buildExpiryBean, DeploymentExpiryService deploymentExpiryService, ExpiryScheduler expiryScheduler)

Method Summary

Modifier and Type	Method and Description
RestCombinedExpiryConfiguration	getConfiguration() Method used to obtain global build and deployment expiry configuration for this Bamboo instance.
RestCombinedExpiryStatus	getStatus() Retrieves build and deployment expiry status.
javax.ws.rs.core.Response	run() Executes build and deployment expiry process.
RestCombinedExpiryConfiguration	setConfiguration(RestCombinedExpiryConfiguration restConfiguration) Method used to save global build and deployment expiry configuration for this Bamboo instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedExpiryResource

public CombinedExpiryResource(AdministrationConfigurationAccessor administrationConfigurationAccessor,
                              AdministrationConfigurationPersister administrationConfigurationPersister,
                              com.atlassian.sal.api.ApplicationProperties applicationProperties,
                              BuildExpiryBean buildExpiryBean,
                              DeploymentExpiryService deploymentExpiryService,
                              ExpiryScheduler expiryScheduler)

Method Detail

getConfiguration

public RestCombinedExpiryConfiguration getConfiguration()

Method used to obtain global build and deployment expiry configuration for this Bamboo instance.

Returns:

Current expiry configuration (HTTP 200).

setConfiguration

public RestCombinedExpiryConfiguration setConfiguration(@NotNull
                                                        RestCombinedExpiryConfiguration restConfiguration)
                                                 throws WebValidationException

Method used to save global build and deployment expiry configuration for this Bamboo instance.

Parameters:

restConfiguration - An object with full expiry configuration for both build and deployment expiry. Partial configuration is not allowed (it will fail validation).

Returns:

Returns the newly saved expiry configuration (HTTP 200), or list of errors and field errors if the new config is not valid (HTTP 400).

Throws:

WebValidationException

getStatus

public RestCombinedExpiryStatus getStatus()

Retrieves build and deployment expiry status.

Returns:

Status of both build and deployment expiry, containing information whether expiry is currently running and the last expiry execution date (HTTP 200).

run

public javax.ws.rs.core.Response run()

Executes build and deployment expiry process. Will only start each process if it's not currently running.