org.apache.maven.plugins.site.deploy

Class SiteStageMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.site.AbstractSiteMojo

org.apache.maven.plugins.site.deploy.AbstractDeployMojo

org.apache.maven.plugins.site.deploy.AbstractStagingMojo

org.apache.maven.plugins.site.deploy.SiteStageMojo

All Implemented Interfaces:

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

@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.

This goal requires the site to already have been generated using the site goal, such as by calling mvn site.

Since:

2.0

Author:

Vincent Siveton

Field Summary

Fields inherited from class org.apache.maven.plugins.site.deploy.AbstractStagingMojo

DEFAULT_STAGING_DIRECTORY, topSiteURL

Fields inherited from class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

mavenSession

Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo

i18n, project, siteTool, skip

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

ROLE

Constructor Summary

Constructors

Constructor and Description
SiteStageMojo()

Method Summary

Modifier and Type	Method and Description
protected org.apache.maven.model.Site	determineDeploySite()
void	execute()
protected File	getExecutionRootBuildDirectory() Find the build directory of the execution root project in the reactor.
protected boolean	isDeploy() Detect if the mojo is staging or deploying.

Methods inherited from class org.apache.maven.plugins.site.deploy.AbstractStagingMojo

determineTopDistributionManagementSiteUrl

Methods inherited from class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

appendSlash, getAuthenticationInfo, getDeployModuleDirectory, getDeploySite, getSite, getTopDistributionManagementSiteUrl, getTopLevelProject

Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo

getLocales

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

Constructor Detail

SiteStageMojo

public SiteStageMojo()

Method Detail

execute

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

Description copied from class: AbstractDeployMojo

Specified by:

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

Overrides:

execute in class AbstractDeployMojo

Throws:

org.apache.maven.plugin.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 org.apache.maven.model.Site determineDeploySite()
                                                   throws org.apache.maven.plugin.MojoExecutionException

Specified by:

determineDeploySite in class AbstractDeployMojo

Throws:

org.apache.maven.plugin.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.