org.apache.maven.plugins.site
Class SiteStageMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugins.site.AbstractSiteMojo
          org.apache.maven.plugins.site.AbstractDeployMojo
              org.apache.maven.plugins.site.AbstractStagingMojo
                  org.apache.maven.plugins.site.SiteStageMojo

All Implemented Interfaces:

ContextEnabled, Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

@Mojo(name="stage",
      requiresDependencyResolution=TEST)
public class SiteStageMojo
extends AbstractStagingMojo

Deploys the generated site to a local staging or mock directory based on the site URL specified in the <distributionManagement> section of the POM.

It can be used to test that links between module sites in a multi-module build work.

Version:

$Id: SiteStageMojo.html 861484 2013-05-09 23:10:16Z hboutemy $

Author:

Vincent Siveton

SiteStageMojo

public SiteStageMojo()

execute

public void execute()
             throws MojoExecutionException

Description copied from class: AbstractDeployMojo

Specified by:

execute in interface Mojo

Overrides:

execute in class AbstractDeployMojo

Throws:

MojoExecutionException

isDeploy

protected boolean isDeploy()

Description copied from class: AbstractDeployMojo

Detect if the mojo is staging or deploying.

Specified by:

isDeploy in class AbstractDeployMojo

Returns:

true if the mojo is for deploy and not staging (local or deploy)

determineDeploySite

protected Site determineDeploySite()
                            throws MojoExecutionException

Specified by:

determineDeploySite in class AbstractDeployMojo

Throws:

MojoExecutionException

getExecutionRootBuildDirectory

protected File getExecutionRootBuildDirectory()

Find the build directory of the execution root project in the reactor. If no execution root project is found, the build directory of the current project is returned.

Returns:

the build directory of the execution root project.