Package 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, org.bsc.confluence.model.SiteFactory

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

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

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 File	outputDirectory
static String	PLUGIN_GOALS_VAR
static String	PLUGIN_SUMMARY_VAR
protected org.apache.maven.scm.manager.ScmManager	scmManager	Maven SCM Manager.
protected boolean	skip	Skip plugin execution

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

siteDescriptor

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

childrenTitlesPrefixed, deployState, deployStateManager, 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	Description
ConfluenceDeployMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()
protected void	generateProjectHomeTemplate(biz.source_code.miniTemplator.MiniTemplator t, org.bsc.confluence.model.Site site, Locale locale)
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

addStdProperties, canProceedToUpdateResource, generateChild, getAttachmentFolder, getCharset, getChildrenFolder, getEncoding, getFileExt, getLabels, getPrintableStringForResource, getProject, getTitle, initTemplateProperties, isChildrenTitlesPrefixed, isRemoveSnapshots, isSnapshot, resetUpdateStatusForResource, setEncoding, setTitle

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

_getSpaceKey, confluenceExecute, getEndPoint, getPassword, getProperties, getUsername, isFailOnError, loadParentPage, loadUserInfoFromSettings, RTE, throwRTE

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

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

createFrom

Field Detail

PLUGIN_SUMMARY_VAR

public static final String PLUGIN_SUMMARY_VAR

See Also:

Constant Field Values

PLUGIN_GOALS_VAR

public static final String PLUGIN_GOALS_VAR

See Also:

Constant Field Values

skip

@Parameter(defaultValue="false")
protected boolean skip

Skip plugin execution

Since:

5.1

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

generateProjectHomeTemplate

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getDescription

public String getDescription(Locale locale)

getOutputName

public String getOutputName()

getName

public String getName(Locale locale)