com.atlassian.bitbucket.scm.ssh

Class SshScmRequestHandlerModuleDescriptor

java.lang.Object

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

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

com.atlassian.bitbucket.scm.AbstractScmRequestHandlerModuleDescriptor<SshScmRequestHandler>

com.atlassian.bitbucket.scm.ssh.SshScmRequestHandlerModuleDescriptor

All Implemented Interfaces:

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

public class SshScmRequestHandlerModuleDescriptor
extends AbstractScmRequestHandlerModuleDescriptor<SshScmRequestHandler>

Module descriptor for providing SshScmRequestHandler implementations.

Usage:

     <ssh-request-handler
              key="gitSshScmRequestHandler"
              class="com.example.stash.internal.scm.git.protocol.ssh.DefaultGitSshScmRequestHandler"
              scm="git"
              weight="100">
         <url-formatter class="com.atlassian.stash.internal.scm.git.protocol.ssh.GitSshUrlFormatter"/>
     </ssh-request-handler>
 

The key and class attributes are required. The scm and weight attributes, and the nested url-formatter, are optional.

• scm: Indicates the SshScmRequestHandler being registered adds SSH support for the specified SCM. This value should match the ID of the associated SCM.
  • The weighted nature of handlers means it's possible to add handlers which intercept other handlers, but do not, of themselves, add SSH support for an SCM
  • For example, the SCM cache plugin uses this ability to introduce pack caching for Git, but, of itself, it does not add SSH support for Git; it relies on another plugin for that
• url-formatter: Allows registering an ScmUrlFormatter which can be used to override the default SSH URL to apply SCM-specific decorators
  • If the url-formatter element is included, the class attribute is required
• weight: Defines the order in which SshScmRequestHandler implementations will be queried. Lower weights are queried earlier and the default weight is 100. The first implementation that supports a given command will be used

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

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

Method Summary

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

getModule, getScm, getUrlFormatter, init, provideValidationRules

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

compareTo, getWeight

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

SshScmRequestHandlerModuleDescriptor

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