confluence-reporting:export

Full name:

org.bsc.maven:confluence-reporting-maven-plugin:8.0-beta1:export

Description:

Export a confluence page either in PDF or DOC

Attributes:

  • Since version: 3.4.3.

Optional Parameters

Name Type Since Description
<connectTimeoutInSeconds> long 7.0-beta2 set the confluence service socket connection timeout in seconds
Default value is: 10.
User property is: confluence.timeout.connect.secs.
<endPoint> String 3.4.3 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.
User property is: confluence.endPoint.
<failOnError> boolean 5.0-rc1 Indicates whether the build will continue even if there are clean errors.
Default value is: true.
User property is: confluence.failOnError.
<httpHeaders> Map 3.4.3 Additional HTTP headers for Confluence.
User property is: confluence.httpHeaders.
<outputFile> File 3.4.3 output file - if missing it will be ${project.build.directory}/${title}.${outputType}
Alias is: outputFile.
<outputType> String 3.4.3 type of output - either 'pdf' or 'doc'
Default value is: pdf.
User property is: outputType.
Alias is: outputType.
<pageTitle> String 3.4.3 title of pageTitle that will be deleted
Default value is: ${project.build.finalName}.
User property is: confluence.page.
Alias is: title.
<parentPageId> String 4.10 Confluence parent page id. If set it is possible to avoid specifying parameters spaceKey and parentPageTitle
User property is: confluence.parentPageId.
<parentPageTitle> String 3.4.3 Confluence parent page title
Default value is: Home.
User property is: confluence.parentPage.
<password> String 3.4.3 Confluence password
User property is: confluence.password.
<properties> Map 3.4.3 additional properties pass to template processor Properties in the form of URI will be loaded and loaded value will be used instead, see processProperties
<readTimeoutInSeconds> long 7.0-beta2 set the confluence service socket read timeout in seconds
Default value is: 10.
User property is: confluence.timeout.read.secs.
<scrollVersions> ScrollVersionsInfo 6.5-beta1 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 3.1.1 Issue 39 Server's id in settings.xml to look up username and password. Defaults to ${url} if not given.
User property is: confluence.serverId.
<skip> boolean 5.1 Skip plugin execution
Default value is: false.
<spaceKey> String 3.4.3 Confluence target confluence spaceKey
User property is: confluence.spaceKey.
<sslCertificate> SSLCertificateInfo 4.1.0 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 3.4.3 Confluence username
User property is: confluence.userName.
<writeTimeoutInSeconds> long 7.0-beta2 set the confluence service socket write timeout in seconds
Default value is: 10.
User property is: confluence.timeout.write.secs.

Parameter Details

<connectTimeoutInSeconds>

set the confluence service socket connection timeout in seconds
  • Type: long
  • Since: 7.0-beta2
  • Required: No
  • User Property: confluence.timeout.connect.secs
  • Default: 10

<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
  • Since: 3.4.3
  • Required: No
  • User Property: 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
  • User Property: confluence.failOnError
  • Default: true

<httpHeaders>

Additional HTTP headers for Confluence.
  • Type: java.util.Map
  • Since: 3.4.3
  • Required: No
  • User Property: confluence.httpHeaders

<outputFile>

output file - if missing it will be ${project.build.directory}/${title}.${outputType}
  • Type: java.io.File
  • Since: 3.4.3
  • Required: No
  • Alias: outputFile

<outputType>

type of output - either 'pdf' or 'doc'
  • Type: java.lang.String
  • Since: 3.4.3
  • Required: No
  • User Property: outputType
  • Default: pdf
  • Alias: outputType

<pageTitle>

title of pageTitle that will be deleted
  • Type: java.lang.String
  • Since: 3.4.3
  • Required: No
  • User Property: confluence.page
  • Default: ${project.build.finalName}
  • Alias: title

<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
  • User Property: confluence.parentPageId

<parentPageTitle>

Confluence parent page title
  • Type: java.lang.String
  • Since: 3.4.3
  • Required: No
  • User Property: confluence.parentPage
  • Default: Home

<password>

Confluence password
  • Type: java.lang.String
  • Since: 3.4.3
  • Required: No
  • User Property: 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
  • Since: 3.4.3
  • Required: No

<readTimeoutInSeconds>

set the confluence service socket read timeout in seconds
  • Type: long
  • Since: 7.0-beta2
  • Required: No
  • User Property: confluence.timeout.read.secs
  • Default: 10

<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
  • User Property: confluence.serverId

<skip>

Skip plugin execution
  • Type: boolean
  • Since: 5.1
  • Required: No
  • Default: false

<spaceKey>

Confluence target confluence spaceKey
  • Type: java.lang.String
  • Since: 3.4.3
  • Required: No
  • User Property: 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
  • Since: 3.4.3
  • Required: No
  • User Property: confluence.userName

<writeTimeoutInSeconds>

set the confluence service socket write timeout in seconds
  • Type: long
  • Since: 7.0-beta2
  • Required: No
  • User Property: confluence.timeout.write.secs
  • Default: 10