hudson.maven.MavenArgumentInterceptorAction Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright (c) 2011, Dominik Bartholdi
*
* 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 hudson.maven;
import hudson.model.Action;
import hudson.util.ArgumentListBuilder;
/**
* Provides a hook to change the arguments passed to the maven execution. This
* enables plugins to transiently change the arguments of a maven build (e.g.
* change the arguments for a release build).
*
* @author Dominik Bartholdi (imod)
*
*/
public interface MavenArgumentInterceptorAction extends Action {
/**
* Provides maven goals and options to start the build with. This is the
* preferred way to provide other goals then the default ones to a build.
* The goals and options returned by this method will not be persist and do
* not affect the default configuration.
*
* This method will be called on one and only one action during a build. If
* there are two actions present in the build, the second will be ignored.
*
* @param build
* reference to the current build, might be used for some
* calculations for the correct arguments
* @return the maven goals and options to start maven with. Result is
* ignored if null or empty. Variables will be expanded
* by the caller.
*/
public String getGoalsAndOptions(MavenModuleSetBuild build);
/**
* Change/add arguments to any needs, but special care has to be taken, as
* the list contains every argument needed for the default execution (e.g.
* -f /path/to/pom.xml or -B).
* An easy example would be to add "-DskipTests" to skip the
* test execution on request.
*
*
* This method is called on all present MavenArgumentInterceptorAction
* during a build (kind of chaining, each action can add the arguments it
* thinks are missing).
*
* @param mavenargs
* the calculated default maven arguments (never
* null).
* @param build
* reference to the current build, might be used for some
* calculations for the correct arguments
* @return the new arguments to be used.
*/
public ArgumentListBuilder intercept(ArgumentListBuilder mavenargs, MavenModuleSetBuild build);
}