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

public class SiteStageMojo
extends AbstractDeployMojo

Generates a site in 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 1086533 2011-03-29 10:04:50Z ltheussl $

Author:

Vincent Siveton

Field Summary

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

DEFAULT_STAGING_DIRECTORY

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

SiteStageMojo()

Method Summary

protected java.lang.String	getDeployRepositoryID() Specifies the id to look up credential settings.
protected java.lang.String	getDeployRepositoryURL() Specifies the target URL for the deploy.

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

appendSlash, contextualize, execute, getProxyInfo, getRootSite, getSite, getTopLevelBuildDirectory

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

checkMavenVersion, getInputEncoding, getMavenVersion, getOutputEncoding

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 java.lang.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 java.lang.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