com.redhat.rcm.maven.plugin.buildmetadata.data

Class ScmMetaDataProvider

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

com.redhat.rcm.maven.plugin.buildmetadata.data.AbstractMetaDataProvider

com.redhat.rcm.maven.plugin.buildmetadata.data.ScmMetaDataProvider

All Implemented Interfaces:

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

public class ScmMetaDataProvider
extends AbstractMetaDataProvider

Extracts information from the Maven project, session, and runtime information.

Version:

$Revision:591 $

Author:

Robert Reiner

Field Summary

Fields inherited from class com.redhat.rcm.maven.plugin.buildmetadata.data.AbstractMetaDataProvider

project, runtime, scmInfo, session

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

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

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ScmMetaDataProvider(org.apache.maven.project.MavenProject project, ScmInfo scmInfo) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getConnection() Delegates call to Scm.getConnection().
void	provideBuildMetaData(Properties buildMetaDataProperties) Provides the SCM build information to the property sets if the URL to the SCM is provided.

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

ScmMetaDataProvider

public ScmMetaDataProvider(org.apache.maven.project.MavenProject project,
                   ScmInfo scmInfo)

Constructor.

Parameters:

project - the Maven project.

scmInfo - the value for scmInfo.

See Also:

AbstractMetaDataProvider.AbstractMetaDataProvider()

Method Detail

provideBuildMetaData

public final void provideBuildMetaData(Properties buildMetaDataProperties)

Provides the SCM build information to the property sets if the URL to the SCM is provided.

Parameters:

buildMetaDataProperties - the build meta data properties.

getConnection

protected final String getConnection()
                              throws IllegalStateException

Delegates call to Scm.getConnection().

Returns:

the result of the call to Scm.getConnection().

Throws:

IllegalStateException - when there is insufficient information to return the SCM connection string.

See Also:

Scm.getConnection()