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

long	expireAllBuilds() Deprecated. since 5.8 use triggerBuildExpiry()
long	expirePlan(BuildExpiryConfig config, Plan plan, ResultsSummary lastResultsSummary) Deprecated. since 5.8 use triggerBuildExpiry()
Date	getLastRunDate() Deprecated. since 5.7 use getStatus()
ExpiryStatus	getStatus()
boolean	isBuildExpiryRunning() Deprecated. since 5.7 use getStatus()
Future<Long>	triggerBuildExpiry() Triggers build expiry process, which loops through all plans and expires their builds.

Method Detail

expireAllBuilds

@Deprecated
long expireAllBuilds()

Deprecated. since 5.8 use triggerBuildExpiry()

Loops through all plans and expires their builds. Build expiry 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

triggerBuildExpiry

@NotNull
Future<Long> triggerBuildExpiry()

Triggers build expiry process, which loops through all plans and expires their builds. Build expiry is guaranteed to only run one at a time. Any request to this method when already running will be ignored and will return the future object containing result of the already running process.

Returns:

a future reference for number of build results affected by the expiry process

expirePlan

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

Deprecated. since 5.8 use triggerBuildExpiry()

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

@Deprecated
boolean isBuildExpiryRunning()

Deprecated. since 5.7 use getStatus()

Returns true if a build expiry process is currently running.

Returns:

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

getLastRunDate

@Nullable
@Deprecated
Date getLastRunDate()

Deprecated. since 5.7 use getStatus()

Returns:

date of last expiry date or null if never run

getStatus

@NotNull
ExpiryStatus getStatus()