com.maverick.sshd

Class Subsystem

java.lang.Object

com.maverick.ssh.ExecutorOperationSupport<SshContext>

com.maverick.sshd.Subsystem

Direct Known Subclasses:

PublicKeySubsystem, SftpSubsystem

public abstract class Subsystem
extends ExecutorOperationSupport<SshContext>

Defines the abstract attributes of an SSH Subsystem.

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field and Description
protected SshContext	context
protected SessionChannel	session
protected TransportProtocol	transport

Constructor Summary

Constructors

Constructor and Description
Subsystem(String name)

Method Summary

Modifier and Type	Method and Description
protected void	cleanupOnError()
protected abstract void	cleanupSubsystem()
protected void	executeOperation(ConnectionAwareTask r)
protected void	flagClose(ConnectionAwareTask r)
Connection	getConnection()
SshContext	getContext()
SessionChannel	getSession()
protected void	init(SessionChannel session, SshContext context) Initialize the subsystem with the current session and configuration.
void	onFreeMessage(byte[] msg)
protected abstract void	onMessageReceived(byte[] msg) Called when a subsystem message has been extracted from the incoming data stream.
protected abstract void	onSubsystemFree() The subsystem has been closed and all resources should be freed.
protected void	parseMessage(byte[] data)
protected void	postCleanup()
protected void	processMessage(byte[] data) Process channel data and transform into a subsystem message when enough data has arrived.
void	sendMessage(Packet packet) Send a subsystem message.

Methods inherited from class com.maverick.ssh.ExecutorOperationSupport

addOperationListener, addTask, cleanupOperations, clearQueue, endExecution, getName, getOperationsCount, removeOperationListener, startExecution, startTask, taskAdded

Methods inherited from class java.lang.Object

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

Field Detail

session

protected SessionChannel session

transport

protected TransportProtocol transport

context

protected SshContext context

Constructor Detail

Subsystem

public Subsystem(String name)

Method Detail

getContext

public SshContext getContext()

Specified by:

getContext in class ExecutorOperationSupport<SshContext>

getConnection

public Connection getConnection()

getSession

public SessionChannel getSession()

init

protected void init(SessionChannel session,
                    SshContext context)
             throws IOException

Initialize the subsystem with the current session and configuration.

Parameters:

session -

context -

Throws:

IOException

executeOperation

protected void executeOperation(ConnectionAwareTask r)

postCleanup

protected void postCleanup()

cleanupSubsystem

protected abstract void cleanupSubsystem()

processMessage

protected void processMessage(byte[] data)
                       throws IOException

Process channel data and transform into a subsystem message when enough data has arrived.

Parameters:

data -

Throws:

IOException

parseMessage

protected void parseMessage(byte[] data)
                     throws IOException

Throws:

IOException

cleanupOnError

protected void cleanupOnError()

onSubsystemFree

protected abstract void onSubsystemFree()

The subsystem has been closed and all resources should be freed.

onMessageReceived

protected abstract void onMessageReceived(byte[] msg)

Called when a subsystem message has been extracted from the incoming data stream.

Parameters:

msg -

sendMessage

public void sendMessage(Packet packet)
                 throws IOException

Send a subsystem message. NOTE: you do not have to prefix the message with its length as this operation is performed inside this method.

Parameters:

msg -

Throws:

IOException

onFreeMessage

public void onFreeMessage(byte[] msg)

flagClose

protected void flagClose(ConnectionAwareTask r)