Package com.atlassian.bamboo.repository

Class AbstractRepository

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.repository.AbstractRepository

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractStandaloneRepository

@Deprecated
public abstract class AbstractRepository
extends BaseConfigurablePlugin
implements Repository, IncludeExcludeAwareRepository, QuietPeriodAwareRepository, AdvancedConfigurationAwareRepository, FilterChangesetAwareRepository, OnceOffCapableRepository

Deprecated.

since 5.14 use new repository plugin API instead

This class provides common repository implementation code.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AdministrationConfigurationAccessor	administrationConfigurationAccessor	Deprecated. since 6.8 inject your own
static String	BUILD_TRIGGER_IP	Deprecated.
protected BuildDirectoryManager	buildDirectoryManager	Deprecated. since 6.8 inject your own
protected BuildLoggerManager	buildLoggerManager	Deprecated. since 6.8 inject your own
protected CustomVariableContext	customVariableContext	Deprecated. since 6.8 inject your own
protected FeatureManager	featureManager	Deprecated. since 6.8 inject your own
static String	REPO_PREFIX	Deprecated.
protected RepositoryModuleDescriptorImpl	repositoryModuleDescriptor	Deprecated.
protected TemplateRenderer	templateRenderer	Deprecated. since 6.8 inject your own
protected com.opensymphony.xwork2.TextProvider	textProvider	Deprecated. since 6.8 inject your own

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

moduleDescriptor

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

CHANGESET_FILTER_PATTERN_REGEX, MAVEN_RELEASE_PLUGIN_EXCLUSION_PATTERN

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.Repository

SELECTED_REPOSITORY, UNKNOWN_HOST

Constructor Summary

Constructors

Constructor	Description
AbstractRepository()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addDefaultValues(@NotNull BuildConfiguration buildConfiguration)	Deprecated. 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)
@NotNull ErrorCollection	checkConnection()	Deprecated. This method internally validates the current connection for the repository.
@NotNull BuildRepositoryChanges	collectChangesForRevision(@NotNull PlanKey planKey, @NotNull String targetRevision)	Deprecated. Collects the changes for the targetRevision.
void	customizeBuildRequirements(@NotNull PlanKey planKey, @NotNull BuildConfiguration buildConfiguration, @NotNull RequirementSet requirementSet)	Deprecated. Extension point for adding/customizing requirements when editing a build's builder configuration.
String	getAdvancedEditHtml(@NotNull BuildConfiguration buildConfiguration, @Nullable Plan plan)	Deprecated. since 5.5 use StandaloneRepository.getAdvancedEditHtml(org.apache.commons.configuration.HierarchicalConfiguration)
String	getAdvancedViewHtml(@NotNull Plan plan)	Deprecated. since 5.5 use StandaloneRepository.getAdvancedViewHtml()
@Nullable String	getBranchIntegrationEditHtml()	Deprecated.
String	getChangesetFilterPatternRegex()	Deprecated. The regex expression on which changeset comments are matched for exclusion.
TriggerModuleDescriptor	getDefaultTriggerModule()	Deprecated. since 5.14
String	getDescription()	Deprecated.
@Nullable String	getEditHtml(@NotNull BuildConfiguration buildConfiguration, @Nullable Plan plan)	Deprecated. since 5.5 use StandaloneRepository.getEditHtml(org.apache.commons.configuration.HierarchicalConfiguration)
String	getFilterFilePatternOption()	Deprecated. Do we want to include files which match pattern or exclude files which match pattern?
String	getFilterFilePatternRegex()	Deprecated. The regex expression on which fileName (paths) are matched for inclusion/exclusion.
@NotNull String	getKey()	Deprecated. The full complete plugin key for the repo
@NotNull String	getLocationIdentifier()	Deprecated. A string representing the location of the repository
@Nullable String	getMavenPomCheckoutAccessEditHtml(@NotNull BuildConfiguration buildConfiguration)	Deprecated.
protected int	getMaxCommitsToReturn()	Deprecated.
int	getMaxRetries()	Deprecated. Returns the maximum number of times to collect changes
@Nullable String	getMinimalEditHtml(@NotNull BuildConfiguration buildConfiguration)	Deprecated. Returns HTML for the minimal configuration of the repository.
static TriggerModuleDescriptor	getPollingTriggerModule()	Deprecated. since 5.14
int	getQuietPeriod()	Deprecated. Returns the number of seconds to wait between each retry
@NotNull String	getShortKey()	Deprecated. The mini key from the plugin (should not contain plugin prefix)
@NotNull File	getSourceCodeDirectory(@NotNull PlanKey planKey)	Deprecated. For Subversion, we use the build name's directory within the system's working directory
Collection<String>	getSystemWideExclusionPatterns()	Deprecated. Collection of system wide, hardcoded changeset filtering patterns
@Nullable String	getViewHtml(@NotNull Plan plan)	Deprecated. since 5.5 use StandaloneRepository.getViewHtml()
File	getWorkingDirectory()	Deprecated.
void	init(@NotNull com.atlassian.plugin.ModuleDescriptor moduleDescriptor)	Deprecated. Initialises the Plugin with the plugin module descriptor
boolean	isAdvancedOptionEnabled(@NotNull BuildConfiguration buildConfiguration)	Deprecated.
boolean	isQuietPeriodEnabled()	Deprecated. Returns true if we were to enable the quiet period
protected boolean	isWorkspaceEmpty(File sourceCodeDirectory)	Deprecated.
void	populateFromConfig(@NotNull org.apache.commons.configuration.HierarchicalConfiguration config)	Deprecated. Update the current object with data in the HierarchicalConfiguration
void	removeBuildRequirements(@NotNull PlanKey planKey, @NotNull BuildConfiguration buildConfiguration, @NotNull RequirementSet requirementSet)	Deprecated. Extension point for removing requirements when given plugin is excluded from build's builder configuration.
void	setAdministrationConfigurationAccessor(AdministrationConfigurationAccessor administrationConfigurationAccessor)	Deprecated.
void	setBuildDirectoryManager(BuildDirectoryManager buildDirectoryManager)	Deprecated.
void	setBuildLoggerManager(BuildLoggerManager buildLoggerManager)	Deprecated.
void	setChangesetFilterPatternRegex(String changesetFilterPatternRegex)	Deprecated.
void	setCustomVariableContext(CustomVariableContext customVariableContext)	Deprecated.
void	setFeatureManager(FeatureManager featureManager)	Deprecated.
void	setFilterFilePatternOption(String filterFilePatternOption)	Deprecated.
void	setFilterFilePatternRegex(String filterFilePatternRegex)	Deprecated.
void	setTemplateRenderer(TemplateRenderer templateRenderer)	Deprecated. since 6.8 use constructor injection or annotation injection
void	setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)	Deprecated.
void	setWorkingDir(File workingDir)	Deprecated.
protected String	substituteString(@Nullable String stringWithValuesToSubstitute)	Deprecated.
@NotNull org.apache.commons.configuration.HierarchicalConfiguration	toConfiguration()	Deprecated. Generate a HierarchicalConfiguration from the current state of the object
static @Nullable BranchMergingAwareRepository	toMergeCapableRepository(@Nullable RepositoryV2 defaultRepository)	Deprecated.
@NotNull ErrorCollection	validate(@NotNull BuildConfiguration buildConfiguration)	Deprecated. Validates the properties in the BuildConfiguration object.

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

getTemplateRenderer, populateContextForEdit, populateContextForView, prepareConfigObject

Methods inherited from class java.lang.Object

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

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

isConfigurationMissing, prepareConfigObject

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

getHost, getName

Methods inherited from interface com.atlassian.bamboo.v2.build.repository.RepositoryV2

collectChangesSinceLastBuild, isRepositoryDifferent

Field Detail

REPO_PREFIX

public static final String REPO_PREFIX

Deprecated.

See Also:

Constant Field Values

BUILD_TRIGGER_IP

public static final String BUILD_TRIGGER_IP

Deprecated.

See Also:

Constant Field Values

repositoryModuleDescriptor

protected RepositoryModuleDescriptorImpl repositoryModuleDescriptor

Deprecated.

templateRenderer

@Deprecated
protected transient TemplateRenderer templateRenderer

Deprecated.

since 6.8 inject your own

textProvider

@Deprecated
protected transient com.opensymphony.xwork2.TextProvider textProvider

Deprecated.

since 6.8 inject your own

buildLoggerManager

@Deprecated
protected transient BuildLoggerManager buildLoggerManager

Deprecated.

since 6.8 inject your own

buildDirectoryManager

@Deprecated
protected transient BuildDirectoryManager buildDirectoryManager

Deprecated.

since 6.8 inject your own

customVariableContext

@Deprecated
protected transient CustomVariableContext customVariableContext

Deprecated.

since 6.8 inject your own

featureManager

@Deprecated
protected transient FeatureManager featureManager

Deprecated.

since 6.8 inject your own

administrationConfigurationAccessor

@Deprecated
protected transient AdministrationConfigurationAccessor administrationConfigurationAccessor

Deprecated.

since 6.8 inject your own

Constructor Detail

AbstractRepository

public AbstractRepository()

Deprecated.

Method Detail

init

public void init(@NotNull
                 @NotNull com.atlassian.plugin.ModuleDescriptor moduleDescriptor)

Deprecated.

Description copied from interface: InitablePluginModule

Initialises the Plugin with the plugin module descriptor

Specified by:

init in interface InitablePluginModule

Overrides:

init in class BaseBuildConfigurationAwarePlugin

Parameters:

moduleDescriptor - Plugin module descriptor

getKey

@NotNull
public @NotNull String getKey()

Deprecated.

Description copied from interface: Repository

The full complete plugin key for the repo

Specified by:

getKey in interface Repository

Returns:

getShortKey

@NotNull
public @NotNull String getShortKey()

Deprecated.

Description copied from interface: Repository

The mini key from the plugin (should not contain plugin prefix)

Specified by:

getShortKey in interface Repository

Returns:

getLocationIdentifier

@NotNull
public @NotNull String getLocationIdentifier()

Deprecated.

Description copied from interface: Repository

A string representing the location of the repository

Specified by:

getLocationIdentifier in interface Repository

Returns:

getDescription

public String getDescription()

Deprecated.

Specified by:

getDescription in interface DescriptionProvider

addDefaultValues

public void addDefaultValues(@NotNull
                             @NotNull BuildConfiguration buildConfiguration)

Deprecated.

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 BaseBuildConfigurationAwarePlugin

Parameters:

buildConfiguration - -

customizeBuildRequirements

public void customizeBuildRequirements(@NotNull
                                       @NotNull PlanKey planKey,
                                       @NotNull
                                       @NotNull BuildConfiguration buildConfiguration,
                                       @NotNull
                                       @NotNull RequirementSet requirementSet)

Deprecated.

Description copied from interface: ConfigurablePlugin

Extension point for adding/customizing requirements when editing a build's builder configuration.

Specified by:

customizeBuildRequirements in interface ConfigurablePlugin

Overrides:

customizeBuildRequirements in class BaseConfigurablePlugin

Parameters:

planKey - key of Plan for which requirements has to be removed.

buildConfiguration - source of information for customizing build requirements

requirementSet - requirements to be customized

removeBuildRequirements

public void removeBuildRequirements(@NotNull
                                    @NotNull PlanKey planKey,
                                    @NotNull
                                    @NotNull BuildConfiguration buildConfiguration,
                                    @NotNull
                                    @NotNull RequirementSet requirementSet)

Deprecated.

Description copied from interface: ConfigurablePlugin

Extension point for removing requirements when given plugin is excluded from build's builder configuration.

Specified by:

removeBuildRequirements in interface ConfigurablePlugin

Overrides:

removeBuildRequirements in class BaseConfigurablePlugin

Parameters:

planKey - key of Plan for which requirements has to be removed.

buildConfiguration - source of information for customizing build requirements

requirementSet - requirements to be customized

getMaxCommitsToReturn

protected int getMaxCommitsToReturn()

Deprecated.

collectChangesForRevision

@NotNull
public @NotNull BuildRepositoryChanges collectChangesForRevision(@NotNull
                                                                 @NotNull PlanKey planKey,
                                                                 @NotNull
                                                                 @NotNull String targetRevision)
                                                          throws RepositoryException

Deprecated.

Description copied from interface: OnceOffCapableRepository

Collects the changes for the targetRevision. This method is called only on server side (never on agent).

Specified by:

collectChangesForRevision in interface OnceOffCapableRepository

Returns:

A build changes object with the appropriate build changes (that is - with the single commit data relevant for targetRevision)

Throws:

RepositoryException - if something goes wrong

getViewHtml

@Nullable
@Deprecated
public @Nullable String getViewHtml(@NotNull
                                    @NotNull Plan plan)

Deprecated.

since 5.5 use StandaloneRepository.getViewHtml()

Description copied from interface: RenderableBuildConfiguration

Returns the HTML that represents the view of the repository configuration

Specified by:

getViewHtml in interface RenderableBuildConfiguration

Overrides:

getViewHtml in class BaseBuildConfigurationAwarePlugin

Parameters:

plan - for which view HTML has to be rendered.

Returns:

HTML string. May be null.

getEditHtml

@Nullable
@Deprecated
public @Nullable String getEditHtml(@NotNull
                                    @NotNull BuildConfiguration buildConfiguration,
                                    @Nullable
                                    @Nullable Plan plan)

Deprecated.

since 5.5 use StandaloneRepository.getEditHtml(org.apache.commons.configuration.HierarchicalConfiguration)

Description copied from interface: RenderableBuildConfiguration

Returns HTML that represents the form fragment for editing the repository. No opening and closing form tags are required.

Specified by:

getEditHtml in interface RenderableBuildConfiguration

Overrides:

getEditHtml in class BaseBuildConfigurationAwarePlugin

Parameters:

buildConfiguration - BuildConfiguration for which edit HTML has to be rendered.

plan - Plan for which edit HTML has to be rendered. May be null during creation phase of plan.

Returns:

HTML string. May be null.

getMinimalEditHtml

@Nullable
public @Nullable String getMinimalEditHtml(@NotNull
                                           @NotNull BuildConfiguration buildConfiguration)

Deprecated.

Description copied from interface: Repository

Returns HTML for the minimal configuration of the repository. i.e. the basic config required to get it working.

Specified by:

getMinimalEditHtml in interface Repository

Parameters:

buildConfiguration - BuildConfiguration object

Returns:

HTML for the minimal configuration of the repository

getAdvancedViewHtml

@Deprecated
public String getAdvancedViewHtml(@NotNull
                                  @NotNull Plan plan)

Deprecated.

since 5.5 use StandaloneRepository.getAdvancedViewHtml()

Specified by:

getAdvancedViewHtml in interface AdvancedConfigurationAwareRepository

getAdvancedEditHtml

@Deprecated
public String getAdvancedEditHtml(@NotNull
                                  @NotNull BuildConfiguration buildConfiguration,
                                  @Nullable
                                  @Nullable Plan plan)

Deprecated.

since 5.5 use StandaloneRepository.getAdvancedEditHtml(org.apache.commons.configuration.HierarchicalConfiguration)

Specified by:

getAdvancedEditHtml in interface AdvancedConfigurationAwareRepository

getMavenPomCheckoutAccessEditHtml

@Nullable
public @Nullable String getMavenPomCheckoutAccessEditHtml(@NotNull
                                                          @NotNull BuildConfiguration buildConfiguration)

Deprecated.

getBranchIntegrationEditHtml

@Nullable
public @Nullable String getBranchIntegrationEditHtml()

Deprecated.

validate

@NotNull
public @NotNull ErrorCollection validate(@NotNull
                                         @NotNull BuildConfiguration buildConfiguration)

Deprecated.

Description copied from interface: BuildConfigurationAwarePlugin

Validates the properties in the BuildConfiguration object. The name of the properties match those passed in through the form fragments in RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan) template.

Specified by:

validate in interface BuildConfigurationAwarePlugin

Overrides:

validate in class BaseBuildConfigurationAwarePlugin

Parameters:

buildConfiguration - -

Returns:

ErrorCollection keyed by the field name.

populateFromConfig

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

Deprecated.

Description copied from interface: ConvertibleFromConfig

Update the current object with data in the HierarchicalConfiguration

Specified by:

populateFromConfig in interface ConvertibleFromConfig

toConfiguration

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

Deprecated.

Description copied from interface: ConvertibleFromConfig

Generate a HierarchicalConfiguration from the current state of the object

Specified by:

toConfiguration in interface ConvertibleFromConfig

Returns:

Always returns an HierarchicalConfiguration. Never null

isQuietPeriodEnabled

public boolean isQuietPeriodEnabled()

Deprecated.

Description copied from interface: QuietPeriodAwareRepository

Returns true if we were to enable the quiet period

Specified by:

isQuietPeriodEnabled in interface QuietPeriodAwareRepository

Returns:

getQuietPeriod

public int getQuietPeriod()

Deprecated.

Description copied from interface: QuietPeriodAwareRepository

Returns the number of seconds to wait between each retry

Specified by:

getQuietPeriod in interface QuietPeriodAwareRepository

Returns:

seconds between retries

getMaxRetries

public int getMaxRetries()

Deprecated.

Description copied from interface: QuietPeriodAwareRepository

Returns the maximum number of times to collect changes

Specified by:

getMaxRetries in interface QuietPeriodAwareRepository

Returns:

isAdvancedOptionEnabled

public boolean isAdvancedOptionEnabled(@NotNull
                                       @NotNull BuildConfiguration buildConfiguration)

Deprecated.

setWorkingDir

public void setWorkingDir(File workingDir)

Deprecated.

getWorkingDirectory

public File getWorkingDirectory()

Deprecated.

getSourceCodeDirectory

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

Deprecated.

For Subversion, we use the build name's directory within the system's working directory

Specified by:

getSourceCodeDirectory in interface RepositoryV2

Parameters:

planKey - Plan key

Returns:

the source code directory

Throws:

RepositoryException - A generic failure

checkConnection

@NotNull
public @NotNull ErrorCollection checkConnection()

Deprecated.

Description copied from interface: Repository

This method internally validates the current connection for the repository. Usually the same as running validate

Specified by:

checkConnection in interface Repository

Returns:

ErrorCollection must not be null. The errors should be translated to error messages, rather than field errors.

substituteString

protected String substituteString(@Nullable
                                  @Nullable String stringWithValuesToSubstitute)

Deprecated.

setTextProvider

public void setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)

Deprecated.

setTemplateRenderer

@Deprecated
public void setTemplateRenderer(TemplateRenderer templateRenderer)

Deprecated.

since 6.8 use constructor injection or annotation injection

Overrides:

setTemplateRenderer in class BaseBuildConfigurationAwarePlugin

getFilterFilePatternOption

public String getFilterFilePatternOption()

Deprecated.

Description copied from interface: IncludeExcludeAwareRepository

Do we want to include files which match pattern or exclude files which match pattern?

Specified by:

getFilterFilePatternOption in interface IncludeExcludeAwareRepository

Returns:

setFilterFilePatternOption

public void setFilterFilePatternOption(String filterFilePatternOption)

Deprecated.

getFilterFilePatternRegex

public String getFilterFilePatternRegex()

Deprecated.

Description copied from interface: IncludeExcludeAwareRepository

The regex expression on which fileName (paths) are matched for inclusion/exclusion.

Specified by:

getFilterFilePatternRegex in interface IncludeExcludeAwareRepository

Returns:

setFilterFilePatternRegex

public void setFilterFilePatternRegex(String filterFilePatternRegex)

Deprecated.

getChangesetFilterPatternRegex

public String getChangesetFilterPatternRegex()

Deprecated.

Description copied from interface: FilterChangesetAwareRepository

The regex expression on which changeset comments are matched for exclusion.

Specified by:

getChangesetFilterPatternRegex in interface FilterChangesetAwareRepository

Returns:

setChangesetFilterPatternRegex

public void setChangesetFilterPatternRegex(String changesetFilterPatternRegex)

Deprecated.

getSystemWideExclusionPatterns

public Collection<String> getSystemWideExclusionPatterns()

Deprecated.

Description copied from interface: FilterChangesetAwareRepository

Collection of system wide, hardcoded changeset filtering patterns

Specified by:

getSystemWideExclusionPatterns in interface FilterChangesetAwareRepository

Returns:

setBuildLoggerManager

public void setBuildLoggerManager(BuildLoggerManager buildLoggerManager)

Deprecated.

setBuildDirectoryManager

public void setBuildDirectoryManager(BuildDirectoryManager buildDirectoryManager)

Deprecated.

isWorkspaceEmpty

protected boolean isWorkspaceEmpty(File sourceCodeDirectory)

Deprecated.

setCustomVariableContext

public void setCustomVariableContext(CustomVariableContext customVariableContext)

Deprecated.

setFeatureManager

public void setFeatureManager(FeatureManager featureManager)

Deprecated.

setAdministrationConfigurationAccessor

public void setAdministrationConfigurationAccessor(AdministrationConfigurationAccessor administrationConfigurationAccessor)

Deprecated.

toMergeCapableRepository

@Nullable
public static @Nullable BranchMergingAwareRepository toMergeCapableRepository(@Nullable
                                                                              @Nullable RepositoryV2 defaultRepository)

Deprecated.

getPollingTriggerModule

@Deprecated
public static TriggerModuleDescriptor getPollingTriggerModule()

Deprecated.

since 5.14

getDefaultTriggerModule

@Deprecated
public TriggerModuleDescriptor getDefaultTriggerModule()

Deprecated.

since 5.14