com.sshtools.proxy

Class ProxySession

java.lang.Object

com.maverick.sshd.Channel

com.maverick.sshd.SessionChannel

com.sshtools.proxy.ProxySession

All Implemented Interfaces:

IdleStateListener

public class ProxySession
extends SessionChannel

Nested Class Summary

Nested classes/interfaces inherited from class com.maverick.sshd.Channel

Channel.DataBlock, Channel.QueuedData

Field Summary

Fields

Modifier and Type	Field and Description
protected Connection	con
protected com.maverick.ssh.SshSession	session
protected com.maverick.ssh.SshClient	ssh
protected com.maverick.ssh2.Ssh2Session	ssh2Session

Fields inherited from class com.maverick.sshd.SessionChannel

CHANNEL_TYPE, maximumWindowSpace, minimumWindowSpace, SSH_EXTENDED_DATA_STDERR

Fields inherited from class com.maverick.sshd.Channel

connection, localwindow, localWindowLock

Constructor Summary

Constructors

Constructor and Description
ProxySession(Connection con)

Method Summary

Modifier and Type	Method and Description
protected boolean	allocatePseudoTerminal(String terms, int cols, int rows, int width, int height, byte[] modes) If the client requests a pseudo terminal for the session this method will be invoked before the shell, exec or subsystem is started.
protected void	beforeChannelOpen()
protected void	changeWindowDimensions(int cols, int rows, int width, int height) When the window (terminal) size changes on the client side, it MAY send notification in which case this method will be invoked to notify the session that a change has occurred.
protected void	ensureChannelOpen()
protected boolean	executeCommand(String command) Invoked when the user wants to execute a command
protected void	onChannelClosed() Called when the channel has been closed to enable resources to be freed.
protected void	onLocalEOF() Called when the local side is EOF.
protected void	onRemoteEOF() The remote side has reported EOF so no more data will be received.
protected void	onSessionOpen() Called once the session is open and data can be sent/received.
protected void	processSignal(String signal) A signal can be delivered to the process by the client.
protected void	processStdinData(byte[] data) Data has arrived on the session's stdin stream.
protected boolean	setEnvironmentVariable(String name, String value) If the client requests that an environment variable be set this method will be invoked.
protected boolean	startShell() Invoked when the user wants to start a shell.
protected boolean	startSubsystem(String name)

Methods inherited from class com.maverick.sshd.SessionChannel

close, createChannel, evaluateWindowSpace, executeTask, getMaximumWindowSpace, getMinimumWindowSpace, getSubsystem, haltIncomingData, idle, isAgentForwardingRequested, isIncomingDataHalted, onChannelClosing, onChannelData, onChannelFree, onChannelOpen, onChannelOpenConfirmation, onChannelRequest, onExtendedData, openChannel, requestAgentForwarding, resumeIncomingData, sendExitStatus, sendStderrData, sendStderrData, sendStdoutData, sendStdoutData, setMaximumWindowSpace, setMinimumWindowSpace

Methods inherited from class com.maverick.sshd.Channel

addEventListener, addInputListener, addOutputListener, canClose, clearIdleState, close, consumeWindowSpace, createCloseTask, getChannelType, getConnection, getContext, getLocalId, getLocalPacket, getLocalWindow, getQueueSize, getRemoteId, getRemotePacket, getRemoteWindow, getSessionIdentifier, isClosed, isClosing, isEOF, isOpen, isSelfManagedWindowSpace, markEOF, onChannelOpenFailure, onRemoteClose, onWindowAdjust, queueSize, registerExtendedData, resetIdleState, sendChannelData, sendChannelData, sendChannelData, sendChannelData, sendChannelDataAndBlock, sendChannelRequest, sendEOF, sendExtendedData, sendExtendedData, sendRequestResponse, sendWindowAdjust

Methods inherited from class java.lang.Object

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

Field Detail

session

protected com.maverick.ssh.SshSession session

ssh2Session

protected com.maverick.ssh2.Ssh2Session ssh2Session

ssh

protected com.maverick.ssh.SshClient ssh

con

protected Connection con

Constructor Detail

ProxySession

public ProxySession(Connection con)
             throws SshException

Throws:

SshException

Method Detail

ensureChannelOpen

protected void ensureChannelOpen()

beforeChannelOpen

protected void beforeChannelOpen()

allocatePseudoTerminal

protected boolean allocatePseudoTerminal(String terms,
                                         int cols,
                                         int rows,
                                         int width,
                                         int height,
                                         byte[] modes)

Description copied from class: SessionChannel

If the client requests a pseudo terminal for the session this method will be invoked before the shell, exec or subsystem is started.

Specified by:

allocatePseudoTerminal in class SessionChannel

Returns:

boolean

changeWindowDimensions

protected void changeWindowDimensions(int cols,
                                      int rows,
                                      int width,
                                      int height)

Description copied from class: SessionChannel

When the window (terminal) size changes on the client side, it MAY send notification in which case this method will be invoked to notify the session that a change has occurred.

Specified by:

changeWindowDimensions in class SessionChannel

executeCommand

protected boolean executeCommand(String command)

Description copied from class: SessionChannel

Invoked when the user wants to execute a command

Specified by:

executeCommand in class SessionChannel

Returns:

true if the cmd has been executed, otherwise false

startSubsystem

protected boolean startSubsystem(String name)

Overrides:

startSubsystem in class SessionChannel

onSessionOpen

protected void onSessionOpen()

Description copied from class: SessionChannel

Called once the session is open and data can be sent/received. This event happens once the user has either started the shell or executed a command.

Specified by:

onSessionOpen in class SessionChannel

processSignal

protected void processSignal(String signal)

Description copied from class: SessionChannel

A signal can be delivered to the process by the client. If a signal is received this method will be invoked so that the session may evaluate and take the required action.

Specified by:

processSignal in class SessionChannel

processStdinData

protected void processStdinData(byte[] data)

Description copied from class: SessionChannel

Data has arrived on the session's stdin stream.

Specified by:

processStdinData in class SessionChannel

setEnvironmentVariable

protected boolean setEnvironmentVariable(String name,
                                         String value)

Description copied from class: SessionChannel

If the client requests that an environment variable be set this method will be invoked.

Specified by:

setEnvironmentVariable in class SessionChannel

Returns:

true if the variable has been set, otherwise false

startShell

protected boolean startShell()

Description copied from class: SessionChannel

Invoked when the user wants to start a shell.

Specified by:

startShell in class SessionChannel

Returns:

true if the shell has been started, otherwise false

onChannelClosed

protected void onChannelClosed()

Description copied from class: Channel

Called when the channel has been closed to enable resources to be freed.

Specified by:

onChannelClosed in class Channel

onRemoteEOF

protected void onRemoteEOF()

Description copied from class: SessionChannel

The remote side has reported EOF so no more data will be received. This will force the channel to close. If this behaviour is not required you can override this method

Overrides:

onRemoteEOF in class SessionChannel

onLocalEOF

protected void onLocalEOF()

Description copied from class: Channel

Called when the local side is EOF.

Specified by:

onLocalEOF in class Channel