/hudson-core/src/main/java/hudson/triggers/SafeTimerTask.java

 1/*
 2 * The MIT License
 3 * 
 4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
 5 * 
 6 * Permission is hereby granted, free of charge, to any person obtaining a copy
 7 * of this software and associated documentation files (the "Software"), to deal
 8 * in the Software without restriction, including without limitation the rights
 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 * 
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 * 
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24package hudson.triggers;
25
26import org.acegisecurity.context.SecurityContextHolder;
27
28import java.util.Timer;
29import java.util.TimerTask;
30import java.util.logging.Logger;
31import java.util.logging.Level;
32
33import hudson.security.ACL;
34
35/**
36 * {@link Timer} wrapper so that a fatal error in {@link TimerTask}
37 * won't terminate the timer.
38 *
39 * <p>
40 * {@link Trigger#timer} is a shared timer instance that can be used inside Hudson to
41 * schedule a recurring work.
42 *
43 * @author Kohsuke Kawaguchi
44 * @since 1.124
45 * @see Trigger#timer
46 */
47public abstract class SafeTimerTask extends TimerTask {
48    public final void run() {
49        // background activity gets system credential,
50        // just like executors get it.
51        SecurityContextHolder.getContext().setAuthentication(ACL.SYSTEM);
52
53        try {
54            doRun();
55        } catch(Throwable t) {
56            LOGGER.log(Level.SEVERE, "Timer task "+this+" failed",t);
57        } finally {
58            SecurityContextHolder.clearContext();
59        }
60    }
61
62    protected abstract void doRun() throws Exception;
63
64    private static final Logger LOGGER = Logger.getLogger(SafeTimerTask.class.getName());
65}