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

Direct Known Subclasses:

ConfluenceDeployMojo

public abstract class AbstractConfluenceSiteMojo
extends AbstractConfluenceMojo
implements org.bsc.confluence.model.SiteFactory

Author:

bsorrentino

Field Summary

Fields

Modifier and Type	Field	Description
protected File	siteDescriptor	site xml descriptor

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

Method Summary

Modifier and Type	Method	Description
org.bsc.confluence.model.Site	createFromFolder()
org.bsc.confluence.model.Site	createFromModel()
protected void	generateChildren(org.bsc.confluence.ConfluenceService confluence, org.bsc.confluence.model.Site site, org.bsc.confluence.model.Site.Page parentPage, org.bsc.confluence.ConfluenceService.Model.Page confluenceParentPage, Map<String,org.bsc.confluence.ConfluenceService.Model.Page> varsToParentPageMap)
File	getSiteDescriptor()
protected boolean	isSiteDescriptorValid()
protected boolean	navigateAttachments(File folder, org.bsc.confluence.model.Site.Page page)
protected void	navigateChild(int level, File folder, org.bsc.confluence.model.Site.Page parentChild)

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.apache.maven.plugin.Mojo

execute

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

createFrom

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(org.bsc.confluence.ConfluenceService confluence,
                                org.bsc.confluence.model.Site site,
                                org.bsc.confluence.model.Site.Page parentPage,
                                org.bsc.confluence.ConfluenceService.Model.Page confluenceParentPage,
                                Map<String,org.bsc.confluence.ConfluenceService.Model.Page> varsToParentPageMap)

Parameters:

confluence -

parentPage -

confluenceParentPage -

confluenceParentPage -

navigateAttachments

protected boolean navigateAttachments(File folder,
                                      org.bsc.confluence.model.Site.Page page)

Parameters:

folder -

page -

Returns:

navigateChild

protected void navigateChild(int level,
                             File folder,
                             org.bsc.confluence.model.Site.Page parentChild)

Parameters:

level -

folder -

parentChild -

createFromFolder

public org.bsc.confluence.model.Site createFromFolder()

Specified by:

createFromFolder in interface org.bsc.confluence.model.SiteFactory

createFromModel

public org.bsc.confluence.model.Site createFromModel()

Specified by:

createFromModel in interface org.bsc.confluence.model.SiteFactory

Returns: