com.sshtools.synergy.nio

Class SshEngine

java.lang.Object

com.sshtools.synergy.nio.SshEngine

public class SshEngine
extends java.lang.Object

This class provides an abstract daemon for servicing any number of protocol contexts.

Field Summary

Fields

Modifier and Type	Field and Description
protected static char[]	hexArray

Constructor Summary

Constructors

Constructor and Description
SshEngine() Constructs the Daemon.

Method Summary

Modifier and Type	Method and Description
void	addListener(SshEngineListener listener)
void	addShutdownHook(java.lang.Runnable r)
<K extends ProtocolContext> ConnectRequestFuture	connect(java.lang.String hostToConnect, int portToConnect, K protocolContext)
protected boolean	getBooleanValue(java.util.Properties properties, java.lang.String overrideKey, boolean defaultValue)
SshEngineContext	getContext() Get the context for this Daemon.
static SshEngine	getDefaultInstance()
protected int	getIntValue(java.util.Properties properties, java.lang.String overrideKey, int defaultValue)
java.lang.Throwable	getLastError()
protected long	getLongValue(java.util.Properties properties, java.lang.String overrideKey, long defaultValue)
static java.util.Date	getReleaseDate() Returns the release date of the current version.
AbstractRequestFuture	getShutdownFuture()
static java.lang.String	getVersion() Returns the current version of the API.
boolean	isStarted() Get whether the daemon is currently started
boolean	isStarting()
boolean	isStartupRequiresListeningInterfaces()
protected java.nio.channels.SocketChannel	processOpenSocket(java.nio.channels.SocketChannel socketChannel)
void	registerAcceptor(ClientAcceptor acceptor, java.nio.channels.ServerSocketChannel socketChannel) Register a client acceptor with the daemon.
void	registerConnector(ClientConnector connector, java.nio.channels.SocketChannel socketChannel) Register a client connector with the daemon.
void	registerHandler(SocketHandler handler, java.nio.channels.SelectableChannel channel) Register a socket handler with the daemon.
void	registerHandler(SocketHandler handler, java.nio.channels.SelectableChannel channel, SelectorThread thread) Register a socket handler with the daemon.
void	removeAcceptor(ListeningInterface li)
void	removeListener(SshEngineListener listener)
void	restart()
void	restart(boolean graceful, long forceAfterMs)
void	setStartupRequiresListeningInterfaces(boolean startupRequiresListeningInterfaces)
void	shutdownAndExit()
void	shutdownAsync(boolean graceful, long forceAfterMs) Shutdown the server.
void	shutdownNow(boolean graceful, long forceAfterMs) This method should be used to shutdown the server from your main thread.
protected boolean	startListeningInterface(ListeningInterface li)
boolean	startup() Starts the daemon, first calling the #configure(ConfigurationContext) method to allow your server to configure itself.
boolean	startup(java.util.Properties properties)

Methods inherited from class java.lang.Object

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

Field Detail

hexArray

protected static final char[] hexArray

Constructor Detail

SshEngine

public SshEngine()

Constructs the Daemon.

Method Detail

getContext

public SshEngineContext getContext()

Get the context for this Daemon.

Returns:

DaemonContext

getLastError

public java.lang.Throwable getLastError()

addListener

public void addListener(SshEngineListener listener)

removeListener

public void removeListener(SshEngineListener listener)

getVersion

public static java.lang.String getVersion()

Returns the current version of the API.

getReleaseDate

public static java.util.Date getReleaseDate()

Returns the release date of the current version.

isStarting

public boolean isStarting()

addShutdownHook

public void addShutdownHook(java.lang.Runnable r)

getIntValue

protected int getIntValue(java.util.Properties properties,
                          java.lang.String overrideKey,
                          int defaultValue)

getBooleanValue

protected boolean getBooleanValue(java.util.Properties properties,
                                  java.lang.String overrideKey,
                                  boolean defaultValue)

getLongValue

protected long getLongValue(java.util.Properties properties,
                            java.lang.String overrideKey,
                            long defaultValue)

startup

public boolean startup()
                throws java.io.IOException

Starts the daemon, first calling the #configure(ConfigurationContext) method to allow your server to configure itself.

Returns:

true if at least one interface started, otherwise false.

Throws:

java.io.IOException

startup

public boolean startup(java.util.Properties properties)
                throws java.io.IOException

Throws:

java.io.IOException

startListeningInterface

protected boolean startListeningInterface(ListeningInterface li)

removeAcceptor

public void removeAcceptor(ListeningInterface li)

isStarted

public boolean isStarted()

Get whether the daemon is currently started

Returns:

started

shutdownAsync

public void shutdownAsync(boolean graceful,
                          long forceAfterMs)

Shutdown the server. This does not exit the JVM

shutdownNow

public void shutdownNow(boolean graceful,
                        long forceAfterMs)

This method should be used to shutdown the server from your main thread. If you need to shutdown the server from within a session that is running on a transfer thread use shutdownAsync().

shutdownAndExit

public void shutdownAndExit()

restart

public void restart()
             throws java.io.IOException

Throws:

java.io.IOException

restart

public void restart(boolean graceful,
                    long forceAfterMs)
             throws java.io.IOException

Throws:

java.io.IOException

connect

public <K extends ProtocolContext> ConnectRequestFuture connect(java.lang.String hostToConnect,
                                                                int portToConnect,
                                                                K protocolContext)
                                                         throws SshException,
                                                                java.io.IOException

Throws:

SshException

java.io.IOException

processOpenSocket

protected java.nio.channels.SocketChannel processOpenSocket(java.nio.channels.SocketChannel socketChannel)

isStartupRequiresListeningInterfaces

public boolean isStartupRequiresListeningInterfaces()

setStartupRequiresListeningInterfaces

public void setStartupRequiresListeningInterfaces(boolean startupRequiresListeningInterfaces)

registerConnector

public void registerConnector(ClientConnector connector,
                              java.nio.channels.SocketChannel socketChannel)
                       throws java.io.IOException

Register a client connector with the daemon.

Parameters:

connector - ClientConnector

socketChannel - SocketChannel

Throws:

java.io.IOException

registerAcceptor

public void registerAcceptor(ClientAcceptor acceptor,
                             java.nio.channels.ServerSocketChannel socketChannel)
                      throws java.io.IOException

Register a client acceptor with the daemon.

Parameters:

acceptor - ClientAcceptor

socketChannel - ServerSocketChannel

Throws:

java.io.IOException

registerHandler

public void registerHandler(SocketHandler handler,
                            java.nio.channels.SelectableChannel channel)
                     throws java.io.IOException

Register a socket handler with the daemon.

Parameters:

handler - SocketHandler

channel - SelectableChannel

Throws:

java.io.IOException

registerHandler

public void registerHandler(SocketHandler handler,
                            java.nio.channels.SelectableChannel channel,
                            SelectorThread thread)
                     throws java.io.IOException

Register a socket handler with the daemon.

Parameters:

handler - SocketHandler

channel - SelectableChannel

thread - SelectorThread

Throws:

java.io.IOException

getDefaultInstance

public static SshEngine getDefaultInstance()
                                    throws java.io.IOException

Throws:

java.io.IOException

getShutdownFuture

public AbstractRequestFuture getShutdownFuture()