io.jenkins.tools.warpackager.mavenplugin

Class BuildMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.jenkins.tools.warpackager.mavenplugin.BuildMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

PackageMojo

@Mojo(name="build",
      defaultPhase=PACKAGE,
      requiresProject=false)
public class BuildMojo
extends org.apache.maven.plugin.AbstractMojo

Mojo wrapper for Builder.

Since:

TODO

Author:

Oleg Nenashev

Field Summary

Fields

Modifier and Type	Field and Description
boolean	batchMode Enforces Batch mode for underlying Maven commands and sets appropriate flags.
String	bom Optional BOM file, which can be used as an input source.
String	configFilePath Path to the YAML configuration file.
String	environment Environment, for which the WAR is being generated.
boolean	installArtifacts If true, Custom WAR packager will automatically install the generated artifacts.
String	mvnSettingsFile Optional path to the Maven settings file to be used during the build.
String	tmpDir Temporary directory, which will be used to build subcomponents and to generate outputs.
String	warVersion Version of the WAR file to be set.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
BuildMojo()

Method Summary

Modifier and Type	Method and Description
protected void	build(Config cfg, File buildDir)
void	execute()
protected Config	getConfigOrFail()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFilePath

@Parameter(property="configFile",
           required=true)
 @CheckForNull
public String configFilePath

Path to the YAML configuration file. See the format specification in the Custom WAR Packager documentation on GitHub.

warVersion

@Parameter(property="version",
           defaultValue="1.0-SNAPSHOT")
 @CheckForNull
public String warVersion

Version of the WAR file to be set.

tmpDir

@Parameter(property="tmpDir",
           defaultValue="tmp")
 @CheckForNull
public String tmpDir

Temporary directory, which will be used to build subcomponents and to generate outputs.

mvnSettingsFile

@Parameter(property="mvnSettingsFile")
 @CheckForNull
public String mvnSettingsFile

Optional path to the Maven settings file to be used during the build.

bom

@Parameter(property="bomFile")
 @CheckForNull
public String bom

Optional BOM file, which can be used as an input source.

environment

@Parameter(property="environment")
 @CheckForNull
public String environment

Environment, for which the WAR is being generated. If BOM file is defined, Custom WAR packager will use this environment setting to filter components and plugins.

batchMode

@Parameter(property="batchMode")
public boolean batchMode

Enforces Batch mode for underlying Maven commands and sets appropriate flags. It is recommended to use mvnSettingsFile instead to set values.

installArtifacts

@Parameter(property="installArtifacts")
public boolean installArtifacts

If true, Custom WAR packager will automatically install the generated artifacts.

Constructor Detail

BuildMojo

public BuildMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

build

protected void build(@Nonnull
                     Config cfg,
                     @Nonnull
                     File buildDir)
              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getConfigOrFail

protected Config getConfigOrFail()
                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException