Package org.apache.sshd.cli.server

Class SshServerCliSupport

java.lang.Object

org.apache.sshd.cli.CliSupport

org.apache.sshd.cli.server.SshServerCliSupport

Direct Known Subclasses:

SshServerMain

public abstract class SshServerCliSupport
extends CliSupport

Field Summary

Fields

Modifier and Type	Field	Description
static final ShellFactory	DEFAULT_SHELL_FACTORY
static final String	SHELL_FACTORY_OPTION

Fields inherited from class org.apache.sshd.cli.CliSupport

DEFAULT_IO_SERVICE_FACTORY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SshServerCliSupport()

Method Summary

Modifier and Type	Method	Description
static ScpCommandFactory	createScpCommandFactory(Level level, PrintStream stdout, PrintStream stderr, ShellFactory delegateShellFactory)
static <F extends SubsystemFactory> F	registerSubsystemFactoryListeners(ServerFactoryManager server, Level level, PrintStream stdout, PrintStream stderr, PropertyResolver options, F factory)
static KeyPairProvider	resolveServerKeys(PrintStream stderr, String hostKeyType, int hostKeySize, Collection<String> keyFiles)
static List<SubsystemFactory>	resolveServerSubsystems(ServerFactoryManager server, Level level, PrintStream stdout, PrintStream stderr, PropertyResolver options)
static ShellFactory	resolveShellFactory(Level level, PrintStream stdout, PrintStream stderr, PropertyResolver options)	Attempts to examine the SHELL_FACTORY_OPTION configuration.
static Object	setupServerBanner(ServerFactoryManager server, PropertyResolver options)
static ForwardingFilter	setupServerForwarding(SshServer server, Level level, PrintStream stdout, PrintStream stderr, PropertyResolver options)

Methods inherited from class org.apache.sshd.cli.CliSupport

createLoggingIoServiceEventListener, createLoggingSessionListener, printFieldsValues, resolveBuiltinIoServiceFactory, resolveIoServiceFactory, setupCiphers, setupCiphers, setupCompressions, setupCompressions, setupIoServiceFactory, setupMacs, setupMacs, setupUserAuthFactories, splitCommandLineArguments

Methods inherited from class java.lang.Object

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

Field Details

SHELL_FACTORY_OPTION

public static final String SHELL_FACTORY_OPTION

See Also:

• Constant Field Values

DEFAULT_SHELL_FACTORY

public static final ShellFactory DEFAULT_SHELL_FACTORY

Constructor Details

SshServerCliSupport

protected SshServerCliSupport()

Method Details

resolveServerKeys

public static KeyPairProvider resolveServerKeys(PrintStream stderr,
 String hostKeyType,
 int hostKeySize,
 Collection<String> keyFiles)
                                         throws Exception

Throws:

Exception

setupServerForwarding

public static ForwardingFilter setupServerForwarding(SshServer server,
 Level level,
 PrintStream stdout,
 PrintStream stderr,
 PropertyResolver options)

setupServerBanner

public static Object setupServerBanner(ServerFactoryManager server,
 PropertyResolver options)

resolveServerSubsystems

public static List<SubsystemFactory> resolveServerSubsystems(ServerFactoryManager server,
 Level level,
 PrintStream stdout,
 PrintStream stderr,
 PropertyResolver options)
                                                      throws Exception

Throws:

Exception

registerSubsystemFactoryListeners

public static <F extends SubsystemFactory> F registerSubsystemFactoryListeners(ServerFactoryManager server,
 Level level,
 PrintStream stdout,
 PrintStream stderr,
 PropertyResolver options,
 F factory)
                                                                        throws Exception

Throws:

Exception

resolveShellFactory

public static ShellFactory resolveShellFactory(Level level,
 PrintStream stdout,
 PrintStream stderr,
 PropertyResolver options)
                                        throws Exception

Attempts to examine the SHELL_FACTORY_OPTION configuration.

• If missing/empty then returns the DEFAULT_SHELL_FACTORY.
• If NONE then returns null
• If SCP then returns a ScpCommandFactory
• Otherwise, assumes this is a fully qualified class path of a ShellFactory implementation and attempts to load and instantiate it using a public no-args constructor

Parameters:

level - The verbosity Level

stdout - The STDOUT stream for logging

stderr - The STDERR stream for errors

options - The available options - assuming defaults if null

Returns:

The resolved ShellFactory

Throws:

Exception - If failed to resolve

createScpCommandFactory

public static ScpCommandFactory createScpCommandFactory(Level level,
 PrintStream stdout,
 PrintStream stderr,
 ShellFactory delegateShellFactory)