com.sshtools.common.ssh

Class Subsystem

java.lang.Object

com.sshtools.common.ssh.Subsystem

Direct Known Subclasses:

PublicKeySubsystemServer, SftpSubsystem

public abstract class Subsystem
extends java.lang.Object

Defines the abstract attributes of an SSH Subsystem.

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	context
protected SessionChannel	session
static java.lang.Integer	SUBSYSTEM_INCOMING
static java.lang.Integer	SUBSYSTEM_OUTGOING

Constructor Summary

Constructors

Constructor and Description
Subsystem(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected void	cleanup()
protected abstract void	cleanupSubsystem()
protected void	executeOperation(java.lang.Integer messageQueue, ConnectionAwareTask r)
void	free()
SshConnection	getConnection()
Context	getContext()
SessionChannel	getSession()
void	init(SessionChannel session, Context 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(java.nio.ByteBuffer data)
void	processMessage(java.nio.ByteBuffer 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 java.lang.Object

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

Field Detail

SUBSYSTEM_INCOMING

public static final java.lang.Integer SUBSYSTEM_INCOMING

SUBSYSTEM_OUTGOING

public static final java.lang.Integer SUBSYSTEM_OUTGOING

session

protected SessionChannel session

context

protected Context context

Constructor Detail

Subsystem

public Subsystem(java.lang.String name)

Method Detail

getContext

public Context getContext()

getConnection

public SshConnection getConnection()

getSession

public SessionChannel getSession()

init

public void init(SessionChannel session,
                 Context context)
          throws java.io.IOException,
                 PermissionDeniedException

Initialize the subsystem with the current session and configuration.

Parameters:

session -

context -

Throws:

java.io.IOException

PermissionDeniedException

executeOperation

protected void executeOperation(java.lang.Integer messageQueue,
                                ConnectionAwareTask r)

cleanup

protected void cleanup()

cleanupSubsystem

protected abstract void cleanupSubsystem()

processMessage

public void processMessage(java.nio.ByteBuffer data)
                    throws java.io.IOException

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

Parameters:

data -

Throws:

java.io.IOException

parseMessage

protected void parseMessage(java.nio.ByteBuffer data)
                     throws java.io.IOException

Throws:

java.io.IOException

free

public void free()

onSubsystemFree

protected abstract void onSubsystemFree()

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

onMessageReceived

protected abstract void onMessageReceived(byte[] msg)
                                   throws java.io.IOException

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

Parameters:

msg -

Throws:

java.io.IOException

sendMessage

public void sendMessage(Packet packet)
                 throws java.io.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:

java.io.IOException

onFreeMessage

public void onFreeMessage(byte[] msg)