Package org.bsc.mojo

Class AbstractConfluenceDeployMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.bsc.mojo.AbstractBaseConfluenceMojo

org.bsc.mojo.AbstractBaseConfluenceSiteMojo

org.bsc.mojo.AbstractConfluenceDeployMojo

All Implemented Interfaces:

org.bsc.confluence.model.SiteFactory.Folder, DeployStateSupport

Direct Known Subclasses:

ConfluenceDeployMojo

public abstract class AbstractConfluenceDeployMojo
extends AbstractBaseConfluenceSiteMojo
implements org.bsc.confluence.model.SiteFactory.Folder, DeployStateSupport

Author:

bsorrentino

Nested Class Summary

Nested classes/interfaces inherited from interface org.bsc.AsyncFunctionDefinition

org.bsc.AsyncFunctionDefinition.AsyncFunc<T extends java.lang.Object,R extends java.lang.Object>, org.bsc.AsyncFunctionDefinition.AsyncPageFunc<T extends java.lang.Object>, org.bsc.AsyncFunctionDefinition.AsyncPageSupplier, org.bsc.AsyncFunctionDefinition.AsyncProcessPageFunc, org.bsc.AsyncFunctionDefinition.AsyncSupplier<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	childrenTitlesPrefixed	prefix child page with the title of the parent
protected DeployStateInfo	deployState	Experimental feature - Store the last deployed state If declared, a local file will be generated that keeps the last update date of all documents involved in publication. If such file is present the plugin will check the last update date of each document, skipping it, if no update is detected. Example:
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 java.io.File	templateWiki	Home page template source.

Fields inherited from class org.bsc.mojo.AbstractBaseConfluenceMojo

mavenSettings, skip, sslCertificate

Fields inherited from class org.bsc.mojo.AbstractBaseConfluenceSiteMojo

project, siteDescriptor

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractConfluenceDeployMojo()

Method Summary

Modifier and Type	Method	Description
org.bsc.confluence.model.Site	createSiteFromFolder()
void	execute(org.bsc.confluence.ConfluenceService confluenceService)
protected <T extends org.bsc.confluence.model.Site.Page> org.bsc.confluence.ConfluenceService.Model.Page	generateChild(org.bsc.confluence.ConfluenceService confluence, org.bsc.confluence.model.Site site, T child, org.bsc.confluence.ConfluenceService.Model.Page parentPage)
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, java.util.Map<java.lang.String,org.bsc.confluence.ConfluenceService.Model.Page> varsToParentPageMap)
protected java.nio.charset.Charset	getCharset()
DeployStateInfo	getDeployState()
java.util.Optional<org.bsc.confluence.DeployStateManager>	getDeployStateManager()
java.lang.String	getEncoding()
java.lang.String	getFileExt()
java.util.List<java.lang.String>	getLabels()
protected <S extends org.bsc.confluence.model.Site.Source> java.lang.String	getPrintableStringForResource(S source)
org.apache.maven.project.MavenProject	getProject()
boolean	isChildrenTitlesPrefixed()
boolean	isRemoveSnapshots()
boolean	isSnapshot()
protected org.bsc.confluence.model.Site	loadSite()
protected boolean	navigateAttachments(java.io.File folder, org.bsc.confluence.model.Site.Page page)
protected void	navigateChild(int level, java.io.File folder, org.bsc.confluence.model.Site.Page parentChild)
protected java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Page>	saveAttributesToDeployStateManager(org.bsc.confluence.model.Site.Page sitePage, org.bsc.confluence.ConfluenceService.Model.Page confluencePage)
void	setEncoding(java.lang.String encoding)
protected java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Attachment>	updateAttachmentIfNeeded(org.bsc.confluence.model.Site.Attachment siteAttachment, org.bsc.confluence.ConfluenceService.Model.Attachment confluenceAttachment, java.util.function.Supplier<java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Attachment>> performUpdate)
protected java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Page>	updatePageIfNeeded(org.bsc.confluence.model.Site.Page sitePage, org.bsc.confluence.ConfluenceService.Model.Page confluencePage, java.util.function.Supplier<java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Page>> performUpdate)

Methods inherited from class org.bsc.mojo.AbstractBaseConfluenceMojo

execute, getEndPoint, getPassword, getProperties, getSpaceKey, getUsername, isFailOnError, loadParentPage, RTE, throwRTE

Methods inherited from class org.bsc.mojo.AbstractBaseConfluenceSiteMojo

addStdProperties, createSiteFromModel, getAttachmentFolder, getChildrenFolder, getPageTitle, getSiteDescriptor, getSiteModelVariables, isSiteDescriptorValid, setPageTitle

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from interface org.bsc.mojo.DeployStateSupport

getEndPoint, initDeployStateManager

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.Model

createFrom

Field Detail

templateWiki

@Parameter(defaultValue="${basedir}/src/site/confluence/template.wiki")
protected java.io.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

childrenTitlesPrefixed

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

prefix child page with the title of the parent

Since:

4.9

deployState

@Parameter
protected DeployStateInfo deployState

Experimental feature - Store the last deployed state
If declared, a local file will be generated that keeps the last update date of all documents involved in publication.
If such file is present the plugin will check the last update date of each document, skipping it, if no update is detected.
Example:

   <deployState>
     <active> true|false </active> <!-- default: true -->
     <outdir> target dir </outdir> <!-- default: project.build.directory -->
   </deployState>
 

Since:

6.0.0

Constructor Detail

AbstractConfluenceDeployMojo

public AbstractConfluenceDeployMojo()

Method Detail

getEncoding

public java.lang.String getEncoding()

Returns:

setEncoding

public void setEncoding(java.lang.String encoding)

Parameters:

encoding -

getCharset

protected final java.nio.charset.Charset getCharset()

Returns:

getFileExt

public java.lang.String getFileExt()

Returns:

getProject

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

Specified by:

getProject in interface DeployStateSupport

isRemoveSnapshots

public boolean isRemoveSnapshots()

isSnapshot

public boolean isSnapshot()

isChildrenTitlesPrefixed

public boolean isChildrenTitlesPrefixed()

getLabels

public java.util.List<java.lang.String> getLabels()

getDeployState

public final DeployStateInfo getDeployState()

Specified by:

getDeployState in interface DeployStateSupport

getDeployStateManager

public final java.util.Optional<org.bsc.confluence.DeployStateManager> getDeployStateManager()

Returns:

execute

public void execute(org.bsc.confluence.ConfluenceService confluenceService)
             throws java.lang.Exception

Specified by:

execute in class AbstractBaseConfluenceMojo

Parameters:

confluenceService -

Throws:

java.lang.Exception

getPrintableStringForResource

protected <S extends org.bsc.confluence.model.Site.Source> java.lang.String getPrintableStringForResource(S source)

Type Parameters:

S -

Parameters:

source -

Returns:

saveAttributesToDeployStateManager

protected java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Page> saveAttributesToDeployStateManager(org.bsc.confluence.model.Site.Page sitePage,
                                                                                                                                     org.bsc.confluence.ConfluenceService.Model.Page confluencePage)

Parameters:

sitePage -

confluencePage -

Returns:

updatePageIfNeeded

protected java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Page> updatePageIfNeeded(org.bsc.confluence.model.Site.Page sitePage,
                                                                                                                     org.bsc.confluence.ConfluenceService.Model.Page confluencePage,
                                                                                                                     java.util.function.Supplier<java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Page>> performUpdate)

Parameters:

sitePage -

confluencePage -

performUpdate -

Returns:

generateChild

protected <T extends org.bsc.confluence.model.Site.Page> org.bsc.confluence.ConfluenceService.Model.Page generateChild(org.bsc.confluence.ConfluenceService confluence,
                                                                                                                       org.bsc.confluence.model.Site site,
                                                                                                                       T child,
                                                                                                                       org.bsc.confluence.ConfluenceService.Model.Page parentPage)

Parameters:

site -

confluence -

child -

parentPage -

Returns:

updateAttachmentIfNeeded

protected java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Attachment> updateAttachmentIfNeeded(org.bsc.confluence.model.Site.Attachment siteAttachment,
                                                                                                                                 org.bsc.confluence.ConfluenceService.Model.Attachment confluenceAttachment,
                                                                                                                                 java.util.function.Supplier<java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Attachment>> performUpdate)

Parameters:

siteAttachment -

confluenceAttachment -

performUpdate -

Returns:

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,
                                java.util.Map<java.lang.String,org.bsc.confluence.ConfluenceService.Model.Page> varsToParentPageMap)

Parameters:

confluence -

parentPage -

confluenceParentPage -

confluenceParentPage -

navigateAttachments

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

Parameters:

folder -

page -

Returns:

navigateChild

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

Parameters:

level -

folder -

parentChild -

createSiteFromFolder

public final org.bsc.confluence.model.Site createSiteFromFolder()

Specified by:

createSiteFromFolder in interface org.bsc.confluence.model.SiteFactory.Folder

loadSite

protected org.bsc.confluence.model.Site loadSite()

Returns:

site