jenkins.plugins.purgejobhistory

Class PurgeJobHistoryAction

java.lang.Object

jenkins.plugins.purgejobhistory.PurgeJobHistoryAction

All Implemented Interfaces:

Action, ModelObject

public class PurgeJobHistoryAction
extends Object
implements Action

An Action to allow the user to purge the job history.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PurgeJobHistoryAction.ActionInjector Add the action to every job.

Constructor Summary

Constructors

Constructor and Description
PurgeJobHistoryAction(Job<?,?> job) Constructor.

Method Summary

Modifier and Type	Method and Description
org.kohsuke.stapler.HttpResponse	doDoPurge(boolean resetNextBuild, boolean forceDelete) Does the actual purging when triggered via the UI.
String	getDisplayName()
String	getIconFileName()
Job<?,?>	getJob() Gets the job we are attached to.
String	getUrlName()

Methods inherited from class java.lang.Object

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

Constructor Detail

PurgeJobHistoryAction

public PurgeJobHistoryAction(Job<?,?> job)

Constructor.

Parameters:

job - the job we are an action for,

Method Detail

getJob

public Job<?,?> getJob()

Gets the job we are attached to.

Returns:

the job we are attached to.

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

doDoPurge

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public org.kohsuke.stapler.HttpResponse doDoPurge(@QueryParameter(value="resetNextBuild")
                                                                                                                         boolean resetNextBuild,
                                                                                                                         @QueryParameter(value="forceDelete")
                                                                                                                         boolean forceDelete)
                                                                                                                  throws IOException

Does the actual purging when triggered via the UI.

Parameters:

resetNextBuild - the reset flag.

forceDelete - force deleting even runs that have been flagged for retention.

Returns:

the response.

Throws:

IOException - if something goes wrong.