Package org.apache.sshd.server.shell

Class AggregateShellFactory

java.lang.Object

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

org.apache.sshd.server.shell.AggregateShellFactory

All Implemented Interfaces:

ShellFactory, ShellFactorySelector

public class AggregateShellFactory
extends AbstractLoggingBean
implements ShellFactory, ShellFactorySelector

Provides different shell(s) based on some criteria of the provided ChannelSession

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
protected final ShellFactory	defaultFactory
protected final Collection<? extends ShellFactorySelector>	selectors

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

log

Constructor Summary

Constructors

Constructor	Description
AggregateShellFactory(Collection<? extends ShellFactorySelector> selectors)
AggregateShellFactory(Collection<? extends ShellFactorySelector> selectors, ShellFactory defaultFactory)

Method Summary

Modifier and Type	Method	Description
Command	createShell(ChannelSession channel)
ShellFactory	selectShellFactory(ChannelSession channel)

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, toString, wait, wait, wait

Field Details

defaultFactory

protected final ShellFactory defaultFactory

selectors

protected final Collection<? extends ShellFactorySelector> selectors

Constructor Details

AggregateShellFactory

public AggregateShellFactory(Collection<? extends ShellFactorySelector> selectors)

Parameters:

selectors - Selector ShellFactorySelector-s being consulted whether they wish to provide a ShellFactory for the provided ChannelSession argument. If a selector returns null then the next in line is consulted. If no match found then the default InteractiveProcessShellFactory is used

AggregateShellFactory

public AggregateShellFactory(Collection<? extends ShellFactorySelector> selectors,
 ShellFactory defaultFactory)

Parameters:

selectors - Selector ShellFactorySelector-s being consulted whether they wish to provide a ShellFactory for the provided ChannelSession argument. If a selector returns null then the next in line is consulted.

defaultFactory - The (mandatory) default ShellFactory to use if no selector matched

Method Details

createShell

public Command createShell(ChannelSession channel)
                    throws IOException

Specified by:

createShell in interface ShellFactory

Parameters:

channel - The ChannelSession through which the command has been received

Returns:

The Command representing the shell to be executed

Throws:

IOException - If failed to create the shell

selectShellFactory

public ShellFactory selectShellFactory(ChannelSession channel)
                                throws IOException

Specified by:

selectShellFactory in interface ShellFactorySelector

Parameters:

channel - The ChannelSession

Returns:

The ShellFactory to use for the channel - null if none

Throws:

IOException - If failed the selection