Package org.bsc.mojo

Class ConfluenceDeployMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.bsc.mojo.AbstractBaseConfluenceMojo

org.bsc.mojo.AbstractBaseConfluenceSiteMojo

org.bsc.mojo.AbstractConfluenceDeployMojo

org.bsc.mojo.ConfluenceDeployMojo

All Implemented Interfaces:

DeployStateSupport

@Mojo(name="deploy",
      threadSafe=true)
public class ConfluenceDeployMojo
extends AbstractConfluenceDeployMojo

Generate Project's documentation in confluence wiki format and deploy it

Nested Class Summary

Nested classes/interfaces inherited from interface org.bsc.AsyncFunctionDefinition

org.bsc.AsyncFunctionDefinition.AsyncFunc<T extends java.lang.Object,R extends java.lang.Object>, org.bsc.AsyncFunctionDefinition.AsyncPageFunc<T extends java.lang.Object>, org.bsc.AsyncFunctionDefinition.AsyncPageSupplier, org.bsc.AsyncFunctionDefinition.AsyncProcessPageFunc, org.bsc.AsyncFunctionDefinition.AsyncSupplier<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource	artifactMetadataSource
protected org.apache.maven.artifact.factory.ArtifactFactory	factory
protected org.codehaus.plexus.i18n.I18N	i18n
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository	Local Repository.
protected org.apache.maven.tools.plugin.scanner.MojoScanner	mojoScanner	Mojo scanner tools.
protected java.io.File	outputDirectory
static java.lang.String	PLUGIN_GOALS_VAR
static java.lang.String	PLUGIN_SUMMARY_VAR
protected org.apache.maven.scm.manager.ScmManager	scmManager	Maven SCM Manager.

Fields inherited from class org.bsc.mojo.AbstractBaseConfluenceMojo

mavenSettings, skip, sslCertificate

Fields inherited from class org.bsc.mojo.AbstractBaseConfluenceSiteMojo

project, siteDescriptor

Fields inherited from class org.bsc.mojo.AbstractConfluenceDeployMojo

childrenTitlesPrefixed, deployState, removeSnapshots, templateWiki

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

ROLE

Constructor Summary

Constructors

Constructor	Description
ConfluenceDeployMojo()

Method Summary

Modifier and Type	Method	Description
void	execute(org.bsc.confluence.ConfluenceService confluence)
protected void	generateProjectHomeTemplate(biz.source_code.miniTemplator.MiniTemplator t, org.bsc.confluence.model.Site site, java.util.Locale locale)
java.lang.String	getDescription(java.util.Locale locale)
java.lang.String	getName(java.util.Locale locale)
java.lang.String	getOutputName()

Methods inherited from class org.bsc.mojo.AbstractBaseConfluenceMojo

execute, getEndPoint, getPassword, getProperties, getSpaceKey, getUsername, isFailOnError, loadParentPage, RTE, throwRTE

Methods inherited from class org.bsc.mojo.AbstractBaseConfluenceSiteMojo

addStdProperties, createSiteFromModel, getAttachmentFolder, getChildrenFolder, getPageTitle, getSiteDescriptor, getSiteModelVariables, isSiteDescriptorValid, setPageTitle

Methods inherited from class org.bsc.mojo.AbstractConfluenceDeployMojo

createSiteFromFolder, generateChild, generateChildren, getCharset, getDeployState, getDeployStateManager, getEncoding, getFileExt, getLabels, getPrintableStringForResource, getProject, isChildrenTitlesPrefixed, isRemoveSnapshots, isSnapshot, loadSite, navigateAttachments, navigateChild, saveAttributesToDeployStateManager, setEncoding, updateAttachmentIfNeeded, updatePageIfNeeded

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from interface org.bsc.mojo.DeployStateSupport

getEndPoint, initDeployStateManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bsc.confluence.model.SiteFactory.Model

createFrom

Field Detail

PLUGIN_SUMMARY_VAR

public static final java.lang.String PLUGIN_SUMMARY_VAR

See Also:

Constant Field Values

PLUGIN_GOALS_VAR

public static final java.lang.String PLUGIN_GOALS_VAR

See Also:

Constant Field Values

localRepository

@Parameter(defaultValue="${localRepository}",
           required=true,
           readonly=true)
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

Local Repository.

artifactMetadataSource

@Component
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource

factory

@Component(role=org.apache.maven.artifact.factory.ArtifactFactory.class)
protected org.apache.maven.artifact.factory.ArtifactFactory factory

i18n

@Component
protected org.codehaus.plexus.i18n.I18N i18n

outputDirectory

@Parameter(property="project.build.directory/generated-site/confluence",
           required=true)
protected java.io.File outputDirectory

scmManager

@Component(role=org.apache.maven.scm.manager.ScmManager.class)
protected org.apache.maven.scm.manager.ScmManager scmManager

Maven SCM Manager.

mojoScanner

@Component
protected org.apache.maven.tools.plugin.scanner.MojoScanner mojoScanner

Mojo scanner tools.

Constructor Detail

ConfluenceDeployMojo

public ConfluenceDeployMojo()

Method Detail

execute

public void execute(org.bsc.confluence.ConfluenceService confluence)
             throws java.lang.Exception

Overrides:

execute in class AbstractConfluenceDeployMojo

Parameters:

confluence -

Throws:

java.lang.Exception

generateProjectHomeTemplate

protected void generateProjectHomeTemplate(biz.source_code.miniTemplator.MiniTemplator t,
                                           org.bsc.confluence.model.Site site,
                                           java.util.Locale locale)
                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getDescription

public java.lang.String getDescription(java.util.Locale locale)

getOutputName

public java.lang.String getOutputName()

getName

public java.lang.String getName(java.util.Locale locale)