Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
<?xml version="1.0" encoding="UTF-8"?>

<!-- Generated by maven-plugin-tools 3.2 on 2015-05-06 -->

<plugin>
  <name>buildmetadata-maven-plugin</name>
  <description>This plugin generates build meta data. The final build report is bundled with the artifact in xml format. This allows easy inspection and further processing of the report as required.</description>
  <groupId>com.redhat.rcm.maven.plugin</groupId>
  <artifactId>buildmetadata-maven-plugin</artifactId>
  <version>1.5.2</version>
  <goalPrefix>buildmetadata</goalPrefix>
  <mojos>
    <mojo>
      <goal>build-point</goal>
      <description>Adds the build time to the properties file and runs all providers flagged with Provider.RUN_AT_BUILD_POINT .</description>
      <requiresDirectInvocation>false</requiresDirectInvocation>
      <requiresProject>true</requiresProject>
      <requiresReports>false</requiresReports>
      <aggregator>false</aggregator>
      <requiresOnline>false</requiresOnline>
      <inheritedByDefault>true</inheritedByDefault>
      <phase>prepare-package</phase>
      <implementation>com.redhat.rcm.maven.plugin.buildmetadata.BuildPointMojo</implementation>
      <language>java</language>
      <instantiationStrategy>per-lookup</instantiationStrategy>
      <executionStrategy>once-per-session</executionStrategy>
      <since>1.0</since>
      <threadSafe>true</threadSafe>
      <parameters>
        <parameter>
          <name>activateOutputFileMapping</name>
          <type>boolean</type>
          <since>1.1</since>
          <required>false</required>
          <editable>true</editable>
          <description>Used to activate the default mapping that writes the build properties of deployable units to ${project.build.directory}/${project.build.finalName}/META-INF/build.properties and for standard JAR files to ${project.build.outputDirectory}/META-INF/build.properties.
This property is used for the properties and XML build file.
</description>
        </parameter>
        <parameter>
          <name>addToFilters</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to indicate whether or not the generated properties file should be added to the projects filters.
Filters are only added temporarily (read in-memory during the build) and are not written to the POM.
</description>
        </parameter>
        <parameter>
          <name>createManifestFile</name>
          <type>boolean</type>
          <since>1.5</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to choose whether (true) or not (false) the Manifest file should be created.</description>
        </parameter>
        <parameter>
          <name>createPropertiesReport</name>
          <type>boolean</type>
          <since>1.2</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to choose whether (true) or not (false) the build.properties file should be created.
This will adjust the path of the propertiesOutputFile to ${project.build.directory}/build.properties.
</description>
        </parameter>
        <parameter>
          <name>createXmlReport</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to choose whether (true) or not (false) the XML report should be created.</description>
        </parameter>
        <parameter>
          <name>manifestFile</name>
          <type>java.io.File</type>
          <since>1.5</since>
          <required>false</required>
          <editable>true</editable>
          <description>The location of the Manifest file to add the buildmetadata properties to.</description>
        </parameter>
        <parameter>
          <name>manifestSection</name>
          <type>java.lang.String</type>
          <since>1.5</since>
          <required>false</required>
          <editable>true</editable>
          <description>The name of the section within the Manifest file to write the buildmetadata properties to. Use &apos;Main&apos; to write the the main section.</description>
        </parameter>
        <parameter>
          <name>name</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The name of the build point to append to the duration property name. If blank, the duration property will be stored as build.duration.
This way build durations may be taken from different phases of the build.
</description>
        </parameter>
        <parameter>
          <name>properties</name>
          <type>java.util.List</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The list of a system properties or environment variables to be selected by the user to include into the build meta data properties.
The name is the name of the property, the section is relevant for placing the property in one of the following sections:

-	build.scm
-	build.dateAndVersion
-	build.runtime
-	build.java
-	build.maven
-	project
-	build.misc

If no valid section is given, the property is silently rendered in the build.misc section.
</description>
        </parameter>
        <parameter>
          <name>propertiesOutputFile</name>
          <type>java.io.File</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The name of the properties file to write. Per default this value is overridden by packaging dependent locations. Please refer to activatePropertyOutputFileMapping for details.</description>
        </parameter>
        <parameter>
          <name>propertyOutputFileMapping</name>
          <type>java.util.List</type>
          <since>1.1</since>
          <required>false</required>
          <editable>true</editable>
          <description>Maps a packaging to a location for the build meta data properties file.
This mapping is especially useful for multi projects.
</description>
        </parameter>
        <parameter>
          <name>providers</name>
          <type>java.util.List</type>
          <required>false</required>
          <editable>true</editable>
          <description>The list of meta data providers to launch that contribute to the meta data.</description>
        </parameter>
        <parameter>
          <name>remoteVersion</name>
          <type>java.lang.String</type>
          <since>1.4.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The branch or tag version on the remote server to compare against. If unset, the SCM status will be used to determine the differences.
For SVN, leave it blank. For Git, set the version on the remote server (the project&apos;s SCM URL points to).
</description>
        </parameter>
        <parameter>
          <name>settingsSecurityLocation</name>
          <type>java.lang.String</type>
          <since>1.4.0</since>
          <required>true</required>
          <editable>true</editable>
          <description>The location of the settings-security.xml.</description>
        </parameter>
        <parameter>
          <name>writeProtectFiles</name>
          <type>boolean</type>
          <since>1.5</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to choose whether (true) or not (false) to write protect the generated buildmetadata files. Protecting them allows to projects that copy files from different resources together to not override them by other plugins.</description>
        </parameter>
        <parameter>
          <name>xmlOutputFile</name>
          <type>java.io.File</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The name of the XML report file to write. If you want to include the XML file in the artifact, use ${project.build.outputDirectory}/META-INF/buildmetadata.xml.
The handling is not in an analogous manner as that of the properties file. The reason is this: we want to keep the artifact as small as possible per default. Therefore we include the build.properties and generate the XML report (see property createXmlReport to the target folder (and not inside META-INF). The XML file can be stored to the artifact server (with a couple of other reports) by the use of the projectmetadata-maven-plugin.
</description>
        </parameter>
        <parameter>
          <name>xmlOutputFileMapping</name>
          <type>java.util.List</type>
          <since>1.3</since>
          <required>false</required>
          <editable>true</editable>
          <description>Maps a packaging to a location for the build meta data XML file.
This mapping is especially useful for multi projects.
</description>
        </parameter>
      </parameters>
      <configuration>
        <activateOutputFileMapping implementation="boolean" default-value="true"/>
        <addToFilters implementation="boolean" default-value="true">${buildMetaData.addToFilters}</addToFilters>
        <createManifestFile implementation="boolean" default-value="false"/>
        <createPropertiesReport implementation="boolean" default-value="true"/>
        <createXmlReport implementation="boolean" default-value="true"/>
        <manifestFile implementation="java.io.File" default-value="${project.build.outputDirectory}/META-INF/MANIFEST.MF"/>
        <manifestSection implementation="java.lang.String" default-value="BuildMetaData"/>
        <propertiesOutputFile implementation="java.io.File" default-value="${project.build.outputDirectory}/META-INF/build.properties"/>
        <settingsSecurityLocation implementation="java.lang.String">${user.home}/.m2/settings-security.xml</settingsSecurityLocation>
        <writeProtectFiles implementation="boolean" default-value="false"/>
        <xmlOutputFile implementation="java.io.File" default-value="${project.build.directory}/buildmetadata.xml"/>
      </configuration>
    </mojo>
    <mojo>
      <goal>buildmetadata-report</goal>
      <description>Generates a report about the meta data provided to the build.</description>
      <requiresDirectInvocation>false</requiresDirectInvocation>
      <requiresProject>true</requiresProject>
      <requiresReports>false</requiresReports>
      <aggregator>false</aggregator>
      <requiresOnline>false</requiresOnline>
      <inheritedByDefault>true</inheritedByDefault>
      <phase>site</phase>
      <implementation>com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo</implementation>
      <language>java</language>
      <instantiationStrategy>per-lookup</instantiationStrategy>
      <executionStrategy>once-per-session</executionStrategy>
      <since>1.0</since>
      <threadSafe>true</threadSafe>
      <parameters>
        <parameter>
          <name>activatePropertyOutputFileMapping</name>
          <type>boolean</type>
          <since>1.1</since>
          <required>false</required>
          <editable>true</editable>
          <description>Used to activate the default mapping that writes the build properties of deployable units to ${project.build.directory}/${project.build.finalName}/META-INF/build.properties and for standard JAR files to ${project.build.outputDirectory}/META-INF/build.properties.</description>
        </parameter>
        <parameter>
          <name>createPropertiesReport</name>
          <type>boolean</type>
          <since>1.2</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to choose whether (true) or not (false) the build.properties file should be created.
This will adjust the path of the propertiesOutputFile to ${project.build.directory}/build.properties.

This flag allows the report mojo to behave accordingly to that of the build mojo.
</description>
        </parameter>
        <parameter>
          <name>locale</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The locale to use regardless of the report. This should be set to the locale the Javadoc comment is written in. If not set, the Maven provided locale is used.</description>
        </parameter>
        <parameter>
          <name>logLevel</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Specifies the log level buildmetadata.logLevel used for this plugin.
Allowed values are SEVERE, WARNING, INFO and FINEST.
</description>
        </parameter>
        <parameter>
          <name>properties</name>
          <type>java.util.List</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The list of a system properties or environment variables to be selected by the user to include into the build meta data properties.
The name is the name of the property, the section is relevant for placing the property in one of the following sections:

-	build.scm
-	build.dateAndVersion
-	build.runtime
-	build.java
-	build.maven
-	project
-	build.misc

If no valid section is given, the property is silently rendered in the build.misc section.
</description>
        </parameter>
        <parameter>
          <name>propertiesOutputFile</name>
          <type>java.io.File</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The name of the properties file to write. Per default this value is overridden by packaging dependent locations. Please refer to activatePropertyOutputFileMapping for details.</description>
        </parameter>
        <parameter>
          <name>propertyOutputFileMapping</name>
          <type>java.util.List</type>
          <since>1.1</since>
          <required>false</required>
          <editable>true</editable>
          <description>Maps a packaging to a location for the build meta data properties file.
This mapping is especially useful for multi projects.
</description>
        </parameter>
        <parameter>
          <name>skip</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>A simple flag to skip the generation of the reports. If set on the command line use -Dbuildmetadata.skip.</description>
        </parameter>
      </parameters>
      <configuration>
        <activatePropertyOutputFileMapping implementation="boolean" default-value="true"/>
        <createPropertiesReport implementation="boolean" default-value="true"/>
        <locale implementation="java.lang.String">${buildmetadata.locale}</locale>
        <logLevel implementation="java.lang.String">${buildmetadata.logLevel}</logLevel>
        <propertiesOutputFile implementation="java.io.File" default-value="${project.build.outputDirectory}/META-INF/build.properties"/>
        <skip implementation="boolean" default-value="false">${buildmetadata.skip}</skip>
      </configuration>
    </mojo>
    <mojo>
      <goal>provide-buildmetadata</goal>
      <description>Provides the build properties. This information is also written to a build.properties file.</description>
      <requiresDirectInvocation>false</requiresDirectInvocation>
      <requiresProject>true</requiresProject>
      <requiresReports>false</requiresReports>
      <aggregator>false</aggregator>
      <requiresOnline>false</requiresOnline>
      <inheritedByDefault>true</inheritedByDefault>
      <phase>initialize</phase>
      <implementation>com.redhat.rcm.maven.plugin.buildmetadata.BuildMetaDataMojo</implementation>
      <language>java</language>
      <instantiationStrategy>per-lookup</instantiationStrategy>
      <executionStrategy>once-per-session</executionStrategy>
      <since>1.0</since>
      <threadSafe>true</threadSafe>
      <parameters>
        <parameter>
          <name>activateOutputFileMapping</name>
          <type>boolean</type>
          <since>1.1</since>
          <required>false</required>
          <editable>true</editable>
          <description>Used to activate the default mapping that writes the build properties of deployable units to ${project.build.directory}/${project.build.finalName}/META-INF/build.properties and for standard JAR files to ${project.build.outputDirectory}/META-INF/build.properties.
This property is used for the properties and XML build file.
</description>
        </parameter>
        <parameter>
          <name>addBuildDateToFullVersion</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to add the build date to the full version separated by a &apos;-&apos;. If true the build date is added, if false it is not.</description>
        </parameter>
        <parameter>
          <name>addEnvInfo</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Add environment variables if set to true, skip it, if set to false. If you are not interested in the environment variables of the host (e.g. for security reasons), set this to false.
For security reasons you may want to remove the properties file from the META-INF folder. Please refer to propertiesOutputFile property.
</description>
        </parameter>
        <parameter>
          <name>addHostInfo</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Add host information if set to true, skip it, if set to false. If you are not interested in host information (e.g. for security reasons), set this to false.
For security reasons you may want to remove the properties file from the META-INF folder. Please refer to propertiesOutputFile property.
</description>
        </parameter>
        <parameter>
          <name>addJavaRuntimeInfo</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Add information about the Java runtime running the build if set to true, skip it, if set to false.</description>
        </parameter>
        <parameter>
          <name>addLocallyModifiedTagToFullVersion</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to add the tag -locally-modified to the full version string to make visible that this artifact has been created with locally modified sources. This is often the case while the artifact is built while still working on an issue before it is committed to the SCM repository.</description>
        </parameter>
        <parameter>
          <name>addMavenExecutionInfo</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Add Maven execution information (all properties starting with build.maven.execution, like command line, goals, profiles, etc.) if set to true, skip it, if set to false. If you are not interested in execution information, set this to false.
For security reasons you may want to remove the properties file from the META-INF folder. Please refer to propertiesOutputFile property.
</description>
        </parameter>
        <parameter>
          <name>addOsInfo</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Add information about the operating system the build is run in if set to true, skip it, if set to false.</description>
        </parameter>
        <parameter>
          <name>addProjectInfo</name>
          <type>boolean</type>
          <since>1.1</since>
          <required>false</required>
          <editable>true</editable>
          <description>Add project information (homepage URL, categories, tags, etc.) if set to true, skip it, if set to false. If you are not interested in execution information, set this to false.</description>
        </parameter>
        <parameter>
          <name>addReleaseNumberToFullVersion</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to add the revision number to the full version separated by an &apos;r&apos;. If true the revision number is added, if false it is not.</description>
        </parameter>
        <parameter>
          <name>addScmInfo</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Add SCM information if set to true, skip it, if set to false. If you are not interested in SCM information, set this to false.
For security reasons you may want to remove the properties file from the META-INF folder. Please refer to propertiesOutputFile property.
</description>
        </parameter>
        <parameter>
          <name>addToFilters</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to indicate whether or not the generated properties file should be added to the projects filters.
Filters are only added temporarily (read in-memory during the build) and are not written to the POM.
</description>
        </parameter>
        <parameter>
          <name>addToGeneratedSources</name>
          <type>boolean</type>
          <since>1.5.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to copy build report files to the generated-sources folder, if the Maven sources plugin is configured.</description>
        </parameter>
        <parameter>
          <name>addToLocations</name>
          <type>java.util.List</type>
          <since>1.5.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The list of locations the report files are to be copied to. If it is not absolute, the subfolder META-INF is appended.</description>
        </parameter>
        <parameter>
          <name>basedir</name>
          <type>java.io.File</type>
          <since>1.0</since>
          <required>true</required>
          <editable>true</editable>
          <description>Input dir. Directory where the files under SCM control are located.</description>
        </parameter>
        <parameter>
          <name>buildDatePattern</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The date pattern to use to format the build and revision dates. Please refer to the SimpleDateFormat class for valid patterns.</description>
        </parameter>
        <parameter>
          <name>buildUserPropertyName</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The property to query for the build user.</description>
        </parameter>
        <parameter>
          <name>connectionType</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>true</required>
          <editable>true</editable>
          <description>Allows the user to choose which scm connection to use when connecting to the scm. Can either be &apos;connection&apos; or &apos;developerConnection&apos;.</description>
        </parameter>
        <parameter>
          <name>createManifestFile</name>
          <type>boolean</type>
          <since>1.5</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to choose whether (true) or not (false) the Manifest file should be created.</description>
        </parameter>
        <parameter>
          <name>createPropertiesReport</name>
          <type>boolean</type>
          <since>1.2</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to choose whether (true) or not (false) the build.properties file should be created.
This will adjust the path of the propertiesOutputFile to ${project.build.directory}/build.properties.
</description>
        </parameter>
        <parameter>
          <name>createXmlReport</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to choose whether (true) or not (false) the XML report should be created.</description>
        </parameter>
        <parameter>
          <name>failOnLocalModifications</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to fail if local modifications have been found. The value is true if the build should fail if there are modifications (any files not in-sync with the remote repository), false if the fact is only to be noted in the build properties.</description>
        </parameter>
        <parameter>
          <name>failOnMissingRevision</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Fail if revision is requested to be retrieved, access to SCM is provided, system is online, nothing should prevent the build from fetching the information.
If set to true the build will fail, if revision cannot be fetched under the conditions mentioned above. If set to false the build will continue silently so that the meta data do not contain the revision.
</description>
        </parameter>
        <parameter>
          <name>forceNewProperties</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>If set to true, build properties will be generate even if they already exist in the target folder.</description>
        </parameter>
        <parameter>
          <name>hideCommandLineInfo</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>While the command line may be useful to refer to for a couple of reasons, displaying it with the build properties is a security issue. Some plugins allow to read passwords as properties from the command line and this sensible data will be shown.
Therefore the command line is hidden by default (true). If you want to include this information, use a value of false.
</description>
        </parameter>
        <parameter>
          <name>hideJavaOptsInfo</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>While the JAVA_OPTS may be useful to refer to for a couple of reasons, displaying them with the build properties is a security issue. Some plugins allow to read passwords as properties from the command line and this sensible data will be shown.
Therefore the JAVA_OPTS are hidden by default ( true). If you want to include this information, use a value of false.

This exclusion does not prevent the property from being written as part of addEnvInfo!
</description>
        </parameter>
        <parameter>
          <name>hideMavenOptsInfo</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>While the MAVEN_OPTS may be useful to refer to for a couple of reasons, displaying them with the build properties is a security issue. Some plugins allow to read passwords as properties from the command line and this sensible data will be shown.
Therefore the MAVEN_OPTS are hidden by default ( true). If you want to include this information, use a value of false.

This exclusion does not prevent the property from being written as part of addEnvInfo!
</description>
        </parameter>
        <parameter>
          <name>ignoreDotFilesInBaseDir</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The flag to ignore files and directories starting with a dot for checking modified files. This implicates that any files or directories, starting with a dot, are ignored when the check on changed files is run. If the value is true, dot files are ignored, if it is set to false, dot files are respected.</description>
        </parameter>
        <parameter>
          <name>logLevel</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>Specifies the log level used for this plugin.
Allowed values are SEVERE, WARNING, INFO and FINEST.
</description>
        </parameter>
        <parameter>
          <name>manifestFile</name>
          <type>java.io.File</type>
          <since>1.5</since>
          <required>false</required>
          <editable>true</editable>
          <description>The location of the Manifest file to add the buildmetadata properties to.</description>
        </parameter>
        <parameter>
          <name>manifestSection</name>
          <type>java.lang.String</type>
          <since>1.5</since>
          <required>false</required>
          <editable>true</editable>
          <description>The name of the section within the Manifest file to write the buildmetadata properties to. Use &apos;Main&apos; to write the the main section.</description>
        </parameter>
        <parameter>
          <name>passphrase</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The passphrase (used by java svn).</description>
        </parameter>
        <parameter>
          <name>password</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The user password (used by svn and starteam protocol).</description>
        </parameter>
        <parameter>
          <name>privateKey</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The private key (used by java svn).</description>
        </parameter>
        <parameter>
          <name>properties</name>
          <type>java.util.List</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The list of a system properties or environment variables to be selected by the user to include into the build meta data properties.
The name is the name of the property, the section is relevant for placing the property in one of the following sections:

-	build.scm
-	build.dateAndVersion
-	build.runtime
-	build.java
-	build.maven
-	project
-	build.misc

If no valid section is given, the property is silently rendered in the build.misc section.
</description>
        </parameter>
        <parameter>
          <name>propertiesOutputFile</name>
          <type>java.io.File</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The name of the properties file to write. Per default this value is overridden by packaging dependent locations. Please refer to activatePropertyOutputFileMapping for details.</description>
        </parameter>
        <parameter>
          <name>propertyOutputFileMapping</name>
          <type>java.util.List</type>
          <since>1.1</since>
          <required>false</required>
          <editable>true</editable>
          <description>Maps a packaging to a location for the build meta data properties file.
This mapping is especially useful for multi projects.
</description>
        </parameter>
        <parameter>
          <name>providers</name>
          <type>java.util.List</type>
          <required>false</required>
          <editable>true</editable>
          <description>The list of meta data providers to launch that contribute to the meta data.</description>
        </parameter>
        <parameter>
          <name>queryRangeInDays</name>
          <type>int</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The range of the query in days to fetch change log entries from the SCM. If no change logs have been found, the range is incremented up to DEFAULT_RETRY_COUNT (5) times. If no change log has been found after these DEFAULT_RETRY_COUNT (5) additional queries, the revision number will not be set with a valid value.</description>
        </parameter>
        <parameter>
          <name>remoteVersion</name>
          <type>java.lang.String</type>
          <since>1.4.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The branch or tag version on the remote server to compare against. If unset, the SCM status will be used to determine the differences.
For SVN, leave it blank. For Git, set the version on the remote server (the project&apos;s SCM URL points to).
</description>
        </parameter>
        <parameter>
          <name>scmDateFormat</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>true</required>
          <editable>true</editable>
          <description>Used to specify the date format of the log entries that are retrieved from your SCM system.</description>
        </parameter>
        <parameter>
          <name>settingsSecurityLocation</name>
          <type>java.lang.String</type>
          <since>1.4.0</since>
          <required>true</required>
          <editable>true</editable>
          <description>The location of the settings-security.xml.</description>
        </parameter>
        <parameter>
          <name>skip</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>A simple flag to skip the generation of the build information. If set on the command line use -DbuildMetaData.skip.</description>
        </parameter>
        <parameter>
          <name>tagBase</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The url of tags base directory (used by svn protocol).</description>
        </parameter>
        <parameter>
          <name>userName</name>
          <type>java.lang.String</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The user name (used by svn and starteam protocol).</description>
        </parameter>
        <parameter>
          <name>validateCheckout</name>
          <type>boolean</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>If it should be checked if the local files are up-to-date with the remote files in the SCM repository. If the value is true the result of the check, including the list of changed files, is added to the build meta data.</description>
        </parameter>
        <parameter>
          <name>writeProtectFiles</name>
          <type>boolean</type>
          <since>1.5</since>
          <required>false</required>
          <editable>true</editable>
          <description>Flag to choose whether (true) or not (false) to write protect the generated buildmetadata files. Protecting them allows to projects that copy files from different resources together to not override them by other plugins.</description>
        </parameter>
        <parameter>
          <name>xmlOutputFile</name>
          <type>java.io.File</type>
          <since>1.0</since>
          <required>false</required>
          <editable>true</editable>
          <description>The name of the XML report file to write. If you want to include the XML file in the artifact, use ${project.build.outputDirectory}/META-INF/buildmetadata.xml.
The handling is not in an analogous manner as that of the properties file. The reason is this: we want to keep the artifact as small as possible per default. Therefore we include the build.properties and generate the XML report (see property createXmlReport to the target folder (and not inside META-INF). The XML file can be stored to the artifact server (with a couple of other reports) by the use of the projectmetadata-maven-plugin.
</description>
        </parameter>
        <parameter>
          <name>xmlOutputFileMapping</name>
          <type>java.util.List</type>
          <since>1.3</since>
          <required>false</required>
          <editable>true</editable>
          <description>Maps a packaging to a location for the build meta data XML file.
This mapping is especially useful for multi projects.
</description>
        </parameter>
      </parameters>
      <configuration>
        <activateOutputFileMapping implementation="boolean" default-value="true"/>
        <addBuildDateToFullVersion implementation="boolean" default-value="true">${buildMetaData.addBuildDateToFullVersion}</addBuildDateToFullVersion>
        <addEnvInfo implementation="boolean" default-value="false">${buildMetaData.addEnvInfo}</addEnvInfo>
        <addHostInfo implementation="boolean" default-value="true">${buildMetaData.addHostInfo}</addHostInfo>
        <addJavaRuntimeInfo implementation="boolean" default-value="true">${buildMetaData.addJavaRuntimeInfo}</addJavaRuntimeInfo>
        <addLocallyModifiedTagToFullVersion implementation="boolean" default-value="true">${buildMetaData.addLocallyModifiedTagToFullVersion}</addLocallyModifiedTagToFullVersion>
        <addMavenExecutionInfo implementation="boolean" default-value="true">${buildMetaData.addMavenExecutionInfo}</addMavenExecutionInfo>
        <addOsInfo implementation="boolean" default-value="true">${buildMetaData.addOsInfo}</addOsInfo>
        <addProjectInfo implementation="boolean" default-value="false">${buildMetaData.addProjectInfo}</addProjectInfo>
        <addReleaseNumberToFullVersion implementation="boolean" default-value="true">${buildMetaData.addReleaseNumberToFullVersion}</addReleaseNumberToFullVersion>
        <addScmInfo implementation="boolean" default-value="true">${buildMetaData.addScmInfo}</addScmInfo>
        <addToFilters implementation="boolean" default-value="true">${buildMetaData.addToFilters}</addToFilters>
        <addToGeneratedSources implementation="boolean" default-value="true"/>
        <basedir implementation="java.io.File">${basedir}</basedir>
        <buildDatePattern implementation="java.lang.String" default-value="dd.MM.yyyy">${buildMetaData.buildDate.pattern}</buildDatePattern>
        <buildUserPropertyName implementation="java.lang.String" default-value="username"/>
        <connectionType implementation="java.lang.String" default-value="connection"/>
        <createManifestFile implementation="boolean" default-value="false"/>
        <createPropertiesReport implementation="boolean" default-value="true"/>
        <createXmlReport implementation="boolean" default-value="true"/>
        <failOnLocalModifications implementation="boolean" default-value="false"/>
        <failOnMissingRevision implementation="boolean" default-value="false">${buildMetaData.failOnMissingRevision}</failOnMissingRevision>
        <forceNewProperties implementation="boolean" default-value="false"/>
        <hideCommandLineInfo implementation="boolean" default-value="true">${buildMetaData.hideCommandLineInfo}</hideCommandLineInfo>
        <hideJavaOptsInfo implementation="boolean" default-value="true">${buildMetaData.hideJavaOptsInfo}</hideJavaOptsInfo>
        <hideMavenOptsInfo implementation="boolean" default-value="true">${buildMetaData.hideMavenOptsInfo}</hideMavenOptsInfo>
        <ignoreDotFilesInBaseDir implementation="boolean" default-value="true"/>
        <logLevel implementation="java.lang.String">${buildMetaData.logLevel}</logLevel>
        <manifestFile implementation="java.io.File" default-value="${project.build.outputDirectory}/META-INF/MANIFEST.MF"/>
        <manifestSection implementation="java.lang.String" default-value="BuildMetaData"/>
        <passphrase implementation="java.lang.String">${passphrase}</passphrase>
        <password implementation="java.lang.String">${password}</password>
        <privateKey implementation="java.lang.String">${privateKey}</privateKey>
        <propertiesOutputFile implementation="java.io.File" default-value="${project.build.outputDirectory}/META-INF/build.properties"/>
        <queryRangeInDays implementation="int" default-value="30">${buildMetaData.queryRangeInDays}</queryRangeInDays>
        <scmDateFormat implementation="java.lang.String" default-value="yyyy-MM-dd HH:mm:ss">${changelog.dateFormat}</scmDateFormat>
        <settingsSecurityLocation implementation="java.lang.String">${user.home}/.m2/settings-security.xml</settingsSecurityLocation>
        <skip implementation="boolean" default-value="false">${buildMetaData.skip}</skip>
        <tagBase implementation="java.lang.String">${tagBase}</tagBase>
        <userName implementation="java.lang.String">${username}</userName>
        <validateCheckout implementation="boolean" default-value="true">${buildMetaData.validateCheckout}</validateCheckout>
        <writeProtectFiles implementation="boolean" default-value="false"/>
        <xmlOutputFile implementation="java.io.File" default-value="${project.build.directory}/buildmetadata.xml"/>
      </configuration>
    </mojo>
  </mojos>
</plugin>
New to GrepCode? Check out our FAQ X