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>
 

• 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

[Expand] Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor protected String key protected Class<T> moduleClass protected String moduleClassName protected final ModuleFactory moduleFactory protected String name protected Plugin plugin protected Resources resources
From interface com.atlassian.bitbucket.util.Weighted public static final Comparator<Weighted> COMPARABLE Note that this comparator only considers weight.

[Expand] Inherited Methods
From class com.atlassian.bitbucket.scm.AbstractScmRequestHandlerModuleDescriptor @Nonnull T getModule() @Nullable String getScm() Retrieves the ID of the SCM this handler adds support for, or null if this handler does not, of itself, add support for any specific SCM. @Nullable ScmUrlFormatter getUrlFormatter() Retrieves the ScmUrlFormatter which should be used to format clone URLs targeting this handler. void init(Plugin plugin, Element element) void provideValidationRules(ValidationPattern pattern)
From class com.atlassian.bitbucket.scm.BaseWeightedModuleDescriptor int compareTo(BaseWeightedModuleDescriptor<T> otherDescriptor) int getWeight() void init(Plugin plugin, Element element)
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor final void assertModuleClassImplements(Class<T> arg0) final void checkPermissions() void destroy() void disabled() void enabled() boolean equals(Object arg0) String getCompleteKey() String getDescription() String getDescriptionKey() String getI18nNameKey() String getKey() Float getMinJavaVersion() abstract T getModule() Class<T> getModuleClass() String getModuleClassName() String getName() Map<String, String> getParams() Plugin getPlugin() String getPluginKey() Set<String> getRequiredPermissions() ResourceDescriptor getResourceDescriptor(String arg0, String arg1) List<ResourceDescriptor> getResourceDescriptors() ResourceLocation getResourceLocation(String arg0, String arg1) Optional<String> getScopeKey() int hashCode() void init(Plugin arg0, Element arg1) boolean isBroken() boolean isEnabled() boolean isEnabledByDefault() boolean isSystemModule() void loadClass(Plugin arg0, String arg1) void provideValidationRules(ValidationPattern arg0) boolean satisfiesMinJavaVersion() void setBroken() void setPlugin(Plugin arg0) String toString()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.atlassian.bitbucket.util.Weighted int getWeight()
From interface com.atlassian.plugin.ModuleDescriptor void destroy() boolean equals(Object arg0) String getCompleteKey() String getDescription() String getDescriptionKey() String getDisplayName() String getI18nNameKey() String getKey() Float getMinJavaVersion() T getModule() Class<T> getModuleClass() String getName() Map<String, String> getParams() Plugin getPlugin() String getPluginKey() int hashCode() void init(Plugin arg0, Element arg1) boolean isBroken() boolean isEnabled() boolean isEnabledByDefault() boolean isSystemModule() boolean satisfiesMinJavaVersion() void setBroken()
From interface com.atlassian.plugin.Resourced ResourceDescriptor getResourceDescriptor(String arg0, String arg1) List<ResourceDescriptor> getResourceDescriptors() ResourceLocation getResourceLocation(String arg0, String arg1)
From interface com.atlassian.plugin.ScopeAware Optional<String> getScopeKey()
From interface com.atlassian.plugin.StateAware void disabled() void enabled()
From interface java.lang.Comparable int compareTo(T arg0)