org.bsc.maven.confluence.plugin

Class ConfluenceDeployMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.bsc.maven.confluence.plugin.AbstractBaseConfluenceMojo

org.bsc.maven.confluence.plugin.AbstractConfluenceMojo

org.bsc.maven.confluence.plugin.AbstractConfluenceSiteMojo

org.bsc.maven.confluence.plugin.ConfluenceDeployMojo

All Implemented Interfaces:

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

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

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

Nested Class Summary

Nested classes/interfaces inherited from class org.bsc.maven.confluence.plugin.AbstractBaseConfluenceMojo

AbstractBaseConfluenceMojo.ConfluenceTask

Field Summary

Fields

Modifier and Type	Field and 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 File	outputDirectory
protected org.apache.maven.scm.manager.ScmManager	scmManager Maven SCM Manager.

Fields inherited from class org.bsc.maven.confluence.plugin.AbstractConfluenceSiteMojo

siteDescriptor

Fields inherited from class org.bsc.maven.confluence.plugin.AbstractConfluenceMojo

project, removeSnapshots, templateWiki

Fields inherited from class org.bsc.maven.confluence.plugin.AbstractBaseConfluenceMojo

mavenSettings, sslCertificate

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ConfluenceDeployMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()

Methods inherited from class org.bsc.maven.confluence.plugin.AbstractConfluenceSiteMojo

createFromFolder, createFromModel, generateChildren, getSiteDescriptor, isSiteDescriptorValid, navigateAttachments, navigateChild

Methods inherited from class org.bsc.maven.confluence.plugin.AbstractConfluenceMojo

addProperties, generateChild, getAttachmentFolder, getCharset, getChildrenFolder, getEncoding, getFileExt, getLabels, getProject, getProperties, getTitle, initTemplateProperties, isRemoveSnapshots, isSnapshot, setEncoding, setTitle

Methods inherited from class org.bsc.maven.confluence.plugin.AbstractBaseConfluenceMojo

confluenceExecute, getEndPoint, getParentPageTitle, getPassword, getSpaceKey, getUsername, loadUserInfoFromSettings, newClass

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

Field Detail

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 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()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getDescription

public String getDescription(Locale locale)

getOutputName

public String getOutputName()

getName

public String getName(Locale locale)