public interface

SshScmRequestHandler

com.atlassian.bitbucket.scm.ssh.SshScmRequestHandler

Class Overview

Plugin point for handling SshScmRequests.

See Also

Summary

Public Methods
@Nonnull Optional<SshScmRequest> create(SshScmRequestContext context)
Returns an SshScmRequest if this handler can handle the supplied command string, or empty() otherwise.
boolean supports(String command)

Public Methods

@Nonnull public Optional<SshScmRequest> create (SshScmRequestContext context)

Returns an SshScmRequest if this handler can handle the supplied command string, or empty() otherwise.

Parameters
context context describing the request, which can be used by the handler implementation to determine whether it supports the request or not
Returns
  • an SshScmRequest if this handler supports the specified command, or empty() to indicate that this factory does not support the command
Throws
NoSuchRepositoryException if this handler supports the specified command, but the requested repository cannot be found
AuthorisationException if this handler the repository is not accessible

public boolean supports (String command)

Parameters
command the command String passed from the remote SSH client (e.g. "git-upload-pack path/to/repository")
Returns
  • true if the handler supports the supplied command, false otherwise