SiteDeployMojo (Maven Site Plugin 3 3.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugins.site
Class SiteDeployMojo

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

All Implemented Interfaces:: ContextEnabled, Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

@Mojo(name="deploy") public class SiteDeployMojo
extends AbstractDeployMojo
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.

Version:: $Id: SiteDeployMojo.html 861484 2013-05-09 23:10:16Z hboutemy $
Author:: Michal Maczka

Field Summary

Fields inherited from class org.apache.maven.plugins.site.AbstractDeployMojo
`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
`SiteDeployMojo()`

Method Summary
`protected 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 org.apache.maven.plugins.site.AbstractDeployMojo
`appendSlash, contextualize, execute, getDeployModuleDirectory, getDeploySite, getProxyInfo, getSite, getTopDistributionManagementSiteUrl, getTopLevelProject`

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

SiteDeployMojo

public SiteDeployMojo()

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 MojoExecutionException

Deploy distribution site url is directly the current project value.

Specified by:: determineTopDistributionManagementSiteUrl in class AbstractDeployMojo

Throws:: MojoExecutionException

determineDeploySite

protected Site determineDeploySite()
                            throws MojoExecutionException

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

Specified by:: determineDeploySite in class AbstractDeployMojo

Throws:: MojoExecutionException