/hudson-core/src/main/java/hudson/model/OneOffExecutor.java

 1/*
 2 * The MIT License
 3 *
 4 * Copyright (c) 2004-2009, Sun Microsystems, Inc.
 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.model;
25
26import hudson.model.Queue.FlyweightTask;
27import hudson.model.queue.WorkUnit;
28
29/**
30 * {@link Executor} that's temporarily added to carry out tasks that doesn't consume
31 * regular executors, like a matrix project parent build.
32 *
33 * @author Kohsuke Kawaguchi
34 * @see FlyweightTask
35 */
36public class OneOffExecutor extends Executor {
37    private WorkUnit work;
38
39    public OneOffExecutor(Computer owner, WorkUnit work) {
40        super(owner,-1);
41        this.work = work;
42    }
43
44    public WorkUnit getWorkUnit() {
45        return work;
46    }
47
48    @Override
49    protected boolean shouldRun() {
50        // TODO: consulting super.shouldRun() here means we'll lose the work if it gets scheduled
51        // when super.shouldRun() returns false.
52        return super.shouldRun() && work !=null;
53    }
54
55
56    @Override
57    protected WorkUnit grabJob() throws InterruptedException {
58        WorkUnit r = super.grabJob();
59        assert r==work;
60        work = null;
61        return r;
62    }
63
64    @Override
65    public void run() {
66        try {
67            super.run();
68        } finally {
69            owner.remove(this);
70        }
71    }
72}