org.bsc.maven.confluence.plugin

Class AbstractConfluenceMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.bsc.maven.confluence.plugin.AbstractBaseConfluenceMojo

org.bsc.maven.confluence.plugin.AbstractConfluenceMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractConfluenceSiteMojo

public abstract class AbstractConfluenceMojo
extends AbstractBaseConfluenceMojo

Author:

bsorrentino

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.project.MavenProject	project Maven Project
protected boolean	removeSnapshots During publish of documentation related to a new release, if it's true, the pages related to SNAPSHOT will be removed
protected File	templateWiki Home page template source.

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
AbstractConfluenceMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	addProperties(biz.source_code.miniTemplator.MiniTemplator t)
protected <T extends Site.Page> Page	generateChild(Confluence confluence, T child, String spaceKey, String parentPageTitle, String titlePrefix)
protected File	getAttachmentFolder()
protected Charset	getCharset()
protected File	getChildrenFolder()
String	getEncoding()
String	getFileExt()
List<String>	getLabels()
org.apache.maven.project.MavenProject	getProject()
Map<String,String>	getProperties()
protected String	getTitle()
protected void	initTemplateProperties() initialize properties shared with template
boolean	isRemoveSnapshots()
boolean	isSnapshot()
void	setEncoding(String encoding)
void	setTitle(String title)

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

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

execute

Field Detail

project

@Parameter(property="project",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

Maven Project

templateWiki

@Parameter(defaultValue="${basedir}/src/site/confluence/template.wiki")
protected File templateWiki

Home page template source. Template name will be used also as template source for children

removeSnapshots

@Parameter(property="confluence.removeSnapshots",
           required=false,
           defaultValue="false")
protected boolean removeSnapshots

During publish of documentation related to a new release, if it's true, the pages related to SNAPSHOT will be removed

Constructor Detail

AbstractConfluenceMojo

public AbstractConfluenceMojo()

Method Detail

getChildrenFolder

protected File getChildrenFolder()

getAttachmentFolder

protected File getAttachmentFolder()

getEncoding

public String getEncoding()

Returns:

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding -

getCharset

protected final Charset getCharset()

Returns:

getTitle

protected final String getTitle()

Returns:

setTitle

public void setTitle(String title)

Parameters:

title -

getFileExt

public String getFileExt()

Returns:

getProperties

public final Map<String,String> getProperties()

getProject

public org.apache.maven.project.MavenProject getProject()

isRemoveSnapshots

public boolean isRemoveSnapshots()

isSnapshot

public boolean isSnapshot()

getLabels

public List<String> getLabels()

initTemplateProperties

protected void initTemplateProperties()

initialize properties shared with template

addProperties

public void addProperties(biz.source_code.miniTemplator.MiniTemplator t)

generateChild

protected <T extends Site.Page> Page generateChild(Confluence confluence,
                                       T child,
                                       String spaceKey,
                                       String parentPageTitle,
                                       String titlePrefix)