Class SiteDeployMojo

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

All Implemented Interfaces:

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

@Mojo(name="deploy")
public class SiteDeployMojo
extends AbstractDeployMojo

Deploys the generated site using wagon supported protocols to the site URL specified in the <distributionManagement> section of the POM.

For scp protocol, the website files are packaged by wagon into zip archive, then the archive is transfered to the remote host, next it is un-archived which is much faster than making a file by file copy.

Since:

2.0

Field Summary

Fields inherited from class AbstractDeployMojo

mavenSession, settingsDecrypter

Fields inherited from class AbstractSiteMojo

i18n, project, siteTool, skip

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
SiteDeployMojo()

Method Summary

Modifier and Type	Method	Description
protected org.apache.maven.model.Site	determineDeploySite()	Deploy directly to the current project's distribution management site.
protected String	determineTopDistributionManagementSiteUrl()	Deploy distribution site url is directly the current project value.
protected boolean	isDeploy()	Detect if the mojo is staging or deploying.

Methods inherited from class AbstractDeployMojo

appendSlash, execute, getAuthenticationInfo, getDeployModuleDirectory, getDeploySite, getSite, getTopDistributionManagementSiteUrl, getTopLevelProject

Methods inherited from class AbstractSiteMojo

getLocales

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SiteDeployMojo

public SiteDeployMojo()

Method Details

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

Deploy distribution site url is directly the current project value.

Specified by:

determineTopDistributionManagementSiteUrl in class AbstractDeployMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

determineDeploySite

protected org.apache.maven.model.Site determineDeploySite()
                                                   throws org.apache.maven.plugin.MojoExecutionException

Deploy directly to the current project's distribution management site.

Specified by:

determineDeploySite in class AbstractDeployMojo

Throws:

org.apache.maven.plugin.MojoExecutionException