org.apache.maven.plugins.site
Class SiteStageMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugins.site.AbstractSiteMojo
          extended by org.apache.maven.plugins.site.AbstractDeployMojo
              extended by org.apache.maven.plugins.site.SiteStageMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, Contextualizable

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.html 816561 2012-05-08 12:02:24Z hboutemy $
Author:
Vincent Siveton
Is defined by the goal name:
stage
Requires the dependencies in this specified scope:
test

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


Copyright © 2002-2012 The Apache Software Foundation. All Rights Reserved.