Package jenkins.model

Class BuildDiscarder

java.lang.Object

jenkins.model.BuildDiscarder

All Implemented Interfaces:

ExtensionPoint, Describable<BuildDiscarder>

Direct Known Subclasses:

LogRotator

public abstract class BuildDiscarder
extends Object
implements Describable<BuildDiscarder>, ExtensionPoint

Implementation of "Discard old build records" feature.

This extension point allows plugins to implement a different strategy to decide what builds to discard and what builds to keep.

Since:

1.503

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BuildDiscarder.ConverterImpl	Job.logRotator used to be typed as LogRotator, so such configuration file ends up trying to unmarshal BuildDiscarder and not its subtype.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
BuildDiscarder()

Method Summary

Modifier and Type	Method	Description
BuildDiscarderDescriptor	getDescriptor()	Gets the descriptor for this instance.
abstract void	perform(Job<?,?> job)	Called to perform "garbage collection" on the job to discard old build records.

Methods inherited from class java.lang.Object

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

Constructor Details

BuildDiscarder

public BuildDiscarder()

Method Details

perform

public abstract void perform(Job<?,?> job)
                      throws IOException,
InterruptedException

Called to perform "garbage collection" on the job to discard old build records.

Normally invoked automatically jobs when new builds occur. The general expectation is that those marked as Run.isKeepLog() will be kept untouched. To delete the build record, call Run.delete().

Throws:

IOException

InterruptedException

See Also:

• Job.logRotate()

getDescriptor

public BuildDiscarderDescriptor getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

Specified by:

getDescriptor in interface Describable<BuildDiscarder>