com.atlassian.bitbucket.scm

Class ScmRequestCheckModuleDescriptor

java.lang.Object

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

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

com.atlassian.bitbucket.scm.ScmRequestCheckModuleDescriptor

All Implemented Interfaces:

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

public class ScmRequestCheckModuleDescriptor
extends BaseWeightedModuleDescriptor<ScmRequestCheck>

Provides an ScmRequestCheck implementation used by the ScmRequestCheckService.

Usage example:

     <scm-request-check
              key="throttleCheck"
              class="com.atlassian.bitbucket.internal.scm.check.ThrottleCheck"
              weight="20" />
 

The (optional) weight attribute defines the order in which ScmRequestCheck implementations will be queried. Lower weights are queried earlier and the default weight is 10. If an earlier ScmRequestCheck vetoes an ScmRequest subsequent checks will not be called.

Field Summary

Fields

Modifier and Type	Field and Description
static String	XML_ELEMENT_NAME

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

Modifier	Constructor and Description
protected	ScmRequestCheckModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
ScmRequestCheck	getModule()
protected void	provideValidationRules(com.atlassian.plugin.util.validation.ValidationPattern pattern)

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

compareTo, getWeight, init

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

assertModuleClassImplements, checkPermissions, destroy, disabled, enabled, 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

See Also:

Constant Field Values

Constructor Detail

ScmRequestCheckModuleDescriptor

protected ScmRequestCheckModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

provideValidationRules

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

Overrides:

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

getModule

public ScmRequestCheck getModule()

Specified by:

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

Specified by:

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