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

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.AbstractStagingMojo
                  org.apache.maven.plugins.site.SiteStageDeployMojo

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

@Mojo(name="stage-deploy", requiresDependencyResolution=TEST) public class SiteStageDeployMojo
extends AbstractStagingMojo
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

Version:: $Id: SiteStageDeployMojo.html 861484 2013-05-09 23:10:16Z hboutemy $
Author:: Vincent Siveton

Field Summary

Fields inherited from class org.apache.maven.plugins.site.AbstractStagingMojo
`DEFAULT_STAGING_DIRECTORY, topSiteURL`

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

Method Summary
`protected 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.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

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 MojoExecutionException

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

Overrides:: determineTopDistributionManagementSiteUrl in class AbstractStagingMojo

Throws:: MojoExecutionException

determineDeploySite

protected Site determineDeploySite()
                            throws MojoExecutionException

Specified by:: determineDeploySite in class AbstractDeployMojo

Throws:: MojoExecutionException