com.atlassian.bitbucket.commit

Class CommitPropertyProviderModuleDescriptor

java.lang.Object

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

com.atlassian.bitbucket.scm.BaseWeightedModuleDescriptor<CommitPropertyProvider>

com.atlassian.bitbucket.commit.CommitPropertyProviderModuleDescriptor

All Implemented Interfaces:

Weighted, com.atlassian.plugin.ModuleDescriptor<CommitPropertyProvider>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, Comparable<BaseWeightedModuleDescriptor<CommitPropertyProvider>>

Deprecated.

in 8.13.1 for removal in 9.0. See CommitPropertyConfigurationModuleDescriptor for a replacement module descriptor for providing commit properties on commit enrichment.

@Deprecated
public class CommitPropertyProviderModuleDescriptor
extends BaseWeightedModuleDescriptor<CommitPropertyProvider>

Provides an CommitPropertyProvider implementation used by the CommitEnricher.

Usage example:

     <commit-property-provider
              key="gpgCommitPropertyProvider"
              class="bean:gpgSignaturePropertyProvider" />
 

Since:

8.13

Field Summary

Fields

Modifier and Type	Field and Description
static String	XML_ELEMENT_NAME Deprecated.

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

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

Fields inherited from interface com.atlassian.bitbucket.util.Weighted

COMPARABLE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	disabled() Deprecated.
void	enabled() Deprecated.
CommitPropertyProvider	getModule() Deprecated. Retrieve the module for this descriptor.
protected void	provideValidationRules(com.atlassian.plugin.util.validation.ValidationPattern pattern) Deprecated.

Methods inherited from class com.atlassian.bitbucket.scm.BaseWeightedModuleDescriptor

compareTo, getWeight, init

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

getDisplayName, init

Field Detail

XML_ELEMENT_NAME

public static final String XML_ELEMENT_NAME

Deprecated.

See Also:

Constant Field Values

Constructor Detail

CommitPropertyProviderModuleDescriptor

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

Deprecated.

Method Detail

disabled

public void disabled()

Deprecated.

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CommitPropertyProvider>

enabled

public void enabled()

Deprecated.

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CommitPropertyProvider>

getModule

public CommitPropertyProvider getModule()

Deprecated.

Retrieve the module for this descriptor.

The described module is cached for the lifecycle of its plugin. Implementations of CommitPropertyProvider should be stateless and thread-safe as a single instance will be returned to all consumers of the descriptor.

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<CommitPropertyProvider>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CommitPropertyProvider>

Returns:

the processor module being described

provideValidationRules

protected void provideValidationRules(com.atlassian.plugin.util.validation.ValidationPattern pattern)

Deprecated.

Overrides:

provideValidationRules in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CommitPropertyProvider>