com.sonyericsson.hudson.plugins.gerrit.trigger.hudsontrigger.GerritCause Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gerrit-trigger Show documentation
Integrates Hudson to Gerrit code review.
The newest version!
/*
 *  The MIT License
 *
 *  Copyright 2010 Sony Ericsson Mobile Communications. All rights reserved.
 *
 *  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 com.sonyericsson.hudson.plugins.gerrit.trigger.hudsontrigger;

import com.sonyericsson.hudson.plugins.gerrit.trigger.Messages;
import com.sonyericsson.hudson.plugins.gerrit.trigger.PluginImpl;
import com.sonyericsson.hudson.plugins.gerrit.gerritevents.dto.events.PatchsetCreated;
import com.sonyericsson.hudson.plugins.gerrit.trigger.hudsontrigger.data.TriggerContext;
import hudson.model.Cause;

/**
 * A Cause why a build was scheduled.
 * @author Robert Sandell <[email protected]>
 */
public class GerritCause extends Cause {

    private PatchsetCreated event;
    private boolean silentMode;
    private TriggerContext context;

    /**
     * Default DataBound Constructor.
     * @param event the event that triggered the build.
     * @param silentMode Silent Mode on or off.
     */
    public GerritCause(PatchsetCreated event, boolean silentMode) {
        this.event = event;
        this.silentMode = silentMode;
        this.context = new TriggerContext(event);
    }

    /**
     * Default DataBound Constructor.
     * @param event the event that triggered the build.
     * @param silentMode Silent Mode on or off.
     * @param context The context with information about other builds triggered for the same event as this one.
     */
    public GerritCause(PatchsetCreated event, boolean silentMode, TriggerContext context) {
        this.event = event;
        this.silentMode = silentMode;
        this.context = context;
    }

    /**
     * Default Constructor.
     */
    public GerritCause() {
    }

    /**
     * The event.
     * @return the event.
     */
    public PatchsetCreated getEvent() {
        return event;
    }

    /**
     * The event.
     * @param event the event.
     */
    public void setEvent(PatchsetCreated event) {
        this.event = event;
    }

    /**
     * Gets the indication if silent mode was on or off when the build was triggered.
     * When silent mode is on there will be no communication back to Gerrit,
     * i.e. no build started/failed/sucessfull approve messages etc.
     * Default is false.
     * @return true if silent mode was on.
     * @see GerritTrigger#isSilentMode()
     */
    public boolean isSilentMode() {
        return silentMode;
    }

    /**
     * Sets the indication if silent mode was on or off when the build was triggered.
     * When silent mode is on there will be no communication back to Gerrit,
     * i.e. no build started/failed/sucessfull approve messages etc.
     * Default is false.
     * @param silentMode true if silent mode was on.
     * @see GerritTrigger#setSilentMode(boolean)
     */
    public void setSilentMode(boolean silentMode) {
        this.silentMode = silentMode;
    }

    /**
     * The context with information about other builds triggered for the same event as this one.
     * @return the context.
     */
    public TriggerContext getContext() {
        return context;
    }

    /**
     * The context with information about other builds triggered for the same event as this one.
     * @param context the context.
     */
    public void setContext(TriggerContext context) {
        this.context = context;
    }

    /**
     * Gives the short description of the GerritCause.
     * Intended to be overridden by subclasses.
     * @return the short description.
     * @see #getShortGerritDescriptionSilentMode()
     * @see #getShortDescription()
     */
    protected String getShortGerritDescription() {
        return Messages.TriggeredShortDescription(getUrl());
    }

    /**
     * Gives the short description of the GerritCause in silent mode.
     * Intended to be overridden by subclasses.
     * @return the short description for silent mode.
     * @see #getShortGerritDescription()
     * @see #getShortDescription()
     */
    protected String getShortGerritDescriptionSilentMode() {
        return Messages.TriggeredShortDescriptionInSilentMode(getUrl());
    }

    @Override
    public String getShortDescription() {
        if (isSilentMode()) {
            return getShortGerritDescriptionSilentMode();
        } else {
            return getShortGerritDescription();
        }
    }

    /**
     * Gets the URL to the Gerrit patchSet.
     * @return the url.
     */
    public String getUrl() {
        return PluginImpl.getInstance().getConfig().getGerritFrontEndUrlFor(
                event.getChange().getNumber(),
                event.getPatchSet().getNumber());
    }

    @Override
    public String toString() {
        return "GerritCause: " + event + " silent: " + silentMode;
    }
}