Package com.sshtools.client

Class AbstractSessionChannel

java.lang.Object

com.sshtools.synergy.ssh.ChannelNG<SshClientContext>

com.sshtools.client.AbstractSessionChannel

All Implemented Interfaces:

Channel

Direct Known Subclasses:

SessionChannelNG

public abstract class AbstractSessionChannel
extends ChannelNG<SshClientContext>

Implements the client side of the SSH Connection protocol session channel

Nested Class Summary

Nested classes/interfaces inherited from class com.sshtools.synergy.ssh.ChannelNG

ChannelNG.ChannelInputStream

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EXITCODE_NOT_RECEIVED
static final int	SSH_EXTENDED_DATA_STDERR

Fields inherited from class com.sshtools.synergy.ssh.ChannelNG

cache, con, connection, localWindow, paused, remoteWindow

Constructor Summary

Constructors

Constructor	Description
AbstractSessionChannel(int maximumPacketSize, com.sshtools.common.util.UnsignedInteger32 initialWindowSize, com.sshtools.common.util.UnsignedInteger32 maximumWindowSpace, com.sshtools.common.util.UnsignedInteger32 minimumWindowSpace, boolean autoConsume)
AbstractSessionChannel(int maximumPacketSize, com.sshtools.common.util.UnsignedInteger32 initialWindowSize, com.sshtools.common.util.UnsignedInteger32 maximumWindowSpace, com.sshtools.common.util.UnsignedInteger32 minimumWindowSpace, ChannelRequestFuture closeFuture, boolean autoConsume)

Method Summary

Modifier and Type	Method	Description
RequestFuture	allocatePseudoTerminal(String type)
RequestFuture	allocatePseudoTerminal(String type, int cols, int rows)
RequestFuture	allocatePseudoTerminal(String type, int cols, int rows, int width, int height, PseudoTerminalModes modes)	Deprecated, for removal: This API element is subject to removal in a future version.
RequestFuture	allocatePseudoTerminal(String type, int cols, int rows, int width, int height, TerminalModes modes)
RequestFuture	allocatePseudoTerminal(String type, int cols, int rows, PseudoTerminalModes modes)
void	changeTerminalDimensions(int cols, int rows, int width, int height)
protected byte[]	createChannel()
RequestFuture	executeCommand(String cmd)
RequestFuture	executeCommand(String cmd, String charset)
int	getExitCode()
String	getExitSignalInfo()
int	getMaximumLocalPacketLength()
int	getMaximumRemotePacketLength()
boolean	isFlowControlEnabled()
boolean	isSingleSession()
protected void	onChannelClosed()
protected void	onChannelClosing()
protected void	onChannelError(Throwable e)
protected void	onChannelFree()
protected void	onChannelOpen()
protected void	onChannelOpenConfirmation()
protected void	onChannelRequest(String requesttype, boolean wantreply, byte[] requestdata)
protected void	onLocalEOF()
protected void	onRemoteEOF()
protected byte[]	openChannel(byte[] requestdata)
RequestFuture	setEnvironmentVariable(String key, String val)
void	setSingleSession(boolean singleSession)
RequestFuture	signal(String signal)	Send a signal to the remote process.
RequestFuture	startShell()
RequestFuture	startSubsystem(String subsystem)

Methods inherited from class com.sshtools.synergy.ssh.ChannelNG

addEventListener, canClose, checkWindowSpace, clearIdleState, close, close, close, createCache, disposeCache, evaluateWindowSpace, getChannelType, getCloseFuture, getConnection, getConnectionProtocol, getContext, getInputStream, getLastActivity, getLocalId, getLocalPacket, getLocalWindow, getMaxiumRemotePacketSize, getMaxiumRemoteWindowSize, getOpenFuture, getOutputStream, getRemoteId, getRemotePacket, getRemoteWindow, getSessionIdentifier, getTimeout, haltIncomingData, isAutoConsume, isClosed, isClosing, isConnected, isIncomingDataHalted, isLocalEOF, isOpen, isRemoteEOF, log, log, log, log, logMessage, logMessage, onChannelData, onChannelOpenFailure, onExtendedData, onRemoteClose, onWindowAdjust, processChannelRequestResponse, registerExtendedDataType, removeEventListener, resetIdleState, resumeIncomingData, sendChannelDataAndBlock, sendChannelDataAndBlock, sendChannelDataAndBlock, sendChannelDataAndBlock, sendChannelDataAndBlock, sendChannelDataAndBlock, sendChannelRequest, sendChannelRequest, sendData, sendEOF, sendExtendedData, sendExtendedData, sendRequestResponse, sendWindowAdjust, sendWindowAdjust, setAutoconsume, setTimeout

Methods inherited from class java.lang.Object

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

Field Details

EXITCODE_NOT_RECEIVED

public static final int EXITCODE_NOT_RECEIVED

See Also:

• Constant Field Values

SSH_EXTENDED_DATA_STDERR

public static final int SSH_EXTENDED_DATA_STDERR

See Also:

• Constant Field Values

Constructor Details

AbstractSessionChannel

public AbstractSessionChannel(int maximumPacketSize,
 com.sshtools.common.util.UnsignedInteger32 initialWindowSize,
 com.sshtools.common.util.UnsignedInteger32 maximumWindowSpace,
 com.sshtools.common.util.UnsignedInteger32 minimumWindowSpace,
 boolean autoConsume)

AbstractSessionChannel

public AbstractSessionChannel(int maximumPacketSize,
 com.sshtools.common.util.UnsignedInteger32 initialWindowSize,
 com.sshtools.common.util.UnsignedInteger32 maximumWindowSpace,
 com.sshtools.common.util.UnsignedInteger32 minimumWindowSpace,
 ChannelRequestFuture closeFuture,
 boolean autoConsume)

Method Details

isSingleSession

public boolean isSingleSession()

setSingleSession

public void setSingleSession(boolean singleSession)

onChannelFree

protected void onChannelFree()

Specified by:

onChannelFree in class ChannelNG<SshClientContext>

createChannel

protected byte[] createChannel()
                        throws IOException

Specified by:

createChannel in class ChannelNG<SshClientContext>

Throws:

IOException

openChannel

protected byte[] openChannel(byte[] requestdata)
                      throws WriteOperationRequest,
ChannelOpenException

Specified by:

openChannel in class ChannelNG<SshClientContext>

Throws:

WriteOperationRequest

ChannelOpenException

onChannelOpenConfirmation

protected void onChannelOpenConfirmation()

Specified by:

onChannelOpenConfirmation in class ChannelNG<SshClientContext>

onChannelError

protected void onChannelError(Throwable e)

Overrides:

onChannelError in class ChannelNG<SshClientContext>

onChannelClosed

protected void onChannelClosed()

Specified by:

onChannelClosed in class ChannelNG<SshClientContext>

onChannelOpen

protected void onChannelOpen()

Specified by:

onChannelOpen in class ChannelNG<SshClientContext>

allocatePseudoTerminal

public RequestFuture allocatePseudoTerminal(String type)

allocatePseudoTerminal

public RequestFuture allocatePseudoTerminal(String type,
 int cols,
 int rows)

allocatePseudoTerminal

public RequestFuture allocatePseudoTerminal(String type,
 int cols,
 int rows,
 PseudoTerminalModes modes)

changeTerminalDimensions

public void changeTerminalDimensions(int cols,
 int rows,
 int width,
 int height)

signal

public RequestFuture signal(String signal)

Send a signal to the remote process. A signal can be delivered to the remote process using this method, some systems may not implement signals. The signal name should be one of the following values:

 ABRT
 ALRM
 FPE
 HUP
 ILL
 INT
 KILL
 PIPE
 QUIT
 SEGV
 TERM
 USR1
 USR2
 

Parameters:

signal -

Returns:

future

Throws:

IOException

allocatePseudoTerminal

@Deprecated(since="3.1.2",
            forRemoval=true)
public RequestFuture allocatePseudoTerminal(String type,
 int cols,
 int rows,
 int width,
 int height,
 PseudoTerminalModes modes)

Deprecated, for removal: This API element is subject to removal in a future version.

allocatePseudoTerminal

public RequestFuture allocatePseudoTerminal(String type,
 int cols,
 int rows,
 int width,
 int height,
 TerminalModes modes)

setEnvironmentVariable

public RequestFuture setEnvironmentVariable(String key,
 String val)

startShell

public RequestFuture startShell()

executeCommand

public RequestFuture executeCommand(String cmd)

executeCommand

public RequestFuture executeCommand(String cmd,
 String charset)

startSubsystem

public RequestFuture startSubsystem(String subsystem)

onChannelClosing

protected void onChannelClosing()

Specified by:

onChannelClosing in class ChannelNG<SshClientContext>

onChannelRequest

protected void onChannelRequest(String requesttype,
 boolean wantreply,
 byte[] requestdata)

Specified by:

onChannelRequest in class ChannelNG<SshClientContext>

getExitCode

public int getExitCode()

isFlowControlEnabled

public boolean isFlowControlEnabled()

getExitSignalInfo

public String getExitSignalInfo()

onRemoteEOF

protected void onRemoteEOF()

Specified by:

onRemoteEOF in class ChannelNG<SshClientContext>

onLocalEOF

protected void onLocalEOF()

Specified by:

onLocalEOF in class ChannelNG<SshClientContext>

getMaximumRemotePacketLength

public int getMaximumRemotePacketLength()

getMaximumLocalPacketLength

public int getMaximumLocalPacketLength()