/hudson-plugin-utils/src/main/java/org/hudsonci/utils/tasks/OperationSupport.java

 1/**
 2 * The MIT License
 3 *
 4 * Copyright (c) 2010-2011 Sonatype, Inc. All rights reserved.
 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 */
24
25package org.hudsonci.utils.tasks;
26
27import hudson.model.AbstractBuild;
28import hudson.model.BuildListener;
29import hudson.tasks.BuildStep;
30import org.slf4j.Logger;
31import org.slf4j.LoggerFactory;
32import org.sonatype.gossip.support.MuxLoggerFactory;
33
34import static com.google.common.base.Preconditions.checkNotNull;
35
36/**
37 * Support for {@link hudson.tasks.BuildStep} operations.
38 *
39 * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
40 * @since 2.1.0
41 */
42public abstract class OperationSupport<T extends BuildStep>
43{
44    /**
45     * Server-side logger.
46     */
47    protected final Logger log = LoggerFactory.getLogger(getClass());
48
49    protected final T owner;
50
51    protected final AbstractBuild<?,?> build;
52
53    protected final BuildListener listener;
54
55    /**
56     * Build console logger.
57     */
58    protected final TaskListenerLogger logger;
59
60    /**
61     * Muxed server+build console logger.
62     */
63    protected final Logger muxlog;
64
65    public OperationSupport(final T owner, final AbstractBuild<?,?> build, final BuildListener listener) {
66        this.owner = checkNotNull(owner);
67        this.build = checkNotNull(build);
68        this.listener = checkNotNull(listener);
69        this.logger = new TaskListenerLogger(listener);
70        this.muxlog = MuxLoggerFactory.create(log, logger);
71    }
72
73    protected abstract boolean doExecute() throws Exception;
74
75    protected void onFailure(final Throwable cause) {
76        logger.error("Failure: {}", cause.toString());
77        log.trace("Failure details", cause);
78    }
79}