hudson.model

Class WorkspaceCleanupThread

java.lang.Object

java.util.TimerTask

hudson.triggers.SafeTimerTask

hudson.model.PeriodicWork

hudson.model.AsyncPeriodicWork

hudson.model.WorkspaceCleanupThread

All Implemented Interfaces:

ExtensionPoint, Runnable

@Extension
 @Symbol(value="workspaceCleanup")
public class WorkspaceCleanupThread
extends AsyncPeriodicWork

Clean up old left-over workspaces from agents.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class hudson.triggers.SafeTimerTask

SafeTimerTask.ExceptionRunnable

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	disabled Can be used to disable workspace clean up.
static int	recurrencePeriodHours How often the clean up should run.
static int	retainForDays Number of days workspaces should be retained.

Fields inherited from class hudson.model.AsyncPeriodicWork

name

Fields inherited from class hudson.model.PeriodicWork

DAY, HOUR, logger, MIN

Constructor Summary

Constructors

Constructor and Description
WorkspaceCleanupThread()

Method Summary

Modifier and Type	Method and Description
protected void	execute(TaskListener listener) Executes the task.
long	getRecurrencePeriod() Gets the number of milliseconds between successive executions.
static void	invoke()

Methods inherited from class hudson.model.AsyncPeriodicWork

createListener, doRun, getErrorLoggingLevel, getLogFile, getNormalLoggingLevel, getSlowLoggingLevel

Methods inherited from class hudson.model.PeriodicWork

all, getInitialDelay, init

Methods inherited from class hudson.triggers.SafeTimerTask

getLogsRoot, of, run

Methods inherited from class java.util.TimerTask

cancel, scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Field Detail

disabled

public static boolean disabled

Can be used to disable workspace clean up.

recurrencePeriodHours

public static final int recurrencePeriodHours

How often the clean up should run. This is final as Jenkins will not reflect changes anyway.

retainForDays

public static int retainForDays

Number of days workspaces should be retained.

Constructor Detail

WorkspaceCleanupThread

public WorkspaceCleanupThread()

Method Detail

getRecurrencePeriod

public long getRecurrencePeriod()

Description copied from class: PeriodicWork

Gets the number of milliseconds between successive executions.

Hudson calls this method once to set up a recurring timer, instead of calling this each time after the previous execution completed. So this class cannot be used to implement a non-regular recurring timer.

IOW, the method should always return the same value.

Specified by:

getRecurrencePeriod in class PeriodicWork

invoke

public static void invoke()

execute

protected void execute(TaskListener listener)
                throws InterruptedException,
                       IOException

Description copied from class: AsyncPeriodicWork

Executes the task.

Specified by:

execute in class AsyncPeriodicWork

Parameters:

listener - Output sent will be reported to the users. (this work is TBD.)

Throws:

InterruptedException - The caller will record the exception and moves on.

IOException - The caller will record the exception and moves on.