org.bsc.maven.confluence.plugin

Class AbstractConfluenceSiteMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ConfluenceDeployMojo

public abstract class AbstractConfluenceSiteMojo
extends AbstractConfluenceMojo
implements SiteFactory

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 File	siteDescriptor site xml descriptor

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

Method Summary

Modifier and Type	Method and Description
Site	createFromFolder()
Site	createFromModel()
protected void	generateChildren(Confluence confluence, Site.Page parentPage, Page confluenceParentPage, String spaceKey, String parentPageTitle, String titlePrefix)
File	getSiteDescriptor()
protected boolean	isSiteDescriptorValid()
protected boolean	navigateAttachments(File folder, Site.Page page)
protected void	navigateChild(int level, File folder, Site.Page parentChild)

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

addStdProperties, 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

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

siteDescriptor

@Parameter(defaultValue="${basedir}/src/site/confluence/site.xml")
protected File siteDescriptor

site xml descriptor

Since:

3.3.0

Constructor Detail

AbstractConfluenceSiteMojo

public AbstractConfluenceSiteMojo()

Method Detail

getSiteDescriptor

public File getSiteDescriptor()

Returns:

isSiteDescriptorValid

protected boolean isSiteDescriptorValid()

generateChildren

protected void generateChildren(Confluence confluence,
                                Site.Page parentPage,
                                Page confluenceParentPage,
                                String spaceKey,
                                String parentPageTitle,
                                String titlePrefix)

Parameters:

confluence -

parentPage -

confluenceParentPage -

spaceKey -

parentPageTitle -

titlePrefix -

navigateAttachments

protected boolean navigateAttachments(File folder,
                                      Site.Page page)

Parameters:

folder -

page -

Returns:

navigateChild

protected void navigateChild(int level,
                             File folder,
                             Site.Page parentChild)

Parameters:

level -

folder -

parentChild -

createFromFolder

public Site createFromFolder()

Specified by:

createFromFolder in interface SiteFactory

createFromModel

public Site createFromModel()

Specified by:

createFromModel in interface SiteFactory

Returns: