hudson.scm

Class IntegrityCMProject

java.lang.Object

hudson.scm.IntegrityCMProject

All Implemented Interfaces:

Serializable

public class IntegrityCMProject
extends Object
implements Serializable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILD_PROJECT
static String	NORMAL_PROJECT
static String	VARIANT_PROJECT

Constructor Summary

Constructors

Constructor and Description
IntegrityCMProject(com.mks.api.response.WorkItem wi, String projectCacheTable) Creates an instance of an Integrity CM Project and extracts all information from the API Response Field

Method Summary

Modifier and Type	Method and Description
com.mks.api.response.Response	addProjectLabel(IntegrityConfigurable serverConf, String chkptLabel, String projectName, String projectRevision) Applies a Project Label on this Integrity CM Project
com.mks.api.response.Response	checkpoint(IntegrityConfigurable integrityConfigurable, String chkptLabel) Performs a checkpoint on this Integrity CM Project
String	getChangeLog(String version, List<Hashtable<CM_PROJECT,Object>> projectMembersList) Returns the Change Log based on the project baseline comparison This assumes that compareBaseline() has been called already
String	getChangeLogforCPMode(String version, Map<IntegrityCMMember.CPInfo,List<IntegrityCMMember.CPMember>> membersInCP)
boolean	getCheckpointBeforeBuild() Returns if the project is checkpointed before the build (configuration parameter)
String	getConfigurationPath() Returns the Full Configuration Path for this Integrity CM Project
Date	getLastCheckpointDate() Returns the date when the last checkpoint was performed on this Project
String	getLineTerminator() Returns the line terminator setting for this project
String	getProjectCacheTable() Returns the cache table name for this project configuration
String	getProjectName() Returns the project path for this Integrity CM Project
String	getProjectRevision() Returns the project revision for this Integrity SCM Project
boolean	getRestoreTimestamp() Returns the restore timestamp setting for this project
boolean	getSkipAuthorInfo() Returns the flag on whether or not to skip author information
String	getVariantName() Returns the variant path name
void	initializeProject(com.mks.api.response.WorkItem wi)
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
void	parseProject(com.mks.api.response.WorkItemIterator workItems) Parses the output from the si viewproject command to get a list of members and updates Derby DB
Set<String>	projectCPDiff(IntegrityConfigurable serverConf, Date pastDate) Performs a projectCPDiff on this Integrity CM Project
void	setCheckpointBeforeBuild(boolean checkpointBeforeBuild) Sets if the project is checkpointed before the build (configuration parameter)
void	setLineTerminator(String lineTerminator) Sets the optional line terminator option for this project
void	setRestoreTimestamp(boolean restoreTimestamp) Sets the optional restore timestamp option for this project
void	setSkipAuthorInfo(boolean skipAuthorInfo) Toggles whether or not to obtain the author using 'si revisioninfo'

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

Constructor Detail

IntegrityCMProject

public IntegrityCMProject(com.mks.api.response.WorkItem wi,
                          String projectCacheTable)

Creates an instance of an Integrity CM Project and extracts all information from the API Response Field

Parameters:

wi - Work Item associated with the response from running si projectinfo

projectCacheTable - SCM cache table name for this project configuration

Method Detail

initializeProject

public void initializeProject(com.mks.api.response.WorkItem wi)

setLineTerminator

public void setLineTerminator(String lineTerminator)

Sets the optional line terminator option for this project

Parameters:

lineTerminator -

getLineTerminator

public String getLineTerminator()

Returns the line terminator setting for this project

Returns:

setRestoreTimestamp

public void setRestoreTimestamp(boolean restoreTimestamp)

Sets the optional restore timestamp option for this project

Parameters:

restoreTimestamp -

getRestoreTimestamp

public boolean getRestoreTimestamp()

Returns the restore timestamp setting for this project

Returns:

setSkipAuthorInfo

public void setSkipAuthorInfo(boolean skipAuthorInfo)

Toggles whether or not to obtain the author using 'si revisioninfo'

Parameters:

skipAuthorInfo -

getSkipAuthorInfo

public boolean getSkipAuthorInfo()

Returns the flag on whether or not to skip author information

Parameters:

skipAuthorInfo -

getChangeLog

public String getChangeLog(String version,
                           List<Hashtable<CM_PROJECT,Object>> projectMembersList)
                    throws DOMException

Returns the Change Log based on the project baseline comparison This assumes that compareBaseline() has been called already

Returns:

Throws:

DOMException

checkpoint

public com.mks.api.response.Response checkpoint(IntegrityConfigurable integrityConfigurable,
                                                String chkptLabel)
                                         throws com.mks.api.response.APIException,
                                                hudson.AbortException

Performs a checkpoint on this Integrity CM Project

Parameters:

integrityConfigurable - Authenticated Integrity API Session

chkptLabel - Checkpoint label string

Returns:

Integrity API Response object

Throws:

com.mks.api.response.APIException

hudson.AbortException

addProjectLabel

public com.mks.api.response.Response addProjectLabel(IntegrityConfigurable serverConf,
                                                     String chkptLabel,
                                                     String projectName,
                                                     String projectRevision)
                                              throws com.mks.api.response.APIException,
                                                     hudson.AbortException

Applies a Project Label on this Integrity CM Project

Parameters:

serverConf - Authenticated Integrity API Session

chkptLabel - Checkpoint label string

Returns:

Integrity API Response object

Throws:

com.mks.api.response.APIException

hudson.AbortException

projectCPDiff

public Set<String> projectCPDiff(IntegrityConfigurable serverConf,
                                 Date pastDate)
                          throws com.mks.api.response.APIException,
                                 hudson.AbortException

Performs a projectCPDiff on this Integrity CM Project

Parameters:

serverConf - Authenticated Integrity API Session

past - Past date

Returns:

Set of closed CPIDs

Throws:

com.mks.api.response.APIException

hudson.AbortException

getProjectName

public String getProjectName()

Returns the project path for this Integrity CM 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 CM Project

Returns:

getLastCheckpointDate

public Date getLastCheckpointDate()

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

Returns:

setCheckpointBeforeBuild

public void setCheckpointBeforeBuild(boolean checkpointBeforeBuild)

Sets if the project is checkpointed before the build (configuration parameter)

Parameters:

checkpointBeforeBuild -

getCheckpointBeforeBuild

public boolean getCheckpointBeforeBuild()

Returns if the project is checkpointed before the build (configuration parameter)

Returns:

getProjectCacheTable

public String getProjectCacheTable()

Returns the cache table name for this project configuration

getVariantName

public String getVariantName()

Returns the variant path name

Returns:

parseProject

public void parseProject(com.mks.api.response.WorkItemIterator workItems)
                  throws com.mks.api.response.APIException,
                         SQLException,
                         InterruptedException,
                         ExecutionException

Parses the output from the si viewproject command to get a list of members and updates Derby DB

Parameters:

workItems - WorkItemIterator

Throws:

com.mks.api.response.APIException

SQLException

InterruptedException

ExecutionException

getChangeLogforCPMode

public String getChangeLogforCPMode(String version,
                                    Map<IntegrityCMMember.CPInfo,List<IntegrityCMMember.CPMember>> membersInCP)