org.apache.maven.plugins.site.deploy

Class AbstractStagingMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SiteStageDeployMojo, SiteStageMojo

public abstract class AbstractStagingMojo
extends AbstractDeployMojo

Abstract base class for staging mojos.

Since:

3.3

Author:

hboutemy

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_STAGING_DIRECTORY The String "staging/".
protected String	topSiteURL Top distribution management site url, for manual configuration when auto-calculated value doesn't match expectations.

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

Method Summary

Modifier and Type	Method and Description
protected String	determineTopDistributionManagementSiteUrl() By default, staging mojos will get their top distribution management site url by getting top parent with the same site, which is a good heuristics.

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

appendSlash, contextualize, determineDeploySite, execute, getDeployModuleDirectory, getDeploySite, getProxyInfo, getSite, getTopDistributionManagementSiteUrl, getTopLevelProject, isDeploy

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

Field Detail

topSiteURL

@Parameter(property="topSiteURL")
protected String topSiteURL

Top distribution management site url, for manual configuration when auto-calculated value doesn't match expectations. Relative module directory will be calculated from this url.

Since:

3.3

DEFAULT_STAGING_DIRECTORY

protected static final String DEFAULT_STAGING_DIRECTORY

The String "staging/".

See Also:

Constant Field Values

Constructor Detail

AbstractStagingMojo

public AbstractStagingMojo()

Method Detail

determineTopDistributionManagementSiteUrl

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

By default, staging mojos will get their top distribution management site url by getting top parent with the same site, which is a good heuristics. But in case the default value doesn't match expectations, topSiteURL can be configured: it will be used instead.

Specified by:

determineTopDistributionManagementSiteUrl in class AbstractDeployMojo

Throws:

org.apache.maven.plugin.MojoExecutionException