Package com.atlassian.bitbucket.scm

Class ScmProtocolModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<ScmProtocol>
com.atlassian.bitbucket.scm.ScmProtocolModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<ScmProtocol>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
public class ScmProtocolModuleDescriptor extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<ScmProtocol>
Provides an ScmProtocol implementation used in connection with one or more Scms.

Usage example:

     <scm-protocol
          key="ssh-protocol-for-git"
          weight="10"
          class="com.atlassian.stash.internal.scm.git.protocol.http.GitHttpProtocol"/>

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.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    XML_ELEMENT_NAME
     

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

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScmProtocolModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    disabled()
     
    ScmProtocol
    getModule()
     

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

    assertModuleClassImplements, checkPermissions, destroy, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, init, 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

  • Field Details

  • Constructor Details

    • ScmProtocolModuleDescriptor

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

  • Method Details

    • disabled

      public void disabled()
      Specified by:
      disabled in interface com.atlassian.plugin.StateAware
      Overrides:
      disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<ScmProtocol>

    • getModule

      public ScmProtocol getModule()
      Specified by:
      getModule in interface com.atlassian.plugin.ModuleDescriptor<ScmProtocol>
      Specified by:
      getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<ScmProtocol>