confluence-reporting-maven-plugin-5.0-rc2 - export

confluence-reporting:export

Export a confluence page either in PDF or DOC

Mojo Attributes

  • Since version: 3.4.3

Optional Parameters

Name Type Description
endPoint String Confluence end point url 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
outputFile File output file - if missing it will be ${project.build.directory}/${title}.${outputType}
outputType String type of output - either 'pdf' or 'doc' Default value is pdf
pageTitle String title of pageTitle that will be deleted 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
serverId String Issue 39
Server's id in settings.xml to look up username and password.
Defaults to ${url} if not given.
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

endPoint

Confluence end point url

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
outputFile

output file - if missing it will be ${project.build.directory}/${title}.${outputType}

Type java.io.File
Since 3.4.3
Required No
outputType

type of output - either 'pdf' or 'doc'

Type java.lang.String
Since 3.4.3
Required No
Expression ${outputType}
Default pdf
pageTitle

title of pageTitle that will be deleted

Type java.lang.String
Since 3.4.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

Type java.util.Map
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}
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}
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.