org.apache.maven.plugins.site
Class SiteStageDeployMojo

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

All Implemented Interfaces:

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

public class SiteStageDeployMojo
extends AbstractDeployMojo

Deploys the generated site to a staging or mock directory to the site URL specified in the <distributionManagement> section of the POM, using wagon supported protocols

Version:

$Id: SiteStageDeployMojo.html 816573 2012-05-08 12:11:59Z hboutemy $

Author:

Vincent Siveton

Is defined by the goal name:

stage-deploy

Requires the dependencies in this specified scope:

test

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

SiteStageDeployMojo()

Method Summary

protected String	getDeployModuleDirectory() Find the relative path between the distribution URLs of the top parent and the current project.
protected String	getDeployRepositoryID() Specifies the id to look up credential settings.
protected 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

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

SiteStageDeployMojo

public SiteStageDeployMojo()

Method Detail

getDeployModuleDirectory

protected String getDeployModuleDirectory()
                                   throws MojoExecutionException

Description copied from class: AbstractDeployMojo

Find the relative path between the distribution URLs of the top parent and the current project.

Overrides:

getDeployModuleDirectory in class AbstractDeployMojo

Returns:

the relative path or "./" if the two URLs are the same.

Throws:

MojoExecutionException

getDeployRepositoryID

protected String getDeployRepositoryID()
                                throws 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:

MojoExecutionException - if the ID cannot be determined

getDeployRepositoryURL

protected String getDeployRepositoryURL()
                                 throws 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:

MojoExecutionException - if the URL cannot be constructed