com.atlassian.bamboo.build.expiry
Interface BuildExpiryBean

All Known Implementing Classes:

BuildExpiryBeanImpl

public interface BuildExpiryBean

A bean that manages the build expiry process

Method Summary

int	expireAllBuilds() Loops through all builds and expires their builds.
int	expirePlan(BuildExpiryConfig config, Plan plan, ResultsSummary lastResultsSummary) Expires builds according to the passed BuildExpiryConfig object.
java.util.Date	getLastRunDate()
boolean	isBuildExpiryRunning() Returns true if a build expiry process is currently running.

Method Detail

expireAllBuilds

int expireAllBuilds()

Loops through all builds and expires their builds. This method is guaranteed to only run one at a time. Any request to this method when already running will be ignored

Returns:

integer - number of build results affected by the expiry process

expirePlan

int expirePlan(@NotNull
               BuildExpiryConfig config,
               @NotNull
               Plan plan,
               @NotNull
               ResultsSummary lastResultsSummary)

Expires builds according to the passed BuildExpiryConfig object. All params are required

Parameters:

config - - how should things be expired

plan - - build to expire

lastResultsSummary - - the last build results summary to take all the relative time to

Returns:

integer - number of build results affected

isBuildExpiryRunning

boolean isBuildExpiryRunning()

Returns true if a build expiry process is currently running.

Returns:

boolean - true if the build expiration is currently running, false otherwise

getLastRunDate

@Nullable
java.util.Date getLastRunDate()

Returns:

date of last expiry date or null if never run