de.smartics.maven.plugin.buildmetadata.common
Class ScmInfo

java.lang.Object
  de.smartics.maven.plugin.buildmetadata.common.ScmInfo

public final class ScmInfo
     
     

      
      extends 
      
      Object
     
     

Bundles the SCM information to be passed to meta data providers.

Author:

Robert Reiner

Constructor Summary

ScmInfo(ScmManager scmManager, String connectionType, String scmDateFormat, File basedir, ScmCredentials scmCrendentials, String tagBase, int queryRangeInDays, String buildDatePattern, ScmControl scmControl)
Default constructor.

Method Summary

File	getBasedir() Returns the value for basedir.
String	getBuildDatePattern() Returns the date pattern to use to format the build and revision dates.
String	getConnectionType() Returns the value for connectionType.
int	getQueryRangeInDays() Returns the range of the query in days to fetch change log entries from the SCM.
ScmControl	getScmControl() Returns the information to control the gathering of SCM meta data.
ScmCredentials	getScmCrendentials() Returns the authentication for the SCM server.
String	getScmDateFormat() Returns the value for scmDateFormat.
ScmManager	getScmManager() Returns the manager instance to access the SCM system.
String	getTagBase() Returns the url of tags base directory (used by svn protocol).

Methods inherited from class java.lang.Object

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

Constructor Detail

ScmInfo

public ScmInfo(ScmManager scmManager,
               String connectionType,
               String scmDateFormat,
               File basedir,
               ScmCredentials scmCrendentials,
               String tagBase,
               int queryRangeInDays,
               String buildDatePattern,
               ScmControl scmControl)

Default constructor.

Notes:

This argument list is quite long. The next time we touch this class, we should provide a builder.

Parameters:

scmManager - the manager instance to access the SCM system.

connectionType - the value for connectionType.

scmDateFormat - the value for scmDateFormat.

basedir - the value for basedir.

scmCrendentials - the authentication for the SCM server.

tagBase - the url of tags base directory (used by svn protocol).

queryRangeInDays - the range of the query in days to fetch change log entries from the SCM.

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

scmControl - the information to control the gathering of SCM meta data.

Method Detail

getScmManager

public ScmManager getScmManager()

Returns the manager instance to access the SCM system. Provides access to the repository and the provider information.

Returns:

the manager instance to access the SCM system.

getConnectionType

public String getConnectionType()

Returns the value for connectionType.

Allows the user to choose which scm connection to use when connecting to the scm. Can either be "connection" or "developerConnection".

Returns:

the value for connectionType.

getScmDateFormat

public String getScmDateFormat()

Returns the value for scmDateFormat.

Used to specify the date format of the log entries that are retrieved from your SCM system.

Returns:

the value for scmDateFormat.

getBasedir

public File getBasedir()

Returns the value for basedir.

Input dir. Directory where the files under SCM control are located.

Returns:

the value for basedir.

getScmCrendentials

public ScmCredentials getScmCrendentials()

Returns the authentication for the SCM server.

Returns:

the authentication for the SCM server.

getTagBase

public String getTagBase()

Returns the url of tags base directory (used by svn protocol).

Returns:

the url of tags base directory (used by svn protocol).

getQueryRangeInDays

public int getQueryRangeInDays()

Returns the range of the query in days to fetch change log entries from the SCM. If no change logs have been found, the range is incremented up to 5 times. If no change log has been found after these 5 additional queries, the revision number will not be set with a valid value.

Returns:

the range of the query in days to fetch change log entries from the SCM.

getBuildDatePattern

public String getBuildDatePattern()

Returns the date pattern to use to format the build and revision dates. Please refer to the SimpleDateFormat class for valid patterns.

Returns:

the date pattern to use to format the build and revision dates.

getScmControl

public ScmControl getScmControl()

Returns the information to control the gathering of SCM meta data.

Returns:

the information to control the gathering of SCM meta data.