jacocotogo:jmx

Full name:

org.helmetsrequired:jacocotogo-maven-plugin:1.0:jmx

Description:

Plugin to allow fetching jacoco data from remote servers where the 'org.jacoco:type=Runtime MBean' is exposed via JMX

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
failOnError boolean - Whether the build should be failed if JaCoCo execution data can not be fetched
Default value is: false.
User property is: jacocotogo.failOnError.
outputFile String - The file to write with the fetched jacoco data
Default value is: ${project.build.directory}/jacocotogo/jacoco.exec.
User property is: jacocotogo.outputFile.
serviceURL String - The serviceURL of the JMX server i.e. 'service:jmx:rmi:///jndi/rmi://myserver.mydomain.com:<portNo>/jmxrmi'
User property is: jacocotogo.serviceURL.

Optional Parameters

Name Type Since Description
password String - The password for the JMX server if authentication is enabled
User property is: jacocotogo.password.
resetAfterFetch boolean - whether to reset the coverage statistics after fetching the jacoco data
Default value is: true.
User property is: jacocotogo.resetAfterFetch.
username String - The username for the JMX server if authentication is enabled
User property is: jacocotogo.username.

Parameter Details

failOnError:

Whether the build should be failed if JaCoCo execution data can not be fetched
  • Type: boolean
  • Required: Yes
  • User Property: jacocotogo.failOnError
  • Default: false

outputFile:

The file to write with the fetched jacoco data
  • Type: java.lang.String
  • Required: Yes
  • User Property: jacocotogo.outputFile
  • Default: ${project.build.directory}/jacocotogo/jacoco.exec

password:

The password for the JMX server if authentication is enabled
  • Type: java.lang.String
  • Required: No
  • User Property: jacocotogo.password

resetAfterFetch:

whether to reset the coverage statistics after fetching the jacoco data
  • Type: boolean
  • Required: No
  • User Property: jacocotogo.resetAfterFetch
  • Default: true

serviceURL:

The serviceURL of the JMX server i.e. 'service:jmx:rmi:///jndi/rmi://myserver.mydomain.com:<portNo>/jmxrmi'
  • Type: java.lang.String
  • Required: Yes
  • User Property: jacocotogo.serviceURL

username:

The username for the JMX server if authentication is enabled
  • Type: java.lang.String
  • Required: No
  • User Property: jacocotogo.username