org.apache.sshd

Class SshServer

java.lang.Object

org.apache.sshd.common.AbstractFactoryManager

org.apache.sshd.SshServer

All Implemented Interfaces:

Closeable, FactoryManager, ServerFactoryManager

public class SshServer
extends AbstractFactoryManager
implements ServerFactoryManager, Closeable

The SshServer class is the main entry point for the server side of the SSH protocol. The SshServer has to be configured before being started. Such configuration can be done either using a dependency injection mechanism (such as the Spring framework) or programmatically. Basic setup is usually done using the setUpDefaultServer() method, which will known ciphers, macs, channels, etc... Besides this basic setup, a few things have to be manually configured such as the port number, Factory, the KeyPairProvider and the PasswordAuthenticator. Some properties can also be configured using the AbstractFactoryManager.setProperties(java.util.Map) method. Once the SshServer instance has been configured, it can be started using the start() method and stopped using the stop() method.

Author:

Apache MINA SSHD Project

See Also:

ServerFactoryManager, FactoryManager

Field Summary

Fields

Modifier and Type	Field and Description
protected IoAcceptor	acceptor
protected CommandFactory	commandFactory
protected GSSAuthenticator	gssAuthenticator
protected java.lang.String	host
protected PasswordAuthenticator	passwordAuthenticator
protected int	port
protected PublickeyAuthenticator	publickeyAuthenticator
protected SessionFactory	sessionFactory
protected ServerSessionTimeoutListener	sessionTimeoutListener
protected Factory<Command>	shellFactory
protected java.util.List<NamedFactory<Command>>	subsystemFactories
protected java.util.concurrent.ScheduledFuture<?>	timeoutListenerFuture
protected java.util.List<NamedFactory<UserAuth>>	userAuthFactories

Fields inherited from class org.apache.sshd.common.AbstractFactoryManager

agentFactory, channelFactories, cipherFactories, compressionFactories, executor, fileSystemFactory, globalRequestHandlers, ioServiceFactory, ioServiceFactoryFactory, keyExchangeFactories, keyPairProvider, log, macFactories, properties, randomFactory, serviceFactories, shutdownExecutor, signatureFactories, tcpipForwarderFactory, tcpipForwardingFilter, version

Fields inherited from interface org.apache.sshd.server.ServerFactoryManager

AUTH_METHODS, AUTH_TIMEOUT, COMMAND_EXIT_TIMEOUT, IDLE_TIMEOUT, MAX_AUTH_REQUESTS, MAX_CONCURRENT_SESSIONS, REKEY_BYTES_LIMIT, REKEY_TIME_LIMIT, SERVER_IDENTIFICATION, WELCOME_BANNER

Fields inherited from interface org.apache.sshd.common.FactoryManager

DEFAULT_NIO_WORKERS, MAX_PACKET_SIZE, NIO_WORKERS, WINDOW_SIZE

Constructor Summary

Constructors

Constructor and Description
SshServer()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkConfig()
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
protected IoAcceptor	createAcceptor()
protected SessionFactory	createSessionFactory()
protected ServerSessionTimeoutListener	createSessionTimeoutListener()
java.util.List<AbstractSession>	getActiveSessions() Obtain the list of active sessions.
CommandFactory	getCommandFactory() Retrieve the CommandFactory to be used to process commands requests.
GSSAuthenticator	getGSSAuthenticator() Retrieve the GSSAuthenticator to be used by the SSH server.
java.lang.String	getHost()
PasswordAuthenticator	getPasswordAuthenticator() Retrieve the PasswordAuthenticator to be used by the SSH server.
int	getPort()
PublickeyAuthenticator	getPublickeyAuthenticator() Retrieve the PublickeyAuthenticator to be used by SSH server.
SessionFactory	getSessionFactory()
Factory<Command>	getShellFactory() Retrieve the ShellFactory object to be used to create shells.
java.util.List<NamedFactory<Command>>	getSubsystemFactories() Retrieve the list of named factories for CommandFactory.Command to be used to create subsystems.
java.util.List<NamedFactory<UserAuth>>	getUserAuthFactories() Retrieve the list of named factories for UserAuth objects.
static void	main(java.lang.String[] args)
void	open()
void	setCommandFactory(CommandFactory commandFactory)
void	setGSSAuthenticator(GSSAuthenticator gssAuthenticator)
void	setHost(java.lang.String host)
void	setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)
void	setPort(int port) Configure the port number to use for this SSH server.
void	setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)
void	setSessionFactory(SessionFactory sessionFactory)
void	setShellFactory(Factory<Command> shellFactory)
void	setSubsystemFactories(java.util.List<NamedFactory<Command>> subsystemFactories)
void	setTcpipForwardingFilter(ForwardingFilter forwardingFilter)
static SshServer	setUpDefaultServer()
void	setUserAuthFactories(java.util.List<NamedFactory<UserAuth>> userAuthFactories)
void	start() Start the SSH server and accept incoming exceptions on the configured port.
void	stop() Stop the SSH server.
void	stop(boolean immediately)
protected void	stopSessionTimeoutListener()

Methods inherited from class org.apache.sshd.common.AbstractFactoryManager

getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getIoServiceFactoryFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getNioWorkers, getProperties, getRandomFactory, getScheduledExecutorService, getServiceFactories, getSignatureFactories, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion, loadVersion, setAgentFactory, setChannelFactories, setCipherFactories, setCompressionFactories, setFileSystemFactory, setGlobalRequestHandlers, setIoServiceFactoryFactory, setKeyExchangeFactories, setKeyPairProvider, setMacFactories, setNioWorkers, setProperties, setRandomFactory, setScheduledExecutorService, setScheduledExecutorService, setServiceFactories, setSignatureFactories, setTcpipForwarderFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.FactoryManager

getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getProperties, getRandomFactory, getScheduledExecutorService, getServiceFactories, getSignatureFactories, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion

Field Detail

acceptor

protected IoAcceptor acceptor

host

protected java.lang.String host

port

protected int port

userAuthFactories

protected java.util.List<NamedFactory<UserAuth>> userAuthFactories

shellFactory

protected Factory<Command> shellFactory

sessionFactory

protected SessionFactory sessionFactory

commandFactory

protected CommandFactory commandFactory

subsystemFactories

protected java.util.List<NamedFactory<Command>> subsystemFactories

passwordAuthenticator

protected PasswordAuthenticator passwordAuthenticator

publickeyAuthenticator

protected PublickeyAuthenticator publickeyAuthenticator

gssAuthenticator

protected GSSAuthenticator gssAuthenticator

sessionTimeoutListener

protected ServerSessionTimeoutListener sessionTimeoutListener

timeoutListenerFuture

protected java.util.concurrent.ScheduledFuture<?> timeoutListenerFuture

Constructor Detail

SshServer

public SshServer()

Method Detail

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

getPort

public int getPort()

setPort

public void setPort(int port)

Configure the port number to use for this SSH server.

Parameters:

port - the port number for this SSH server

getUserAuthFactories

public java.util.List<NamedFactory<UserAuth>> getUserAuthFactories()

Description copied from interface: ServerFactoryManager

Retrieve the list of named factories for UserAuth objects.

Specified by:

getUserAuthFactories in interface ServerFactoryManager

Returns:

a list of named UserAuth factories, never null

setUserAuthFactories

public void setUserAuthFactories(java.util.List<NamedFactory<UserAuth>> userAuthFactories)

getShellFactory

public Factory<Command> getShellFactory()

Description copied from interface: ServerFactoryManager

Retrieve the ShellFactory object to be used to create shells.

Specified by:

getShellFactory in interface ServerFactoryManager

Returns:

a valid ShellFactory object or null if shells are not supported on this server

setShellFactory

public void setShellFactory(Factory<Command> shellFactory)

getSessionFactory

public SessionFactory getSessionFactory()

setSessionFactory

public void setSessionFactory(SessionFactory sessionFactory)

getCommandFactory

public CommandFactory getCommandFactory()

Description copied from interface: ServerFactoryManager

Retrieve the CommandFactory to be used to process commands requests.

Specified by:

getCommandFactory in interface ServerFactoryManager

Returns:

a valid CommandFactory object or null if commands are not supported on this server

setCommandFactory

public void setCommandFactory(CommandFactory commandFactory)

getSubsystemFactories

public java.util.List<NamedFactory<Command>> getSubsystemFactories()

Description copied from interface: ServerFactoryManager

Retrieve the list of named factories for CommandFactory.Command to be used to create subsystems.

Specified by:

getSubsystemFactories in interface ServerFactoryManager

Returns:

a list of named CommandFactory.Command factories or null if subsystems are not supported on this server

setSubsystemFactories

public void setSubsystemFactories(java.util.List<NamedFactory<Command>> subsystemFactories)

getPasswordAuthenticator

public PasswordAuthenticator getPasswordAuthenticator()

Description copied from interface: ServerFactoryManager

Retrieve the PasswordAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on passwords will be rejected.

Specified by:

getPasswordAuthenticator in interface ServerFactoryManager

Returns:

the PasswordAuthenticator or null

setPasswordAuthenticator

public void setPasswordAuthenticator(PasswordAuthenticator passwordAuthenticator)

getPublickeyAuthenticator

public PublickeyAuthenticator getPublickeyAuthenticator()

Description copied from interface: ServerFactoryManager

Retrieve the PublickeyAuthenticator to be used by SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on keys will be rejected.

Specified by:

getPublickeyAuthenticator in interface ServerFactoryManager

Returns:

the PublickeyAuthenticato or null

setPublickeyAuthenticator

public void setPublickeyAuthenticator(PublickeyAuthenticator publickeyAuthenticator)

getGSSAuthenticator

public GSSAuthenticator getGSSAuthenticator()

Description copied from interface: ServerFactoryManager

Retrieve the GSSAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on gssapi will be rejected.

Specified by:

getGSSAuthenticator in interface ServerFactoryManager

Returns:

the GSSAuthenticator or null

setGSSAuthenticator

public void setGSSAuthenticator(GSSAuthenticator gssAuthenticator)

setTcpipForwardingFilter

public void setTcpipForwardingFilter(ForwardingFilter forwardingFilter)

Overrides:

setTcpipForwardingFilter in class AbstractFactoryManager

checkConfig

protected void checkConfig()

start

public void start()
           throws java.io.IOException

Start the SSH server and accept incoming exceptions on the configured port.

Throws:

java.io.IOException

stop

public void stop()
          throws java.lang.InterruptedException

Stop the SSH server. This method will block until all resources are actually disposed.

Throws:

java.lang.InterruptedException

stop

public void stop(boolean immediately)
          throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

open

public void open()
          throws java.io.IOException

Throws:

java.io.IOException

close

public CloseFuture close(boolean immediately)

Description copied from interface: Closeable

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Specified by:

close in interface Closeable

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a future

getActiveSessions

public java.util.List<AbstractSession> getActiveSessions()

Obtain the list of active sessions.

createAcceptor

protected IoAcceptor createAcceptor()

createSessionFactory

protected SessionFactory createSessionFactory()

createSessionTimeoutListener

protected ServerSessionTimeoutListener createSessionTimeoutListener()

stopSessionTimeoutListener

protected void stopSessionTimeoutListener()

setUpDefaultServer

public static SshServer setUpDefaultServer()

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception