org.bsc.confluence.model.SiteFactory.Folder, DeployStateSupportConfluenceDeployMojopublic abstract class AbstractConfluenceDeployMojo extends AbstractBaseConfluenceSiteMojo implements org.bsc.confluence.model.SiteFactory.Folder, DeployStateSupport
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>| 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.
|
mavenSettings, skip, sslCertificateproject, siteDescriptor| Constructor | Description |
|---|---|
AbstractConfluenceDeployMojo() |
| 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> |
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> |
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) |
execute, getEndPoint, getPassword, getProperties, getSpaceKey, getUsername, isFailOnError, loadParentPage, RTE, throwRTEaddStdProperties, createSiteFromModel, getAttachmentFolder, getChildrenFolder, getPageTitle, getSiteDescriptor, getSiteModelVariables, isSiteDescriptorValid, setPageTitlegetLog, getPluginContext, setLog, setPluginContextgetEndPoint, initDeployStateManager@Parameter(defaultValue="${basedir}/src/site/confluence/template.wiki")
protected java.io.File templateWiki
@Parameter(property="confluence.removeSnapshots",
required=false,
defaultValue="false")
protected boolean removeSnapshots
@Parameter(property="confluence.childrenTitlesPrefixed",
required=false,
defaultValue="true")
protected boolean childrenTitlesPrefixed
@Parameter protected DeployStateInfo deployState
<deployState>
<active> true|false </active> <!-- default: true -->
<outdir> target dir </outdir> <!-- default: project.build.directory -->
</deployState>
public java.lang.String getEncoding()
public void setEncoding(java.lang.String encoding)
encoding - protected final java.nio.charset.Charset getCharset()
public java.lang.String getFileExt()
public org.apache.maven.project.MavenProject getProject()
getProject in interface DeployStateSupportpublic boolean isRemoveSnapshots()
public boolean isSnapshot()
public boolean isChildrenTitlesPrefixed()
public java.util.List<java.lang.String> getLabels()
public final DeployStateInfo getDeployState()
getDeployState in interface DeployStateSupportpublic final java.util.Optional<org.bsc.confluence.DeployStateManager> getDeployStateManager()
public void execute(org.bsc.confluence.ConfluenceService confluenceService)
throws java.lang.Exception
execute in class AbstractBaseConfluenceMojoconfluenceService - java.lang.Exceptionprotected <S extends org.bsc.confluence.model.Site.Source> java.lang.String getPrintableStringForResource(S source)
S - source - 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)
sitePage - confluencePage - 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)
sitePage - confluencePage - performUpdate - 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)
site - confluence - child - parentPage - 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)
siteAttachment - confluenceAttachment - performUpdate - 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)
confluence - parentPage - confluenceParentPage - confluenceParentPage - protected boolean navigateAttachments(java.io.File folder,
org.bsc.confluence.model.Site.Page page)
folder - page - protected void navigateChild(int level,
java.io.File folder,
org.bsc.confluence.model.Site.Page parentChild)
level - folder - parentChild - public final org.bsc.confluence.model.Site createSiteFromFolder()
createSiteFromFolder in interface org.bsc.confluence.model.SiteFactory.Folderprotected org.bsc.confluence.model.Site loadSite()
Copyright © 2022 Bartolomeo Sorrentino. All rights reserved.