Java tutorial
/* * The MIT License * * Copyright (C) 2010-2011 by Anthony Robinson * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ package jenkins.plugins.publish_over; import hudson.FilePath; import hudson.Launcher; import hudson.model.AbstractBuild; import hudson.model.BuildListener; import hudson.model.Hudson; import hudson.model.Result; import hudson.model.TaskListener; import hudson.tasks.BuildStepMonitor; import hudson.tasks.Notifier; import org.apache.commons.lang.builder.EqualsBuilder; import org.apache.commons.lang.builder.HashCodeBuilder; import org.apache.commons.lang.builder.ToStringBuilder; import org.apache.commons.lang.builder.ToStringStyle; import java.io.IOException; import java.io.PrintStream; import java.lang.reflect.Method; import java.util.ArrayList; import java.util.TreeMap; @SuppressWarnings({ "PMD.LooseCoupling", "PMD.TooManyMethods" }) // serializable ... Map ... public abstract class BPPlugin<PUBLISHER extends BapPublisher, CLIENT extends BPClient, COMMON_CONFIG> extends Notifier implements BPHostConfigurationAccess<CLIENT, COMMON_CONFIG> { public static final String PROMOTION_JOB_TYPE = "hudson.plugins.promoted_builds.PromotionProcess"; public static final String PROMOTION_CLASS_NAME = "hudson.plugins.promoted_builds.Promotion"; private final String consolePrefix; private BPInstanceConfig delegate; public BPPlugin(final String consolePrefix, final ArrayList<PUBLISHER> publishers, final boolean continueOnError, final boolean failOnError, final boolean alwaysPublishFromMaster, final String masterNodeName, final ParamPublish paramPublish) { this.delegate = new BPInstanceConfig<PUBLISHER>(publishers, continueOnError, failOnError, alwaysPublishFromMaster, masterNodeName, paramPublish); delegate.setHostConfigurationAccess(this); this.consolePrefix = consolePrefix; } public BPInstanceConfig getInstanceConfig() { return delegate; } public BPInstanceConfig getDelegate() { return delegate; } public void setDelegate(final BPInstanceConfig delegate) { this.delegate = delegate; delegate.setHostConfigurationAccess(this); } public BuildStepMonitor getRequiredMonitorService() { return BuildStepMonitor.NONE; } private TreeMap<String, String> getEnvironmentVariables(final AbstractBuild<?, ?> build, final TaskListener listener) { try { final TreeMap<String, String> env = build.getEnvironment(listener); env.putAll(build.getBuildVariables()); return env; } catch (Exception e) { throw new RuntimeException(Messages.exception_failedToGetEnvVars(), e); } } @Override public boolean perform(final AbstractBuild<?, ?> build, final Launcher launcher, final BuildListener listener) throws InterruptedException, IOException { final PrintStream console = listener.getLogger(); if (!isBuildGoodEnoughToRun(build, console)) return true; final BPBuildEnv currentBuildEnv = new BPBuildEnv(getEnvironmentVariables(build, listener), build.getWorkspace(), build.getTimestamp()); BPBuildEnv targetBuildEnv = null; if (PROMOTION_CLASS_NAME.equals(build.getClass().getCanonicalName())) { AbstractBuild<?, ?> promoted; try { final Method getTarget = build.getClass().getMethod("getTarget", (Class<?>[]) null); promoted = (AbstractBuild) getTarget.invoke(build, (Object[]) null); } catch (Exception e) { throw new RuntimeException(Messages.exception_failedToGetPromotedBuild(), e); } targetBuildEnv = new BPBuildEnv(getEnvironmentVariables(promoted, listener), new FilePath(promoted.getArtifactsDir()), promoted.getTimestamp()); } final BPBuildInfo buildInfo = new BPBuildInfo(listener, consolePrefix, Hudson.getInstance().getRootPath(), currentBuildEnv, targetBuildEnv); fixup(build, buildInfo); final Result result = delegate.perform(buildInfo); if (build.getResult() == null) build.setResult(result); else build.setResult(result.combine(build.getResult())); return result.isBetterOrEqualTo(Result.UNSTABLE); } @SuppressWarnings("PMD.EmptyMethodInAbstractClassShouldBeAbstract") // don't need to provide impl, so not abstract! protected void fixup(final AbstractBuild<?, ?> build, final BPBuildInfo buildInfo) { // provide a hook for the plugin impl to get at other internals - ie Hudson.getInstance is null when remote from a publisher!!!!! // as is Exceutor.currentExecutor, Computer.currentComputer - it's a wilderness out there! } protected boolean isBuildGoodEnoughToRun(final AbstractBuild<?, ?> build, final PrintStream console) { if ((build.getResult() != null) && !build.getResult().isBetterOrEqualTo(Result.UNSTABLE)) { console.println(consolePrefix + Messages.console_notPerforming(build.getResult())); return false; } return true; } protected HashCodeBuilder addToHashCode(final HashCodeBuilder builder) { return builder.append(delegate).append(consolePrefix); } protected EqualsBuilder addToEquals(final EqualsBuilder builder, final BPPlugin that) { return builder.append(delegate, that.delegate).append(consolePrefix, that.consolePrefix); } protected ToStringBuilder addToToString(final ToStringBuilder builder) { return builder.append("consolePrefix", consolePrefix).append("delegate", delegate); } public boolean equals(final Object that) { if (this == that) return true; if (that == null || getClass() != that.getClass()) return false; return addToEquals(new EqualsBuilder(), (BPPlugin) that).isEquals(); } public int hashCode() { return addToHashCode(new HashCodeBuilder()).toHashCode(); } public String toString() { return addToToString(new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)).toString(); } }