confluence-reporting-maven-plugin-7.0-SNAPSHOT - 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 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
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 Properties in the form of URI will be loaded and loaded value will be used instead, see processProperties
scrollVersions	ScrollVersionsInfo	ScrollVersions addon configuration. Below the template <scrollVersions> <version>version name</version> <!-- mandatory --> <skip>true\|false</skip> <!-- optional, default false (since 6.9-rc2) -->\* </scrollVersions>
serverId	String	Issue 39 Server's `id` in `settings.xml` to look up username and password. Defaults to `${url`} if not given.
skip	boolean	Skip plugin execution Default value is false
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 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

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
Properties in the form of URI will be loaded and loaded value will be used instead, see processProperties

Type	java.util.Map
Required	No

scrollVersions

ScrollVersions addon configuration. Below the template

<scrollVersions>
 <version>version name</version>  <!-- mandatory -->
 <skip>true|false</skip>  <!-- optional, default false (since 6.9-rc2) -->\*
</scrollVersions>

Type	org.bsc.mojo.configuration.ScrollVersionsInfo
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}

skip

Skip plugin execution

Type	boolean
Since	5.1
Required	No
Default	false

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}