Class BootstrapMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.scm.plugin.AbstractScmMojo

org.apache.maven.scm.plugin.CheckoutMojo

org.apache.maven.scm.plugin.BootstrapMojo

All Implemented Interfaces:

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

@Mojo(name="bootstrap",
      requiresProject=false)
public class BootstrapMojo
extends CheckoutMojo

Pull the project source from the configured scm and execute the configured goals.

Field Summary

Fields

Modifier and Type	Field	Description
private String	goals	The goals to run on the clean checkout of a project for the bootstrap goal.
private String	goalsDirectory	The subdirectory (under the project directory) in which to run the goals.
private File	mavenHome	The path where your maven is installed.
private String	profiles	A list of profiles to run with the goals.

Fields inherited from class AbstractScmMojo

VALID_VERSION_TYPES, VERSION_TYPE_BRANCH, VERSION_TYPE_REVISION, VERSION_TYPE_TAG

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

ROLE

Constructor Summary

Constructors

Constructor	Description
BootstrapMojo(ScmManager manager, org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Summary

Modifier and Type	Method	Description
protected String	determineWorkingDirectoryPath(File checkoutDirectory, String relativePathProjectDirectory, String goalsDirectory)	Determines the path of the working directory.
void	execute()
private void	runGoals(String relativePathProjectDirectory)

Methods inherited from class CheckoutMojo

checkout, getCheckoutDirectory, getCheckoutResult, setCheckoutDirectory

Methods inherited from class AbstractScmMojo

checkResult, getBasedir, getConnectionUrl, getExcludes, getFileSet, getIncludes, getScmManager, getScmRepository, getScmVersion, getWorkingDirectory, handleExcludesIncludesAfterCheckoutAndExport, setConnectionType, setConnectionUrl, setExcludes, setIncludes, setWorkingDirectory

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

Field Details

goals

@Parameter(property="goals")
private String goals

The goals to run on the clean checkout of a project for the bootstrap goal. If none are specified, then the default goal for the project is executed. Multiple goals should be comma separated.

profiles

@Parameter(property="profiles")
private String profiles

A list of profiles to run with the goals. Multiple profiles must be comma separated with no spaces.

goalsDirectory

@Parameter(property="goalsDirectory")
private String goalsDirectory

The subdirectory (under the project directory) in which to run the goals. The project directory is the same as the checkout directory in most cases, but for some SCMs, it is a subdirectory of the checkout directory.

mavenHome

@Parameter(property="mavenHome",
           defaultValue="${maven.home}")
private File mavenHome

The path where your maven is installed.

Constructor Details

BootstrapMojo

@Inject
public BootstrapMojo(ScmManager manager,
 org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Details

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class CheckoutMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

runGoals

private void runGoals(String relativePathProjectDirectory)
               throws org.apache.maven.plugin.MojoExecutionException

Parameters:

relativePathProjectDirectory - the project directory's path relative to the checkout directory; or "" if they are the same

Throws:

org.apache.maven.plugin.MojoExecutionException - if any

determineWorkingDirectoryPath

protected String determineWorkingDirectoryPath(File checkoutDirectory,
 String relativePathProjectDirectory,
 String goalsDirectory)

Determines the path of the working directory. By default, this is the checkout directory. For some SCMs, the project root directory is not the checkout directory itself, but an SCM-specific subdirectory. The build can furthermore optionally be executed in a subdirectory of this project directory, in case.

Parameters:

checkoutDirectory -

relativePathProjectDirectory -

goalsDirectory -

Returns:

TODO