confluence-reporting-maven-plugin-6.8 - delete

confluence-reporting:delete

Delete a confluence pageTitle

Mojo Attributes

Since version: 3.4.0

Optional Parameters

Name	Type	Description
attachmentFolder	File	attachment folder Default value is ${basedir}/src/site/confluence/attachments
childrenFolder	File	children folder Default value is ${basedir}/src/site/confluence/children
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:

  
< endPoint>http://your\_confluence-site/rest/api</endPoint>

Default value is http://localhost:8080/rpc/xmlrpc|

failOnError	boolean	Indicates whether the build will continue even if there are clean errors. Default value is true
pageTitle	String	Confluence Page Title Default value is ${project.build.finalName}
parentPageId	String	Confluence parent page id. If set it is possible to avoid specifying parameters spaceKey and parentPageTitle
parentPageTitle	String	Confluence parent page title Default value is Home
password	String	Confluence password
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	boolean	perform recursive deletion Default value is true
scrollVersions	ScrollVersionsConfiguration	ScrollVersions addon configuration. Below the template < scrollVersions> < version>\_version\_name\_</version> // mandatory < /scrollVersions>
serverId	String	Issue 39 Server's `id` in `settings.xml` to look up username and password. Defaults to `${url`} if not given.
siteDescriptor	File	site xml descriptor Default value is ${basedir}/src/site/confluence/site.xml
spaceKey	String	Confluence target confluence spaceKey
sslCertificate	SSLCertificateInfo	if using a https url, configure if the plugin accepts every certifactes or respects hostnameVerifierClass and trustManagerClass (if set). Below the Template < sslCertificate> < ignore>true\|false</ignore> // default false < hostNameVerifierClass>FQN</hostNameVerifierClass> //default null < trustManagerClass>FQN</trustManagerClass> // default null < /sslCertificate>
username	String	Confluence username

Parameter Details

attachmentFolder

attachment folder

Type	java.io.File
Required	No
Default	${basedir}/src/site/confluence/attachments

childrenFolder

children folder

Type	java.io.File
Required	No
Default	${basedir}/src/site/confluence/children

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:

  
< endPoint>http://your\_confluence-site/rest/api</endPoint>

Type	java.lang.String
Required	No
Expression	${confluence.endPoint}
Default	http://localhost:8080/rpc/xmlrpc

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

pageTitle

Confluence Page Title

Type	java.lang.String
Since	3.1.3
Required	No
Expression	${confluence.page}
Default	${project.build.finalName}

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}

parentPageTitle

Confluence parent page title

Type	java.lang.String
Required	No
Expression	${confluence.parentPage}
Default	Home

password

Confluence password

Type	java.lang.String
Required	No
Expression	${confluence.password}

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

recursive

perform recursive deletion

Type	boolean
Since	3.4.0
Required	No
Expression	${recursive}
Default	true

scrollVersions

ScrollVersions addon configuration. Below the template

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

Type	org.bsc.confluence.rest.scrollversions.ScrollVersionsConfiguration
Since	6.5-beta1
Required	No

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}

siteDescriptor

site xml descriptor

Type	java.io.File
Since	3.3.0
Required	No
Default	${basedir}/src/site/confluence/site.xml

spaceKey

Confluence target confluence spaceKey

Type	java.lang.String
Required	No
Expression	${confluence.spaceKey}

sslCertificate

if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).

Below the Template

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

Type	org.bsc.ssl.SSLCertificateInfo
Since	4.1.0
Required	No

username

Confluence username

Type	java.lang.String
Required	No
Expression	${confluence.userName}