View Source

h3. {anchor:delete}confluence-reporting:delete
{quote}
Delete a confluence pageTitle
{quote}

h4. Mojo Attributes
* Since version: {{3.4.0}}

h4. Optional Parameters

||Name||Type||Description||
|[attachmentFolder|#attachmentFolder]|File|attachment folder Default value is $\{basedir\}/src/site/confluence/attachments|
|[childrenFolder|#childrenFolder]|File|children folder Default value is $\{basedir\}/src/site/confluence/children|
|[endPoint|#endPoint]|String|Confluence api endpoint url

* To enable *xmlrpc api procotol* endpoint must end with */rpc/xmlrpc*
* To enable *rest api protocol* endpoint must end with */rest/api*

Example:
{noformat}
< endPoint>http://your\_confluence-site/rest/api</endPoint>
{noformat} Default value is http://localhost:8080/rpc/xmlrpc|
|[failOnError|#failOnError]|boolean|Indicates whether the build will continue even if there are clean errors. Default value is true|
|[pageTitle|#pageTitle]|String|Confluence Page Title Default value is $\{project.build.finalName\}|
|[parentPageId|#parentPageId]|String|Confluence parent page id.
If set it is possible to avoid specifying parameters spaceKey and parentPageTitle|
|[parentPageTitle|#parentPageTitle]|String|Confluence parent page title Default value is Home|
|[password|#password]|String|Confluence password|
|[properties|#properties]|Map|additional properties pass to template processor
Properties in the form of URI will be loaded and loaded value will be used instead, see processProperties|
|[recursive|#recursive]|boolean|perform recursive deletion Default value is true|
|[scrollVersions|#scrollVersions]|ScrollVersionsConfiguration|ScrollVersions addon configuration. Below the template
{noformat}
< scrollVersions>
< version>\_version\_name\_</version> // mandatory
< /scrollVersions>
{noformat}|
|[serverId|#serverId]|String|Issue 39
Server's {{id}} in {{settings.xml}} to look up username and password.
Defaults to {{$\{url\}}} if not given.|
|[siteDescriptor|#siteDescriptor]|File|site xml descriptor Default value is $\{basedir\}/src/site/confluence/site.xml|
|[spaceKey|#spaceKey]|String|Confluence target confluence spaceKey|
|[sslCertificate|#sslCertificate]|SSLCertificateInfo|if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).
Below the Template
{noformat}
< sslCertificate>
< ignore>true|false</ignore> // default false
< hostNameVerifierClass>FQN</hostNameVerifierClass> //default null
< trustManagerClass>FQN</trustManagerClass> // default null
< /sslCertificate>
{noformat}|
|[username|#username]|String|Confluence username|
h4. Parameter Details

h5. {anchor:attachmentFolder}attachmentFolder
attachment folder
||Type|java.io.File|
||Required|No|
||Default|$\{basedir\}/src/site/confluence/attachments|
h5. {anchor:childrenFolder}childrenFolder
children folder
||Type|java.io.File|
||Required|No|
||Default|$\{basedir\}/src/site/confluence/children|
h5. {anchor:endPoint}endPoint
Confluence api endpoint url


* To enable *xmlrpc api procotol* endpoint must end with */rpc/xmlrpc*
* To enable *rest api protocol* endpoint must end with */rest/api*


Example:
{noformat}
< endPoint>http://your\_confluence-site/rest/api</endPoint>
{noformat}
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.endPoint\}|
||Default|http://localhost:8080/rpc/xmlrpc|
h5. {anchor:failOnError}failOnError
Indicates whether the build will continue even if there are clean errors.
||Type|boolean|
||Since|5.0-rc1|
||Required|No|
||Expression|$\{confluence.failOnError\}|
||Default|true|
h5. {anchor:pageTitle}pageTitle
Confluence Page Title
||Type|java.lang.String|
||Since|3.1.3|
||Required|No|
||Expression|$\{confluence.page\}|
||Default|$\{project.build.finalName\}|
h5. {anchor:parentPageId}parentPageId
Confluence parent page id.
If set it is possible to avoid specifying parameters spaceKey and parentPageTitle
||Type|java.lang.String|
||Since|4.10|
||Required|No|
||Expression|$\{confluence.parentPageId\}|
h5. {anchor:parentPageTitle}parentPageTitle
Confluence parent page title
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.parentPage\}|
||Default|Home|
h5. {anchor:password}password
Confluence password
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.password\}|
h5. {anchor:properties}properties
additional properties pass to template processor
Properties in the form of URI will be loaded and loaded value will be used instead, see processProperties
||Type|java.util.Map|
||Required|No|
h5. {anchor:recursive}recursive
perform recursive deletion
||Type|boolean|
||Since|3.4.0|
||Required|No|
||Expression|$\{recursive\}|
||Default|true|
h5. {anchor:scrollVersions}scrollVersions
ScrollVersions addon configuration. Below the template

{noformat}

< scrollVersions>
< version>\_version\_name\_</version> // mandatory
< /scrollVersions>

{noformat}
||Type|org.bsc.confluence.rest.scrollversions.ScrollVersionsConfiguration|
||Since|6.5-beta1|
||Required|No|
h5. {anchor:serverId}serverId
Issue 39

Server's {{id}} in {{settings.xml}} to look up username and password.
Defaults to {{$\{url\}}} if not given.
||Type|java.lang.String|
||Since|3.1.1|
||Required|No|
||Expression|$\{confluence.serverId\}|
h5. {anchor:siteDescriptor}siteDescriptor
site xml descriptor
||Type|java.io.File|
||Since|3.3.0|
||Required|No|
||Default|$\{basedir\}/src/site/confluence/site.xml|
h5. {anchor:spaceKey}spaceKey
Confluence target confluence spaceKey
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.spaceKey\}|
h5. {anchor:sslCertificate}sslCertificate
if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).

Below the Template

{noformat}

< sslCertificate>
< ignore>true|false</ignore> // default false
< hostNameVerifierClass>FQN</hostNameVerifierClass> //default null
< trustManagerClass>FQN</trustManagerClass> // default null
< /sslCertificate>

{noformat}
||Type|org.bsc.ssl.SSLCertificateInfo|
||Since|4.1.0|
||Required|No|
h5. {anchor:username}username
Confluence username
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.userName\}|