com.redhat.rcm.maven.plugin.buildmetadata.scm.maven

Class MavenScmRevisionNumberFetcher

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.MavenScmRevisionNumberFetcher

All Implemented Interfaces:

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

public final class MavenScmRevisionNumberFetcher
extends AbstractBuildMojo
implements RevisionNumberFetcher

Implementation on the Maven SCM implementation to fetch the latest revision number.

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
MavenScmRevisionNumberFetcher(org.apache.maven.scm.manager.ScmManager scmManager, ScmConnectionInfo scmConnectionInfo, ScmAccessInfo scmAccessInfo) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
LocallyModifiedInfo	containsModifications(org.apache.maven.scm.ScmFileSet fileSet) Checks if the local source files are in-sync with the repository or not.
Revision	fetchLatestRevisionNumber() Returns the latest revision number from the SCM.

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

MavenScmRevisionNumberFetcher

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

Default constructor.

Parameters:

scmManager - the SCM manager to access to SCM system.

scmConnectionInfo - the information to connect to the SCM system.

scmAccessInfo - the value for scmAccessInfo.

Method Detail

fetchLatestRevisionNumber

public Revision fetchLatestRevisionNumber()
                                   throws ScmException

Returns the latest revision number from the SCM.

Specified by:

fetchLatestRevisionNumber in interface RevisionNumberFetcher

Returns:

the latest revision number from the SCM, null if none can be found.

Throws:

ScmException - if the revision number cannot be fetched.

containsModifications

public LocallyModifiedInfo containsModifications(org.apache.maven.scm.ScmFileSet fileSet)
                                          throws ScmException

Checks if the local source files are in-sync with the repository or not.

Specified by:

containsModifications in interface RevisionNumberFetcher

Parameters:

fileSet - the file set to check.

Returns:

the status of the files.

Throws:

ScmException - on any problem checking the up-to-date status.