com.redhat.rcm.maven.plugin.buildmetadata.common

Class RevisionHelper

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

com.redhat.rcm.maven.plugin.buildmetadata.common.RevisionHelper

All Implemented Interfaces:

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

public final class RevisionHelper
extends AbstractBuildMojo

Helper to access the revision information.

Version:

$Revision:591 $

Author:

Robert Reiner

Field Summary

Fields inherited from class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

addToFilters, createManifestFile, createPropertiesReport, createXmlReport, manifestFile, manifestSection, project, properties, propertiesOutputFile, providers, remoteVersion, runtime, session, settingsDecrypter, writeProtectFiles, xmlOutputFile

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

ROLE

Constructor Summary

Constructors

Constructor and Description
RevisionHelper(org.apache.maven.scm.manager.ScmManager scmManager, ScmConnectionInfo scmConnectionInfo, ScmAccessInfo scmAccessInfo, String buildDatePattern) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	provideScmBuildInfo(Properties buildMetaDataProperties, ScmControl scmControl) Fetches the revision information and adds it to the property sets.

Methods inherited from class com.redhat.rcm.maven.plugin.buildmetadata.AbstractBuildMojo

execute, getProject, isCreatePropertiesReport, provideBuildMetaData, setCreatePropertiesReport, setProject, setPropertiesOutputFile, setSession, updateMavenEnvironment

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

Constructor Detail

RevisionHelper

public RevisionHelper(org.apache.maven.scm.manager.ScmManager scmManager,
              ScmConnectionInfo scmConnectionInfo,
              ScmAccessInfo scmAccessInfo,
              String buildDatePattern)

Default constructor.

Parameters:

scmManager - the manager instance to access the SCM system.

scmConnectionInfo - the information to connect to the SCM.

scmAccessInfo - the information to query the SCM.

buildDatePattern - the date pattern to use to format revision dates.

Method Detail

provideScmBuildInfo

public void provideScmBuildInfo(Properties buildMetaDataProperties,
                       ScmControl scmControl)
                         throws ScmException

Fetches the revision information and adds it to the property sets.

Parameters:

buildMetaDataProperties - the build meta data properties.

scmControl - the properties to control the gathering of SCM info.

Throws:

ScmException - if the creation of the SCM information failed.