public class

SshScmRequestHandlerModuleDescriptor

extends AbstractScmRequestHandlerModuleDescriptor<T>
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.stash.scm.BaseWeightedModuleDescriptor<T>
       ↳ com.atlassian.stash.scm.AbstractScmRequestHandlerModuleDescriptor<T>
         ↳ com.atlassian.stash.scm.ssh.SshScmRequestHandlerModuleDescriptor

Class Overview

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

Summary

Constants
String XML_ELEMENT_NAME
[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From interface com.atlassian.stash.util.Weighted
Public Constructors
SshScmRequestHandlerModuleDescriptor(ModuleFactory moduleFactory)
[Expand]
Inherited Methods
From class com.atlassian.stash.scm.AbstractScmRequestHandlerModuleDescriptor
From class com.atlassian.stash.scm.BaseWeightedModuleDescriptor
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From class java.lang.Object
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware
From interface com.atlassian.stash.util.Weighted
From interface java.lang.Comparable

Constants

public static final String XML_ELEMENT_NAME

Constant Value: "ssh-request-handler"

Public Constructors

public SshScmRequestHandlerModuleDescriptor (ModuleFactory moduleFactory)