com.sshtools.synergy.ssh

Class ForwardingChannel<T extends SshContext>

java.lang.Object

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

com.sshtools.synergy.ssh.ForwardingChannel<T>

All Implemented Interfaces:

Channel

Direct Known Subclasses:

SocketForwardingChannel

public abstract class ForwardingChannel<T extends SshContext>
extends ChannelNG<T>

An abstract forwarding channel implementation for use with both local and remote forwarding operations.

A forwarding channel acts as a tunnel, connections are listened for at the tunnel start point and any data is forwarded from the start point through the ssh connection and then onto the end point. Local forwards have the tunnel start point on the client, and the data flows from the start point through the client, along the ssh connection to the server, out to the endpoint which can be anywhere. Remote forwards have the tunnel start point on the Server, and the data flows from the start point through the server, along the ssh connection to the client, out to the endpoint which can be anywhere.

Nested Class Summary

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

ChannelNG.ChannelInputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	hostToConnect Tunnel endpoint hostname
protected java.lang.String	originatingHost Tunnel startpoint hostname
protected int	originatingPort Tunnel startpoint port number
protected int	portToConnect Tunnel endpoint port number

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

cache, con, connection, localWindow, remoteWindow

Constructor Summary

Constructors

Constructor and Description
ForwardingChannel(java.lang.String channelType, int maximumPacketSize, int initialWindowSize, int maximumWindowSpace, int minimumWindowSpace) Construct the forwarding channel.
ForwardingChannel(java.lang.String channelType, int maximumPacketSize, int initialWindowSize, int maximumWindowSpace, int minimumWindowSpace, boolean autoConsume)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkWindowSpace()
java.lang.String	getHost() The hostname of the endpoint of tunnel.
java.lang.String	getOriginatingHost() The hostname of the startpoint of tunnel.
int	getOriginatingPort() The port number of the startpoint of tunnel.
int	getPort() The port number of the endpoint of tunnel.

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

addEventListener, canClose, clearIdleState, close, close, createCache, createChannel, evaluateWindowSpace, getChannelType, getCloseFuture, getConnection, getConnectionProtocol, getContext, getInputStream, getLastActivity, getLocalId, getLocalPacket, getLocalWindow, getMaxiumRemotePacketSize, getMaxiumRemoteWindowSize, getOpenFuture, getOutputStream, getRemoteId, getRemotePacket, getRemoteWindow, getSessionIdentifier, getTimeout, haltIncomingData, isClosed, isClosing, isConnected, isIncomingDataHalted, isLocalEOF, isOpen, isRemoteEOF, log, log, log, logMessage, onChannelClosed, onChannelClosing, onChannelData, onChannelError, onChannelFree, onChannelOpen, onChannelOpenConfirmation, onChannelOpenFailure, onChannelRequest, onExtendedData, onLocalEOF, onRemoteClose, onRemoteEOF, onWindowAdjust, openChannel, processChannelRequestResponse, registerExtendedDataType, resetIdleState, resumeIncomingData, sendChannelDataAndBlock, sendChannelDataAndBlock, sendChannelDataAndBlock, sendChannelDataAndBlock, sendChannelDataAndBlock, sendChannelDataAndBlock, sendChannelRequest, sendChannelRequest, sendData, sendEOF, sendExtendedData, sendExtendedData, sendRequestResponse, sendWindowAdjust, sendWindowAdjust, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

hostToConnect

protected java.lang.String hostToConnect

Tunnel endpoint hostname

portToConnect

protected int portToConnect

Tunnel endpoint port number

originatingHost

protected java.lang.String originatingHost

Tunnel startpoint hostname

originatingPort

protected int originatingPort

Tunnel startpoint port number

Constructor Detail

ForwardingChannel

public ForwardingChannel(java.lang.String channelType,
                         int maximumPacketSize,
                         int initialWindowSize,
                         int maximumWindowSpace,
                         int minimumWindowSpace)

Construct the forwarding channel.

Parameters:

channelType - String

maximumPacket - int

windowSize - int

See Also:

com.sshtools.synergy.ssh.ChannelNG#Channel(String channelType, int maximumPacketSize, int initialWindowSize)

ForwardingChannel

public ForwardingChannel(java.lang.String channelType,
                         int maximumPacketSize,
                         int initialWindowSize,
                         int maximumWindowSpace,
                         int minimumWindowSpace,
                         boolean autoConsume)

Method Detail

getHost

public java.lang.String getHost()

The hostname of the endpoint of tunnel.

Returns:

String

getPort

public int getPort()

The port number of the endpoint of tunnel.

Returns:

int

getOriginatingHost

public java.lang.String getOriginatingHost()

The hostname of the startpoint of tunnel.

Returns:

String

getOriginatingPort

public int getOriginatingPort()

The port number of the startpoint of tunnel.

Returns:

int

checkWindowSpace

protected boolean checkWindowSpace()

Overrides:

checkWindowSpace in class ChannelNG<T extends SshContext>