Package org.apache.sshd.server.command

Class AbstractDelegatingCommandFactory

java.lang.Object

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

org.apache.sshd.server.command.AbstractDelegatingCommandFactory

All Implemented Interfaces:

CommandFactory

Direct Known Subclasses:

ScpCommandFactory

public abstract class AbstractDelegatingCommandFactory
extends AbstractLoggingBean
implements CommandFactory

A CommandFactory wrapper that delegates calls to a proxy

Field Summary

Fields

Modifier and Type	Field	Description
private CommandFactory	delegate
private java.lang.String	name

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

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDelegatingCommandFactory(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
Command	createCommand(ChannelSession channel, java.lang.String command)	Create a command with the given name.
protected Command	createUnsupportedCommand(ChannelSession channel, java.lang.String command)
protected abstract Command	executeSupportedCommand(ChannelSession channel, java.lang.String command)
CommandFactory	getDelegateCommandFactory()
abstract boolean	isSupportedCommand(ChannelSession channel, java.lang.String command)
void	setDelegateCommandFactory(CommandFactory factory)
java.lang.String	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

Field Detail

name

private final java.lang.String name

delegate

private CommandFactory delegate

Constructor Detail

AbstractDelegatingCommandFactory

protected AbstractDelegatingCommandFactory(java.lang.String name)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDelegateCommandFactory

public CommandFactory getDelegateCommandFactory()

setDelegateCommandFactory

public void setDelegateCommandFactory(CommandFactory factory)

createCommand

public Command createCommand(ChannelSession channel,
                             java.lang.String command)
                      throws java.io.IOException

Description copied from interface: CommandFactory

Create a command with the given name. If the command is not known, a dummy command should be returned to allow the display output to be sent back to the client.

Specified by:

createCommand in interface CommandFactory

Parameters:

channel - The ChannelSession through which the command has been received

command - The command that will be run

Returns:

a non null Command instance

Throws:

java.io.IOException - if failed to create the instance

isSupportedCommand

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

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 abstract Command executeSupportedCommand(ChannelSession channel,
                                                   java.lang.String command)

createUnsupportedCommand

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