com.atlassian.bamboo.vcs.module

Class VcsRepositoryModuleDescriptorImpl

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor<VcsWorkingCopyManager>

com.atlassian.bamboo.vcs.module.VcsRepositoryModuleDescriptorImpl

All Implemented Interfaces:

NameProvider, VcsRepositoryModuleDescriptor, com.atlassian.plugin.ModuleDescriptor<VcsWorkingCopyManager>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware, com.atlassian.plugin.web.descriptors.WeightedDescriptor

public class VcsRepositoryModuleDescriptorImpl
extends AbstractBambooModuleDescriptor<VcsWorkingCopyManager>
implements VcsRepositoryModuleDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOWNLOAD_RESOURCE_TYPE
static String	ICON_RESOURCE

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Fields inherited from interface com.atlassian.bamboo.vcs.module.VcsRepositoryModuleDescriptor

SELECTED_REPOSITORY

Constructor Summary

Constructors

Constructor and Description
VcsRepositoryModuleDescriptorImpl(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
VcsBambooSpecsConfigurator	getBambooSpecsConfigurator()
BambooSpecsHandler	getBambooSpecsHandler()
VcsBranchCreator	getBranchCreator()
VcsBranchDetector	getBranchDetector()
VcsChangeDetector	getChangeDetector()
VcsConnectionTester	getConnectionTester()
String	getDefaultTriggerKey() Default trigger key for this repository If none was set polling trigger key will be returned
String	getDefaultVcsViewerKey() Default web viewer for this repository.
VcsRepositoryDataExporter	getExporter()
String	getIcon() Returns IMAGE (icon) for specific repository.
String	getOptionDescription() Additional description rendered in repository selection UI.
VcsPullRequestDetector	getPullRequestDetector()
VcsTagCreator	getTagCreator()
String	getTooltipKey() Returns TRANSLATION key which is used in tooltips.
String	getTypeString() Returns "type" of vcs to be used for variable generation.
VcsVariableGenerator	getVariableGenerator()
VcsBranchConfigurator	getVcsBranchConfigurator()
VcsBranchDetectionOptionsConfigurator	getVcsBranchDetectionOptionsConfigurator()
VcsChangeDetectionOptionsConfigurator	getVcsChangeDetectionOptionsConfigurator()
VcsLocationConfigurator	getVcsLocationConfigurator()
VcsMavenPomAccessor	getVcsMavenPomAccessor()
int	getWeight()
VcsWorkingCopyManager	getWorkingCopyManager()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
protected boolean	isMutable() Whether modules of this descriptor are supposed to be mutated by external components.
boolean	isPrimary() Marks repository for PRIMARY (in our case Stash & Bitbucket), is used for rendering.
boolean	providesCustomVariables()
boolean	revisionIdsAreUnique() Return true for vcs systems that uses revision ids that can be considered unique.
boolean	supportsBranchCreation()
boolean	supportsBranchDetection()
boolean	supportsImportFromMaven()
boolean	supportsMerging()
boolean	supportsRemoteUpdates()
boolean	supportsTagCreation()
boolean	supportsTestingConnection()

Methods inherited from class com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor

disabled, getElementAsString, getFreeMarkerResourceLocation, getModule, getVelocityResourceLocation, instantiateClass, instantiateSubmodule, postInit, preInit

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, destroy, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isBroken, isEnabled, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.vcs.module.VcsRepositoryModuleDescriptor

supportsPullRequestDetection

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

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

getName

Field Detail

ICON_RESOURCE

public static final String ICON_RESOURCE

See Also:

Constant Field Values

DOWNLOAD_RESOURCE_TYPE

public static final String DOWNLOAD_RESOURCE_TYPE

See Also:

Constant Field Values

Constructor Detail

VcsRepositoryModuleDescriptorImpl

public VcsRepositoryModuleDescriptorImpl(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<VcsWorkingCopyManager>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<VcsWorkingCopyManager>

Throws:

com.atlassian.plugin.PluginParseException

isMutable

protected boolean isMutable()

Description copied from class: AbstractBambooModuleDescriptor

Whether modules of this descriptor are supposed to be mutated by external components. By default this returns true, which means a fresh module instance will be created each time AbstractBambooModuleDescriptor.getModule() is called.

Subclasses that are safe to cache a singleton instance of module throughout the life span of this descriptor can override this method and return false.

Overrides:

isMutable in class AbstractBambooModuleDescriptor<VcsWorkingCopyManager>

Returns:

true if modules of this descriptor are mutable

getVcsLocationConfigurator

@NotNull
public VcsLocationConfigurator getVcsLocationConfigurator()

Specified by:

getVcsLocationConfigurator in interface VcsRepositoryModuleDescriptor

getVcsChangeDetectionOptionsConfigurator

@Nullable
public VcsChangeDetectionOptionsConfigurator getVcsChangeDetectionOptionsConfigurator()

Specified by:

getVcsChangeDetectionOptionsConfigurator in interface VcsRepositoryModuleDescriptor

getVcsBranchDetectionOptionsConfigurator

@Nullable
public VcsBranchDetectionOptionsConfigurator getVcsBranchDetectionOptionsConfigurator()

Specified by:

getVcsBranchDetectionOptionsConfigurator in interface VcsRepositoryModuleDescriptor

getChangeDetector

@NotNull
public VcsChangeDetector getChangeDetector()

Specified by:

getChangeDetector in interface VcsRepositoryModuleDescriptor

getWorkingCopyManager

@NotNull
public VcsWorkingCopyManager getWorkingCopyManager()

Specified by:

getWorkingCopyManager in interface VcsRepositoryModuleDescriptor

getVcsBranchConfigurator

@Nullable
public VcsBranchConfigurator getVcsBranchConfigurator()

Specified by:

getVcsBranchConfigurator in interface VcsRepositoryModuleDescriptor

getBambooSpecsConfigurator

@Nullable
public VcsBambooSpecsConfigurator getBambooSpecsConfigurator()

Specified by:

getBambooSpecsConfigurator in interface VcsRepositoryModuleDescriptor

getBranchDetector

@Nullable
public VcsBranchDetector getBranchDetector()

Specified by:

getBranchDetector in interface VcsRepositoryModuleDescriptor

getPullRequestDetector

@Nullable
public VcsPullRequestDetector getPullRequestDetector()

Specified by:

getPullRequestDetector in interface VcsRepositoryModuleDescriptor

getBranchCreator

@Nullable
public VcsBranchCreator getBranchCreator()

Specified by:

getBranchCreator in interface VcsRepositoryModuleDescriptor

getTagCreator

@Nullable
public VcsTagCreator getTagCreator()

Specified by:

getTagCreator in interface VcsRepositoryModuleDescriptor

getConnectionTester

@Nullable
public VcsConnectionTester getConnectionTester()

Specified by:

getConnectionTester in interface VcsRepositoryModuleDescriptor

getVariableGenerator

@Nullable
public VcsVariableGenerator getVariableGenerator()

Specified by:

getVariableGenerator in interface VcsRepositoryModuleDescriptor

getVcsMavenPomAccessor

@Nullable
public VcsMavenPomAccessor getVcsMavenPomAccessor()

Specified by:

getVcsMavenPomAccessor in interface VcsRepositoryModuleDescriptor

getExporter

@NotNull
public VcsRepositoryDataExporter getExporter()

Specified by:

getExporter in interface VcsRepositoryModuleDescriptor

getBambooSpecsHandler

public BambooSpecsHandler getBambooSpecsHandler()

Specified by:

getBambooSpecsHandler in interface VcsRepositoryModuleDescriptor

getOptionDescription

@Nullable
public String getOptionDescription()

Description copied from interface: VcsRepositoryModuleDescriptor

Additional description rendered in repository selection UI.

Specified by:

getOptionDescription in interface VcsRepositoryModuleDescriptor

getIcon

@Nullable
public String getIcon()

Description copied from interface: VcsRepositoryModuleDescriptor

Returns IMAGE (icon) for specific repository.

Specified by:

getIcon in interface VcsRepositoryModuleDescriptor

Returns:

IMAGE path

getTooltipKey

@Nullable
public String getTooltipKey()

Description copied from interface: VcsRepositoryModuleDescriptor

Returns TRANSLATION key which is used in tooltips.

Specified by:

getTooltipKey in interface VcsRepositoryModuleDescriptor

Returns:

TRANSLATION key

isPrimary

public boolean isPrimary()

Description copied from interface: VcsRepositoryModuleDescriptor

Marks repository for PRIMARY (in our case Stash & Bitbucket), is used for rendering.

Specified by:

isPrimary in interface VcsRepositoryModuleDescriptor

getWeight

public int getWeight()

Specified by:

getWeight in interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

supportsBranchDetection

public boolean supportsBranchDetection()

Specified by:

supportsBranchDetection in interface VcsRepositoryModuleDescriptor

supportsBranchCreation

public boolean supportsBranchCreation()

Specified by:

supportsBranchCreation in interface VcsRepositoryModuleDescriptor

supportsTagCreation

public boolean supportsTagCreation()

Specified by:

supportsTagCreation in interface VcsRepositoryModuleDescriptor

providesCustomVariables

public boolean providesCustomVariables()

Specified by:

providesCustomVariables in interface VcsRepositoryModuleDescriptor

supportsMerging

public boolean supportsMerging()

Specified by:

supportsMerging in interface VcsRepositoryModuleDescriptor

supportsRemoteUpdates

public boolean supportsRemoteUpdates()

Specified by:

supportsRemoteUpdates in interface VcsRepositoryModuleDescriptor

supportsTestingConnection

public boolean supportsTestingConnection()

Specified by:

supportsTestingConnection in interface VcsRepositoryModuleDescriptor

supportsImportFromMaven

public boolean supportsImportFromMaven()

Specified by:

supportsImportFromMaven in interface VcsRepositoryModuleDescriptor

revisionIdsAreUnique

public boolean revisionIdsAreUnique()

Description copied from interface: VcsRepositoryModuleDescriptor

Return true for vcs systems that uses revision ids that can be considered unique. For example Git and Mercurial use hashes that have low collision chance, so it follows that 2 commits with that same revision id are in fact the same commit. Subversion, on the other hand, uses cardinal numbers which are obviously not unique.

Specified by:

revisionIdsAreUnique in interface VcsRepositoryModuleDescriptor

getTypeString

@NotNull
public String getTypeString()

Description copied from interface: VcsRepositoryModuleDescriptor

Returns "type" of vcs to be used for variable generation.

Specified by:

getTypeString in interface VcsRepositoryModuleDescriptor

getDefaultTriggerKey

@NotNull
public String getDefaultTriggerKey()

Description copied from interface: VcsRepositoryModuleDescriptor

Default trigger key for this repository If none was set polling trigger key will be returned

Specified by:

getDefaultTriggerKey in interface VcsRepositoryModuleDescriptor

Returns:

trigger key

getDefaultVcsViewerKey

@NotNull
public String getDefaultVcsViewerKey()

Description copied from interface: VcsRepositoryModuleDescriptor

Default web viewer for this repository.

Specified by:

getDefaultVcsViewerKey in interface VcsRepositoryModuleDescriptor