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

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

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

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

Version:

$Id: SiteStageMojo.java 1380054 2012-09-02 21:00:00Z hboutemy $

Author:

Vincent Siveton

Field Summary

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

DEFAULT_STAGING_DIRECTORY, mavenSession

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

i18n, locales, localRepository, project, reactorProjects, siteDirectory, siteTool

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

ROLE

Constructor Summary

Constructors

Constructor and Description
SiteStageMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected String	getDeployRepositoryID() Specifies the id to look up credential settings.
protected String	getDeployRepositoryURL() Specifies the target URL for the deploy.
protected boolean	isDeploy() Detect if the mojo is staging or deploying.

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

appendSlash, contextualize, getDeployModuleDirectory, getProxyInfo, getRootSite, getSite, getTopLevelBuildDirectory

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

getInputEncoding, getMavenVersion, getOutputEncoding, isMaven3OrMore

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

getDeployRepositoryID

protected String getDeployRepositoryID()
                                throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractDeployMojo

Specifies the id to look up credential settings.

Specified by:

getDeployRepositoryID in class AbstractDeployMojo

Returns:

the id to look up credentials for the deploy. Not null.

Throws:

org.apache.maven.plugin.MojoExecutionException - if the ID cannot be determined

getDeployRepositoryURL

protected String getDeployRepositoryURL()
                                 throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractDeployMojo

Specifies the target URL for the deploy. This should be the top-level URL, ie above modules and locale sub-directories.

Specified by:

getDeployRepositoryURL in class AbstractDeployMojo

Returns:

the url to deploy to. Not null.

Throws:

org.apache.maven.plugin.MojoExecutionException - if the URL cannot be constructed

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.

Overrides:

isDeploy in class AbstractDeployMojo

Returns:

rue if the mojo is for deploy and not staging