com.atlassian.bitbucket.scm.ssh

Interface SshScmRequestHandler

public interface SshScmRequestHandler

Plugin point for handling SshScmRequests.

See Also:

SshScmRequestHandlerModuleDescriptor

Method Summary

Modifier and Type	Method and Description
default Optional<SshScmRequest>	create(SshScmRequestContext context) Returns an SshScmRequest if this handler can handle the supplied command string, or Optional.empty() otherwise.
boolean	supports(String command)

Method Detail

create

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

Returns an SshScmRequest if this handler can handle the supplied command string, or Optional.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 Optional.empty() to indicate that this factory does not support the command

Throws:

com.atlassian.bitbucket.repository.NoSuchRepositoryException - if this handler supports the specified command, but the requested repository cannot be found

com.atlassian.bitbucket.AuthorisationException - if this handler the repository is not accessible

Since:

5.12

supports

boolean supports(@Nonnull
                 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