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:

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

public class SiteDeployMojo
extends AbstractDeployMojo

Deploys the generated site using scp or file protocol to the site URL specified in the <distributionManagement> section of the POM.

For scp protocol, the website files are packaged into zip archive, then the archive is transfered to the remote host, next it is un-archived. This method of deployment should normally be much faster than making a file by file copy. For file protocol, the files are copied directly to the destination directory.

Version:

$Id: SiteDeployMojo.html 816568 2012-05-08 12:09:38Z hboutemy $

Author:

Michal Maczka

Is defined by the goal name:

deploy

Field Summary

Fields inherited from class org.apache.maven.plugins.site.AbstractDeployMojo

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

String	getDeployRepositoryID() Specifies the id to look up credential settings.
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

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

getDeployRepositoryID

public 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

public 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