com.redhat.rcm.maven.plugin.buildmetadata

Class AbstractBuildMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AbstractMetaDataProvider, BuildMetaDataMojo, BuildPointMojo, MavenScmRevisionNumberFetcher, RevisionHelper, SdocBuilder

public abstract class AbstractBuildMojo
extends org.apache.maven.plugin.AbstractMojo

Base implementation for all build mojos.

Version:

$Revision: 9143 $

Author:

Robert Reiner

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addToFilters Flag to indicate whether or not the generated properties file should be added to the projects filters.
protected boolean	createManifestFile Flag to choose whether (true) or not (false) the Manifest file should be created.
protected boolean	createPropertiesReport Flag to choose whether (true) or not (false) the build.properties file should be created.
protected boolean	createXmlReport Flag to choose whether (true) or not (false) the XML report should be created.
protected File	manifestFile The location of the Manifest file to add the buildmetadata properties to.
protected String	manifestSection The name of the section within the Manifest file to write the buildmetadata properties to.
protected org.apache.maven.project.MavenProject	project The Maven project.
protected List<Property>	properties The list of a system properties or environment variables to be selected by the user to include into the build meta data properties.
protected File	propertiesOutputFile The name of the properties file to write.
protected List<Provider>	providers The list of meta data providers to launch that contribute to the meta data.
protected String	remoteVersion The branch or tag version on the remote server to compare against.
protected org.apache.maven.execution.RuntimeInformation	runtime The runtime information of the Maven instance being executed for the build.
protected org.apache.maven.execution.MavenSession	session The Maven session instance.
protected SettingsDecrypter	settingsDecrypter Helper to decrypt passwords from the settings handling the location of the settings-security.xml file.
protected boolean	writeProtectFiles Flag to choose whether (true) or not (false) to write protect the generated buildmetadata files.
protected File	xmlOutputFile The name of the XML report file to write.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractBuildMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
org.apache.maven.project.MavenProject	getProject() Returns the Maven project.
boolean	isCreatePropertiesReport() Returns the value for createPropertiesReport.
protected void	provideBuildMetaData(Properties buildMetaDataProperties, ScmInfo scmInfo, List<Provider> providers, boolean runAtEndOfBuild) Adds the information as build properties for each provider.
void	setCreatePropertiesReport(boolean createPropertiesReport) Sets the value for createPropertiesReport.
void	setProject(org.apache.maven.project.MavenProject project) Sets the Maven project.
void	setPropertiesOutputFile(File propertiesOutputFile) Sets the name of the properties file to write.
void	setSession(org.apache.maven.execution.MavenSession session) Sets the Maven session.
protected void	updateMavenEnvironment(Properties buildMetaDataProperties, BuildPropertiesFileHelper helper) Updates the Maven runtime with build properties.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

project

protected org.apache.maven.project.MavenProject project

The Maven project.

Since:

1.0

session

protected org.apache.maven.execution.MavenSession session

The Maven session instance.

runtime

protected org.apache.maven.execution.RuntimeInformation runtime

The runtime information of the Maven instance being executed for the build.

Since:

1.0

propertiesOutputFile

protected File propertiesOutputFile

The name of the properties file to write. Per default this value is overridden by packaging dependent locations. Please refer to activatePropertyOutputFileMapping for details.

Since:

1.0

xmlOutputFile

protected File xmlOutputFile

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.

Since:

1.0

manifestFile

protected File manifestFile

The location of the Manifest file to add the buildmetadata properties to.

Since:

1.5

manifestSection

protected String manifestSection

The name of the section within the Manifest file to write the buildmetadata properties to. Use "Main" to write the the main section.

Since:

1.5

createManifestFile

protected boolean createManifestFile

Flag to choose whether (true) or not (false) the Manifest file should be created.

Since:

1.5

createPropertiesReport

protected boolean createPropertiesReport

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.

Since:

1.2

createXmlReport

protected boolean createXmlReport

Flag to choose whether (true) or not (false) the XML report should be created.

Since:

1.0

writeProtectFiles

protected boolean writeProtectFiles

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.

Since:

1.5

providers

protected List<Provider> providers

The list of meta data providers to launch that contribute to the meta data.

properties

protected List<Property> properties

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.

Since:

1.0

addToFilters

protected boolean addToFilters

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.

Since:

1.0

remoteVersion

protected String remoteVersion

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's SCM URL points to).

Since:

1.4.0

settingsDecrypter

protected SettingsDecrypter settingsDecrypter

Helper to decrypt passwords from the settings handling the location of the settings-security.xml file.

Since:

1.4.0

Constructor Detail

AbstractBuildMojo

public AbstractBuildMojo()

Method Detail

getProject

public final org.apache.maven.project.MavenProject getProject()

Returns the Maven project.

Returns:

the Maven project.

setProject

public final void setProject(org.apache.maven.project.MavenProject project)

Sets the Maven project.

Parameters:

project - the Maven project.

setSession

public final void setSession(org.apache.maven.execution.MavenSession session)

Sets the Maven session.

Used for testing.

Parameters:

session - the Maven session.

setPropertiesOutputFile

public final void setPropertiesOutputFile(File propertiesOutputFile)

Sets the name of the properties file to write.

Used for testing.

Parameters:

propertiesOutputFile - the name of the properties file to write.

isCreatePropertiesReport

public boolean isCreatePropertiesReport()

Returns the value for createPropertiesReport.

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.

Returns:

the value for createPropertiesReport.

setCreatePropertiesReport

public void setCreatePropertiesReport(boolean createPropertiesReport)

Sets the value for createPropertiesReport.

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.

Parameters:

createPropertiesReport - the value for createPropertiesReport.

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

provideBuildMetaData

protected final void provideBuildMetaData(Properties buildMetaDataProperties,
                        ScmInfo scmInfo,
                        List<Provider> providers,
                        boolean runAtEndOfBuild)
                                   throws org.apache.maven.plugin.MojoExecutionException

Adds the information as build properties for each provider.

Parameters:

buildMetaDataProperties - the build meta data properties to add to.

scmInfo - the information for the SCM provided to the build plugin.

providers - the providers to iterate over.

runAtEndOfBuild - checks if the provider is configured to be run at the end of the build. If a provider matches this value, it is run.

Throws:

org.apache.maven.plugin.MojoExecutionException - on any problem running on the providers.

updateMavenEnvironment

protected final void updateMavenEnvironment(Properties buildMetaDataProperties,
                          BuildPropertiesFileHelper helper)
                                     throws org.apache.maven.plugin.MojoExecutionException

Updates the Maven runtime with build properties.

Parameters:

buildMetaDataProperties - the properties to add to the Maven project properties.

helper - the project helper to use.

Throws:

org.apache.maven.plugin.MojoExecutionException - if a requested Manifest file cannot be created.