Package org.apache.sshd.git

Class AbstractGitCommandFactory

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.server.command.AbstractDelegatingCommandFactory

org.apache.sshd.git.AbstractGitCommandFactory

All Implemented Interfaces:

ExecutorServiceProvider, GitLocationResolverCarrier, CommandFactory

Direct Known Subclasses:

GitPackCommandFactory, GitPgmCommandFactory

public abstract class AbstractGitCommandFactory
extends AbstractDelegatingCommandFactory
implements ExecutorServiceProvider, GitLocationResolverCarrier

Helper class for various Git command factories

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	cmdPrefix
private java.util.function.Supplier<? extends CloseableExecutorService>	executorsProvider
private GitLocationResolver	rootDirResolver

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGitCommandFactory(java.lang.String name, java.lang.String cmdPrefix)

Method Summary

Modifier and Type	Method	Description
protected abstract AbstractGitCommand	createGitCommand(java.lang.String command)
protected Command	createUnsupportedCommand(ChannelSession channel, java.lang.String command)
protected Command	executeSupportedCommand(ChannelSession channel, java.lang.String command)
java.lang.String	getCommandPrefix()
java.util.function.Supplier<? extends CloseableExecutorService>	getExecutorServiceProvider()
GitLocationResolver	getGitLocationResolver()
boolean	isSupportedCommand(ChannelSession channel, java.lang.String command)
protected CloseableExecutorService	resolveExecutorService(java.lang.String command)
AbstractGitCommandFactory	withDelegate(CommandFactory delegate)
AbstractGitCommandFactory	withExecutorServiceProvider(java.util.function.Supplier<? extends CloseableExecutorService> provider)
AbstractGitCommandFactory	withGitLocationResolver(GitLocationResolver rootDirResolver)

Methods inherited from class org.apache.sshd.server.command.AbstractDelegatingCommandFactory

createCommand, getDelegateCommandFactory, setDelegateCommandFactory, toString

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.util.threads.ExecutorServiceProvider

resolveExecutorService

Field Detail

cmdPrefix

private final java.lang.String cmdPrefix

rootDirResolver

private GitLocationResolver rootDirResolver

executorsProvider

private java.util.function.Supplier<? extends CloseableExecutorService> executorsProvider

Constructor Detail

AbstractGitCommandFactory

protected AbstractGitCommandFactory(java.lang.String name,
                                    java.lang.String cmdPrefix)

Parameters:

name - Command factory logical name

cmdPrefix - The command prefix used to detect and intercept GIT commands handled by this factory (never null/empty)

Method Detail

getCommandPrefix

public java.lang.String getCommandPrefix()

getExecutorServiceProvider

public java.util.function.Supplier<? extends CloseableExecutorService> getExecutorServiceProvider()

Specified by:

getExecutorServiceProvider in interface ExecutorServiceProvider

Returns:

A Supplier of CloseableExecutorService to be used when asynchronous execution required. If null then a single-threaded ad-hoc service is used.

withExecutorServiceProvider

public AbstractGitCommandFactory withExecutorServiceProvider(java.util.function.Supplier<? extends CloseableExecutorService> provider)

Parameters:

provider - A Supplier of CloseableExecutorService to be used when starting a Git command execution. If null then a single-threaded ad-hoc service is used.

Returns:

Self instance

getGitLocationResolver

public GitLocationResolver getGitLocationResolver()

Specified by:

getGitLocationResolver in interface GitLocationResolverCarrier

withGitLocationResolver

public AbstractGitCommandFactory withGitLocationResolver(GitLocationResolver rootDirResolver)

withDelegate

public AbstractGitCommandFactory withDelegate(CommandFactory delegate)

isSupportedCommand

public boolean isSupportedCommand(ChannelSession channel,
                                  java.lang.String command)

Specified by:

isSupportedCommand in class AbstractDelegatingCommandFactory

Parameters:

channel - The ChannelSession through which the command was received

command - The command about to be executed

Returns:

true if this command is supported by the command factory, false if it will be passed on to the delegate factory

executeSupportedCommand

protected Command executeSupportedCommand(ChannelSession channel,
                                          java.lang.String command)

Specified by:

executeSupportedCommand in class AbstractDelegatingCommandFactory

createUnsupportedCommand

protected Command createUnsupportedCommand(ChannelSession channel,
                                           java.lang.String command)

Overrides:

createUnsupportedCommand in class AbstractDelegatingCommandFactory

resolveExecutorService

protected CloseableExecutorService resolveExecutorService(java.lang.String command)

createGitCommand

protected abstract AbstractGitCommand createGitCommand(java.lang.String command)