JENKINS-9669 - duplicate AsyncPeriodicWork and reduce log level from …

…INFO to FINEST git-svn-id: https://svn.jenkins-ci.org/trunk/hudson/plugins/thinBackup@39505 71c3de6d-444a-0410-be80-ed276b4c234a
jenkinsci · May 25, 2011 · bbcf283 · bbcf283
1 parent 267a2f0
commit bbcf283
Show file tree

Hide file tree

Showing 3 changed files with 104 additions and 2 deletions.
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
     <groupId>org.jvnet.hudson.plugins</groupId>
     <artifactId>plugin</artifactId>
     <version>1.395</version><!-- which version of Hudson is this plugin built against? -->
-    <relativePath>../pom.xml</relativePath>
+    <relativePath></relativePath>
   </parent>
   <groupId>org.jvnet.hudson.plugins</groupId>
   <artifactId>thinBackup</artifactId>

diff --git a/src/main/java/org/jvnet/hudson/plugins/thinbackup/ThinBackupPeriodicWork.java b/src/main/java/org/jvnet/hudson/plugins/thinbackup/ThinBackupPeriodicWork.java
@@ -17,7 +17,6 @@
 package org.jvnet.hudson.plugins.thinbackup;
 
 import hudson.Extension;
-import hudson.model.AsyncPeriodicWork;
 import hudson.model.TaskListener;
 import hudson.model.Hudson;
 import hudson.scheduler.CronTab;
@@ -33,6 +32,7 @@
 
 import org.apache.commons.lang.StringUtils;
 import org.jvnet.hudson.plugins.thinbackup.backup.HudsonBackup;
+import org.jvnet.hudson.plugins.thinbackup.hudson.model.AsyncPeriodicWork;
 import org.jvnet.hudson.plugins.thinbackup.utils.Utils;
 
 import antlr.ANTLRException;

diff --git a/src/main/java/org/jvnet/hudson/plugins/thinbackup/hudson/model/AsyncPeriodicWork.java b/src/main/java/org/jvnet/hudson/plugins/thinbackup/hudson/model/AsyncPeriodicWork.java
@@ -0,0 +1,102 @@
+package org.jvnet.hudson.plugins.thinbackup.hudson.model;
+
+import hudson.model.PeriodicWork;
+import hudson.model.TaskListener;
+import hudson.model.Hudson;
+import hudson.security.ACL;
+import hudson.util.StreamTaskListener;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.logging.Level;
+
+import org.acegisecurity.context.SecurityContextHolder;
+
+/**
+ * duplicated because the log levels in {@link #doRun()} are reduced from INFO to FINEST to not spam the logs every
+ * minute.
+ * 
+ * {@link PeriodicWork} that takes a long time to run.
+ * 
+ * <p>
+ * Subclasses will implement the {@link #execute(TaskListener)} method and can carry out a long-running task. This runs
+ * in a separate thread so as not to block the timer thread, and this class handles all those details.
+ * 
+ * @author Kohsuke Kawaguchi
+ */
+public abstract class AsyncPeriodicWork extends PeriodicWork {
+  /**
+   * Name of the work.
+   */
+  public final String name;
+
+  private Thread thread;
+
+  protected AsyncPeriodicWork(String name) {
+    this.name = name;
+  }
+
+  /**
+   * Schedules this periodic work now in a new thread, if one isn't already running.
+   */
+  @Override
+  public final void doRun() {
+    try {
+      if (thread != null && thread.isAlive()) {
+        logger.log(Level.WARNING, name + " thread is still running. Execution aborted.");
+        return;
+      }
+      thread = new Thread(new Runnable() {
+        public void run() {
+          logger.log(Level.FINEST, "Started " + name);
+          long startTime = System.currentTimeMillis();
+
+          StreamTaskListener l = createListener();
+          try {
+            SecurityContextHolder.getContext().setAuthentication(ACL.SYSTEM);
+
+            execute(l);
+          } catch (IOException e) {
+            e.printStackTrace(l.fatalError(e.getMessage()));
+          } catch (InterruptedException e) {
+            e.printStackTrace(l.fatalError("aborted"));
+          } finally {
+            l.closeQuietly();
+          }
+
+          logger.log(Level.FINEST, "Finished " + name + ". " + (System.currentTimeMillis() - startTime) + " ms");
+        }
+      }, name + " thread");
+      thread.start();
+    } catch (Throwable t) {
+      logger.log(Level.SEVERE, name + " thread failed with error", t);
+    }
+  }
+
+  protected StreamTaskListener createListener() {
+    try {
+      return new StreamTaskListener(getLogFile());
+    } catch (IOException e) {
+      throw new Error(e);
+    }
+  }
+
+  /**
+   * Determines the log file that records the result of this task.
+   */
+  protected File getLogFile() {
+    return new File(Hudson.getInstance().getRootDir(), name + ".log");
+  }
+
+  /**
+   * Executes the task.
+   * 
+   * @param listener
+   *          Output sent will be reported to the users. (this work is TBD.)
+   * @throws InterruptedException
+   *           The caller will record the exception and moves on.
+   * @throws IOException
+   *           The caller will record the exception and moves on.
+   */
+  protected abstract void execute(TaskListener listener) throws IOException, InterruptedException;
+}