io.reactiverse.vertx.maven.plugin.utils

Class ScmSpy

java.lang.Object

io.reactiverse.vertx.maven.plugin.utils.ScmSpy

public class ScmSpy
extends Object

A simple SCM utility wrapper, that extracts some SCM related metadata using Apache SCM providers

Author:

kameshs

See Also:

Apache Maven SCM

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.maven.scm.manager.ScmManager	scmManager

Constructor Summary

Constructors

Constructor and Description
ScmSpy(org.apache.maven.scm.manager.ScmManager scmManager)

Method Summary

Modifier and Type	Method and Description
Map<ExtraManifestKeys,String>	getChangeLog(String scmUrl, File workingDir) This method extracts the simple metadata such as revision, lastCommitTimestamp of the commit/hash, author of the commit from the Changelog available in the SCM repository
String	getScmType(String scmUrl) The method that is used to determine the SCM type based on the SCM url pattern

Methods inherited from class java.lang.Object

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

Field Detail

scmManager

private final org.apache.maven.scm.manager.ScmManager scmManager

Constructor Detail

ScmSpy

public ScmSpy(org.apache.maven.scm.manager.ScmManager scmManager)

Method Detail

getScmType

public String getScmType(String scmUrl)
                  throws org.apache.maven.scm.repository.ScmRepositoryException,
                         org.apache.maven.scm.manager.NoSuchScmProviderException

The method that is used to determine the SCM type based on the SCM url pattern

Parameters:

scmUrl - - the SCM url that needs to be parsed to determine the SCM type, the value of url is typically the "connection" or "developerConnection" element value of the maven

Returns:

String - the SCM type, e.g. for git it will be "git" , for subversion it will be "svn"

Throws:

org.apache.maven.scm.repository.ScmRepositoryException - - any SCM related exceptions that might happen when checking the SCM type

org.apache.maven.scm.manager.NoSuchScmProviderException - - if an invalid url is given as part of maven "connection" or "developerConnection"

See Also:

Maven SCM URL Format

getChangeLog

public Map<ExtraManifestKeys,String> getChangeLog(String scmUrl,
                                                  File workingDir)
                                           throws IOException,
                                                  org.apache.maven.scm.ScmException

This method extracts the simple metadata such as revision, lastCommitTimestamp of the commit/hash, author of the commit from the Changelog available in the SCM repository

Parameters:

scmUrl - - the SCM url to get the SCM connection

workingDir - - the Working Copy or Directory of the SCM repo

Returns:

a Map of values extracted form the changelog, with Keys from ExtraManifestKeys

Throws:

IOException - - any error that might occur while manipulating the SCM Changelog

org.apache.maven.scm.ScmException - - other SCM related exceptions