org.apache.maven.plugins.site.deploy

Class SiteStageDeployMojo

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

All Implemented Interfaces:

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

@Mojo(name="stage-deploy",
      requiresDependencyResolution=TEST)
public class SiteStageDeployMojo
extends AbstractStagingMojo

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

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
SiteStageDeployMojo()

Method Summary

Modifier and Type	Method and Description
protected org.apache.maven.model.Site	determineDeploySite()
protected String	determineTopDistributionManagementSiteUrl() If stagingSiteURL is configured, top most parent with same staging site url will be used.
protected boolean	isDeploy() Detect if the mojo is staging or deploying.

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

appendSlash, execute, 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

SiteStageDeployMojo

public SiteStageDeployMojo()

Method Detail

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)

determineTopDistributionManagementSiteUrl

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

If stagingSiteURL is configured, top most parent with same staging site url will be used.

Overrides:

determineTopDistributionManagementSiteUrl in class AbstractStagingMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

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