Package 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("workspaceCleanup") public class WorkspaceCleanupThread extends AsyncPeriodicWork
Clean up old left-over workspaces from agents.
Author:
Kohsuke Kawaguchi

  • Field Details

    • 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 Details

    • WorkspaceCleanupThread

      public WorkspaceCleanupThread()

  • Method Details

    • 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.