com.atlassian.bamboo.repository.cvsimpl

Class CVSRepository

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.repository.AbstractRepository

com.atlassian.bamboo.repository.AbstractStandaloneRepository

com.atlassian.bamboo.repository.cvsimpl.CVSRepository

All Implemented Interfaces:

ConvertibleFromConfig, InitablePluginModule, AdvancedConfigurationAwareRepository, FilterChangesetAwareRepository, IncludeExcludeAwareRepository, MavenPomAccessorCapableRepository, OnceOffCapableRepository, QuietPeriodAwareRepository, Repository, SelectableAuthenticationRepository, StandaloneRepository, DescriptionProvider, NameProvider, BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, RenderableBuildConfiguration, LegacyRepository, RepositoryV2, Serializable

public class CVSRepository
extends AbstractStandaloneRepository
implements LegacyRepository, SelectableAuthenticationRepository, QuietPeriodAwareRepository, MavenPomAccessorCapableRepository

This class provides a CVS implementation of the Repository interface.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CVSRepository.SymbolicNameType

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILD_MODULE_BRANCH
static String	BUILD_MODULE_TRUNK
static String	COMPLETE_PLUGIN_KEY
static String	CVS_AUTH_TYPE
static String	CVS_BRANCH
static String	CVS_KEY_FILE
static String	CVS_LAST_UPDATE
static String	CVS_MODULE
static String	CVS_PASSPHRASE
static String	CVS_PASSWORD
static String	CVS_QUIET_PERIOD
static String	CVS_ROOT
static String	CVS_VERSION_TYPE
CvsRepositoryManager	cvsRepositoryManager
static String	DATE_FORMAT
static org.apache.commons.lang3.time.FastDateFormat	DEFAULT_LOG_DATE_FORMAT
static String	KEY
static String	NAME
static String	TEMPORARY_CVS_PASSWORD

Fields inherited from class com.atlassian.bamboo.repository.AbstractRepository

administrationConfigurationAccessor, BUILD_TRIGGER_IP, buildDirectoryManager, buildLoggerManager, customVariableContext, featureManager, repositoryModuleDescriptor, templateRenderer, textProvider

Fields inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

moduleDescriptor

Fields inherited from interface com.atlassian.bamboo.repository.Repository

SELECTED_REPOSITORY, UNKNOWN_HOST

Fields inherited from interface com.atlassian.bamboo.repository.IncludeExcludeAwareRepository

FILTER_PATTERN_EXCLUDE, FILTER_PATTERN_INCLUDE, FILTER_PATTERN_NONE, FILTER_PATTERN_OPTION, FILTER_PATTERN_REGEX

Fields inherited from interface com.atlassian.bamboo.repository.FilterChangesetAwareRepository

CHANGESET_FILTER_PATTERN_REGEX, MAVEN_RELEASE_PLUGIN_EXCLUSION_PATTERN

Constructor Summary

Constructors

Constructor and Description
CVSRepository()

Method Summary

Modifier and Type	Method and Description
void	addDefaultValues(BuildConfiguration buildConfiguration) Extension point for adding default values to the form for RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)
BuildRepositoryChanges	collectChangesSinceLastBuild(String planKey, String lastVcsRevisionKey) Gets the code since the link
int	compareTo(Object obj)
boolean	equals(Object o)
List<NameValuePair>	getAuthenticationTypes() List all authentication types supported by repository.
String	getAuthType()
String	getBranchName() Returns branch name exactly as configured in the UI.
String	getCvsRoot()
String	getHost() What's the repository server host
String	getKeyFile()
String	getLocationIdentifier() A string representing the location of the repository
org.apache.commons.lang3.time.FastDateFormat	getLogDateFormat()
CvsRepositoryMavenPomAccessor	getMavenPomAccessor()
int	getMaxRetries() Returns the maximum number of times to collect changes
String	getModule()
String	getName() The display name for the repository type
protected String	getPassphrase()
String	getPassword()
int	getQuietPeriod() Returns the number of seconds to wait between each retry
File	getSourceCodeDirectory(PlanKey planKey) Deprecated. since 3.3
String	getSubstitutedBranchName() Returns branch name with all the variables extrapolated with current values.
String	getSubstitutedCvsRoot()
String	getSubstitutedKeyFile()
CVSRepository.SymbolicNameType	getSymbolicNameType()
String	getUrl()
Collection<NameValuePair>	getVersionTypes()
int	hashCode()
boolean	isQuietPeriodEnabled() Returns true if we were to enable the quiet period
boolean	isRepositoryDifferent(Repository repository) Checks if the current repo is the same as the given repository
boolean	isSshAuthType()
protected boolean	isWorkspaceEmpty(File sourceCodeDirectory)
void	populateFromConfig(org.apache.commons.configuration.HierarchicalConfiguration config) Update the current object with data in the HierarchicalConfiguration
void	prepareConfigObject(BuildConfiguration buildConfiguration) Do any preprocessing work before validation occurs.
String	retrieveSourceCode(BuildContext buildContext, String vcsRevisionKey) Deprecated. since 3.3
protected void	setAuthType(String authType)
void	setBranchName(String branchName)
void	setCvsRepositoryManager(CvsRepositoryManager cvsRepositoryManager)
void	setCvsRoot(String cvsRoot)
void	setLogDateFormat(org.apache.commons.lang3.time.FastDateFormat logDateFormat)
void	setModule(String moduleName)
void	setPassword(String password)
void	setQuietPeriod(int i)
void	setQuietPeriod(String quietPeriod) Defines the quiet period for this build (in seconds)
org.apache.commons.configuration.HierarchicalConfiguration	toConfiguration() Generate a HierarchicalConfiguration from the current state of the object
ErrorCollection	validate(BuildConfiguration buildConfiguration) Ensure we have the been initialised with the mandatory settings

Methods inherited from class com.atlassian.bamboo.repository.AbstractStandaloneRepository

getAdvancedEditHtml, getAdvancedViewHtml, getEditHtml, getViewHtml, getViewHtml

Methods inherited from class com.atlassian.bamboo.repository.AbstractRepository

checkConnection, collectChangesForRevision, customizeBuildRequirements, getAdvancedEditHtml, getAdvancedViewHtml, getBranchIntegrationEditHtml, getChangesetFilterPatternRegex, getDefaultTriggerModule, getDescription, getEditHtml, getFilterFilePatternOption, getFilterFilePatternRegex, getKey, getMavenPomCheckoutAccessEditHtml, getMaxCommitsToReturn, getMinimalEditHtml, getPollingTriggerModule, getShortKey, getSystemWideExclusionPatterns, getViewHtml, getWorkingDirectory, init, isAdvancedOptionEnabled, removeBuildRequirements, setAdministrationConfigurationAccessor, setBuildDirectoryManager, setBuildLoggerManager, setChangesetFilterPatternRegex, setCustomVariableContext, setFeatureManager, setFilterFilePatternOption, setFilterFilePatternRegex, setTemplateRenderer, setTextProvider, setWorkingDir, substituteString, toMergeCapableRepository

Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

populateContextForEdit, populateContextForView

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.repository.Repository

checkConnection, getKey, getMinimalEditHtml, getShortKey

Methods inherited from interface com.atlassian.bamboo.v2.build.ConfigurablePlugin

customizeBuildRequirements, removeBuildRequirements

Methods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin

isConfigurationMissing

Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule

init

Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration

getEditHtml, getViewHtml

Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider

getDescription

Field Detail

DATE_FORMAT

public static final String DATE_FORMAT

See Also:

Constant Field Values

DEFAULT_LOG_DATE_FORMAT

public static final org.apache.commons.lang3.time.FastDateFormat DEFAULT_LOG_DATE_FORMAT

NAME

public static final String NAME

See Also:

Constant Field Values

KEY

public static final String KEY

See Also:

Constant Field Values

COMPLETE_PLUGIN_KEY

public static final String COMPLETE_PLUGIN_KEY

See Also:

Constant Field Values

BUILD_MODULE_TRUNK

public static final String BUILD_MODULE_TRUNK

See Also:

Constant Field Values

BUILD_MODULE_BRANCH

public static final String BUILD_MODULE_BRANCH

See Also:

Constant Field Values

CVS_VERSION_TYPE

public static final String CVS_VERSION_TYPE

See Also:

Constant Field Values

CVS_ROOT

public static final String CVS_ROOT

See Also:

Constant Field Values

CVS_PASSWORD

public static final String CVS_PASSWORD

See Also:

Constant Field Values

CVS_QUIET_PERIOD

public static final String CVS_QUIET_PERIOD

See Also:

Constant Field Values

CVS_MODULE

public static final String CVS_MODULE

See Also:

Constant Field Values

CVS_BRANCH

public static final String CVS_BRANCH

See Also:

Constant Field Values

CVS_AUTH_TYPE

public static final String CVS_AUTH_TYPE

See Also:

Constant Field Values

CVS_KEY_FILE

public static final String CVS_KEY_FILE

See Also:

Constant Field Values

CVS_PASSPHRASE

public static final String CVS_PASSPHRASE

See Also:

Constant Field Values

CVS_LAST_UPDATE

public static final String CVS_LAST_UPDATE

See Also:

Constant Field Values

TEMPORARY_CVS_PASSWORD

public static final String TEMPORARY_CVS_PASSWORD

See Also:

Constant Field Values

cvsRepositoryManager

public transient CvsRepositoryManager cvsRepositoryManager

Constructor Detail

CVSRepository

public CVSRepository()

Method Detail

collectChangesSinceLastBuild

@NotNull
public BuildRepositoryChanges collectChangesSinceLastBuild(@NotNull
                                                                    String planKey,
                                                                    @Nullable
                                                                    String lastVcsRevisionKey)
                                                             throws RepositoryException

Gets the code since the link

Specified by:

collectChangesSinceLastBuild in interface RepositoryV2

Parameters:

planKey -

lastVcsRevisionKey -

Returns:

Throws:

RepositoryException

retrieveSourceCode

@Deprecated
 @NotNull
public String retrieveSourceCode(@NotNull
                                                       BuildContext buildContext,
                                                       @Nullable
                                                       String vcsRevisionKey)
                                                throws RepositoryException

Deprecated. since 3.3

Description copied from interface: LegacyRepository

Checks out the latest source code to an appropriate repository to default source code directory.

Specified by:

retrieveSourceCode in interface LegacyRepository

vcsRevisionKey - - may be null if you want latest code

Returns:

vcsRevisionKey - the revision

Throws:

RepositoryException

isRepositoryDifferent

public boolean isRepositoryDifferent(@NotNull
                                     Repository repository)

Description copied from interface: RepositoryV2

Checks if the current repo is the same as the given repository

Specified by:

isRepositoryDifferent in interface RepositoryV2

Parameters:

repository - to compare against

Returns:

true of repositories are different, false if the same;

isWorkspaceEmpty

protected boolean isWorkspaceEmpty(File sourceCodeDirectory)

Overrides:

isWorkspaceEmpty in class AbstractRepository

getMavenPomAccessor

@NotNull
public CvsRepositoryMavenPomAccessor getMavenPomAccessor()

Specified by:

getMavenPomAccessor in interface MavenPomAccessorCapableRepository

addDefaultValues

public void addDefaultValues(@NotNull
                             BuildConfiguration buildConfiguration)

Description copied from interface: BuildConfigurationAwarePlugin

Extension point for adding default values to the form for RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)

Specified by:

addDefaultValues in interface BuildConfigurationAwarePlugin

Overrides:

addDefaultValues in class AbstractRepository

Parameters:

buildConfiguration - -

prepareConfigObject

public void prepareConfigObject(@NotNull
                                BuildConfiguration buildConfiguration)

Description copied from interface: BuildConfigurationAwarePlugin

Do any preprocessing work before validation occurs. For repository, builder and web repository plugins this will only be called if the plugin is select by the user.

Specified by:

prepareConfigObject in interface BuildConfigurationAwarePlugin

Overrides:

prepareConfigObject in class BaseBuildConfigurationAwarePlugin

Parameters:

buildConfiguration - -

validate

@NotNull
public ErrorCollection validate(@NotNull
                                         BuildConfiguration buildConfiguration)

Ensure we have the been initialised with the mandatory settings

This is called from the build form.

Specified by:

validate in interface BuildConfigurationAwarePlugin

Overrides:

validate in class AbstractRepository

Parameters:

buildConfiguration - -

Returns:

The collection of configuration errors, to be reported back to the GUI

populateFromConfig

public void populateFromConfig(@NotNull
                               org.apache.commons.configuration.HierarchicalConfiguration config)

Description copied from interface: ConvertibleFromConfig

Update the current object with data in the HierarchicalConfiguration

Specified by:

populateFromConfig in interface ConvertibleFromConfig

Overrides:

populateFromConfig in class AbstractRepository

toConfiguration

@NotNull
public org.apache.commons.configuration.HierarchicalConfiguration toConfiguration()

Description copied from interface: ConvertibleFromConfig

Generate a HierarchicalConfiguration from the current state of the object

Specified by:

toConfiguration in interface ConvertibleFromConfig

Overrides:

toConfiguration in class AbstractRepository

Returns:

Always returns an HierarchicalConfiguration. Never null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(Object obj)

getKeyFile

public String getKeyFile()

getSubstitutedKeyFile

public String getSubstitutedKeyFile()

getPassphrase

protected String getPassphrase()

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface SelectableAuthenticationRepository

Returns:

the authentication type for this repository configuration

setAuthType

protected void setAuthType(String authType)

getName

@NotNull
public String getName()

Description copied from interface: Repository

The display name for the repository type

Specified by:

getName in interface Repository

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

getUrl

public String getUrl()

getMaxRetries

public int getMaxRetries()

Description copied from interface: QuietPeriodAwareRepository

Returns the maximum number of times to collect changes

Specified by:

getMaxRetries in interface QuietPeriodAwareRepository

Overrides:

getMaxRetries in class AbstractRepository

Returns:

getSourceCodeDirectory

@NotNull
 @Deprecated
public File getSourceCodeDirectory(@NotNull
                                                         PlanKey planKey)
                                                  throws RepositoryException

Deprecated. since 3.3

CVS checks out the source into the a subdirectory (named after the build) in the working directory

Specified by:

getSourceCodeDirectory in interface RepositoryV2

Overrides:

getSourceCodeDirectory in class AbstractRepository

Parameters:

planKey -

Returns:

The location of the source code files

Throws:

RepositoryException - A generic failure

getModule

public String getModule()

setModule

public void setModule(String moduleName)

getBranchName

public String getBranchName()

Returns branch name exactly as configured in the UI. It means that it can contain unresolved variables. For majority of purposes getSubstitutedBranchName() should be used.

Returns:

branch name as configured in the UI

getSubstitutedBranchName

public String getSubstitutedBranchName()

Returns branch name with all the variables extrapolated with current values.

Returns:

branch name with resolved variables

setBranchName

public void setBranchName(String branchName)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

setQuietPeriod

public void setQuietPeriod(String quietPeriod)

Defines the quiet period for this build (in seconds)

Parameters:

quietPeriod - the number of seconds to wait for more checkins

setQuietPeriod

public void setQuietPeriod(int i)

isQuietPeriodEnabled

public boolean isQuietPeriodEnabled()

Description copied from interface: QuietPeriodAwareRepository

Returns true if we were to enable the quiet period

Specified by:

isQuietPeriodEnabled in interface QuietPeriodAwareRepository

Overrides:

isQuietPeriodEnabled in class AbstractRepository

Returns:

getQuietPeriod

public int getQuietPeriod()

Description copied from interface: QuietPeriodAwareRepository

Returns the number of seconds to wait between each retry

Specified by:

getQuietPeriod in interface QuietPeriodAwareRepository

Overrides:

getQuietPeriod in class AbstractRepository

Returns:

seconds between retries

getCvsRoot

public String getCvsRoot()

getHost

public String getHost()

Description copied from interface: Repository

What's the repository server host

Specified by:

getHost in interface Repository

Returns:

The host!

getLocationIdentifier

@NotNull
public String getLocationIdentifier()

Description copied from interface: Repository

A string representing the location of the repository

Specified by:

getLocationIdentifier in interface Repository

Overrides:

getLocationIdentifier in class AbstractRepository

Returns:

getSubstitutedCvsRoot

public String getSubstitutedCvsRoot()

setCvsRoot

public void setCvsRoot(String cvsRoot)

isSshAuthType

public boolean isSshAuthType()

setCvsRepositoryManager

public void setCvsRepositoryManager(CvsRepositoryManager cvsRepositoryManager)

getAuthenticationTypes

@NotNull
public List<NameValuePair> getAuthenticationTypes()

Description copied from interface: SelectableAuthenticationRepository

List all authentication types supported by repository.

Specified by:

getAuthenticationTypes in interface SelectableAuthenticationRepository

Returns:

List of authentication types supported by repository

getVersionTypes

@NotNull
public Collection<NameValuePair> getVersionTypes()

getLogDateFormat

public org.apache.commons.lang3.time.FastDateFormat getLogDateFormat()

setLogDateFormat

public void setLogDateFormat(org.apache.commons.lang3.time.FastDateFormat logDateFormat)

getSymbolicNameType

public CVSRepository.SymbolicNameType getSymbolicNameType()