org.apache.maven.scm.provider.integrity
Class Project

java.lang.Object
  org.apache.maven.scm.provider.integrity.Project

public class Project
extends Object

This class represents a MKS Integrity Configuration Management Project
Provides metadata information about a Project

Since:

1.6

Version:

$Id: Project.java 1.6 2011/08/22 13:06:48EDT Cletus D'Souza (dsouza) Exp $

Author:

Cletus D'Souza

Field Summary

static String	BUILD_PROJECT
static Comparator<Member>	FILES_ORDER
static String	NORMAL_PROJECT
static String	VARIANT_PROJECT

Constructor Summary

Project(APISession api, String configPath)
Creates an instance of an Integrity SCM Project

Method Summary

com.mks.api.response.Response	checkpoint(String message, String tag) Performs a checkpoint on the Integrity SCM Project
com.mks.api.response.Response	createDevPath(String devPath) Creates a Development Path (project branch) for the MKS Integrity SCM Project
String	getConfigurationPath() Returns the Full Configuration Path for this Integrity SCM Project
Date	getLastCheckpointDate() Returns the date when the last checkpoint was performed on this Project
String	getProjectName() Returns the project path for this Integrity SCM Project
String	getProjectRevision() Returns the project revision for this Integrity SCM Project
boolean	isBuild() Returns true if this is a Build Project
boolean	isNormal() Returns true is this is a Normal Project
boolean	isVariant() Returns true if this is a Variant Project
List<Member>	listFiles(String workspaceDir) Parses the output from the si viewproject command to get a list of members
static void	validateTag(String tagName) Checks if the given value is a valid MKS Integrity Label.

Methods inherited from class java.lang.Object

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

Field Detail

NORMAL_PROJECT

public static final String NORMAL_PROJECT

See Also:

Constant Field Values

VARIANT_PROJECT

public static final String VARIANT_PROJECT

See Also:

Constant Field Values

BUILD_PROJECT

public static final String BUILD_PROJECT

See Also:

Constant Field Values

FILES_ORDER

public static final Comparator<Member> FILES_ORDER

Constructor Detail

Project

public Project(APISession api,
               String configPath)
        throws com.mks.api.response.APIException

Creates an instance of an Integrity SCM Project

Parameters:

api - MKS API Session object

configPath - Configuration path for the MKS Integrity SCM Project

Throws:

com.mks.api.response.APIException

Method Detail

validateTag

public static void validateTag(String tagName)
                        throws Exception

Checks if the given value is a valid MKS Integrity Label.
If it's invalid, this method throws an exception providing the reason as string.

Parameters:

tagName - The checkpoint label name

Throws:

Exception

getProjectName

public String getProjectName()

Returns the project path for this Integrity SCM Project

Returns:

getProjectRevision

public String getProjectRevision()

Returns the project revision for this Integrity SCM Project

Returns:

isNormal

public boolean isNormal()

Returns true is this is a Normal Project

Returns:

isVariant

public boolean isVariant()

Returns true if this is a Variant Project

Returns:

isBuild

public boolean isBuild()

Returns true if this is a Build Project

Returns:

getConfigurationPath

public String getConfigurationPath()

Returns the Full Configuration Path for this Integrity SCM Project

Returns:

getLastCheckpointDate

public Date getLastCheckpointDate()

Returns the date when the last checkpoint was performed on this Project

Returns:

listFiles

public List<Member> listFiles(String workspaceDir)
                       throws com.mks.api.response.APIException

Parses the output from the si viewproject command to get a list of members

Parameters:

workspaceDir - The current workspace directory, which is required for an export

Returns:

The list of Member objects for this project

Throws:

com.mks.api.response.APIException

checkpoint

public com.mks.api.response.Response checkpoint(String message,
                                                String tag)
                                         throws com.mks.api.response.APIException

Performs a checkpoint on the Integrity SCM Project

Parameters:

message - Checkpoint description

tag - Checkpoint label

Returns:

MKS API Response object

Throws:

com.mks.api.response.APIException

createDevPath

public com.mks.api.response.Response createDevPath(String devPath)
                                            throws com.mks.api.response.APIException

Creates a Development Path (project branch) for the MKS Integrity SCM Project

Parameters:

devPath - Development Path Name

Returns:

MKS API Response object

Throws:

com.mks.api.response.APIException