Package com.sshtools.synergy.ssh

Class LocalForwardingChannel<T extends SshContext>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

Channel, ClientConnector, SelectionKeyAware, SelectorRegistrationListener, SocketHandler

public class LocalForwardingChannel<T extends SshContext>
extends SocketForwardingChannel<T>
implements ClientConnector

Implements a Local forwarding channel for use with forwarding sockets from the client machine through the server to some endpoint reachable from the server machine.

Nested Class Summary

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

ChannelNG.ChannelInputStream

Field Summary

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

key, LOCAL_FORWARDING_CHANNEL_TYPE, REMOTE_FORWARDING_CHANNEL_TYPE, selectorThread, socketChannel, X11_FORWARDING_CHANNEL_TYPE

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

hostToConnect, originatingHost, originatingPort, portToConnect

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

cache, con, connection, localWindow, remoteWindow

Constructor Summary

Constructors

Constructor	Description
LocalForwardingChannel(String channelType, SshConnection con)
LocalForwardingChannel(String channelType, SshConnection con, String hostToConnect, int portToConnect, SocketChannel socketChannel)	Constructs a forwarding channel of the type "forwarded-tcpip"

Method Summary

Modifier and Type	Method	Description
protected boolean	checkPermissions()
protected byte[]	createChannel()	Create the forwarding channel.
protected SocketAddress	createSocketAddress()
protected SocketChannel	createSocketChannel()
boolean	finishConnect(SelectionKey key)	Called when the forwarded socket has been connected.
void	initialize(ProtocolEngine engine, SshEngine daemon, SelectableChannel channel)	Initialise this socket with a ProtocolEngine and the current SshEngine.
protected void	onChannelOpenConfirmation()	Called when the channel has been confirmed as open.
protected void	onChannelOpenFailure()	Either nothing was listening on the clients end of the tunnel, or the connection was rejected.
protected void	onConnectionComplete()
protected void	onConnectionError(IOException ex)
protected void	onRegistrationComplete()	Called when the forwarded sockets selector has been registered with a {@link com,maverick.nio.SelectorThread}.
protected byte[]	openChannel(byte[] requestdata)	Open a forwarding channel.
protected void	readForwarding(com.sshtools.common.util.ByteArrayReader bar)

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

addTask, canClose, cleanupSocket, createCache, evaluateClosure, evaluateWindowSpace, getInitialOps, getName, getSelectorThread, initialize, onChannelClosed, onChannelClosing, onChannelData, onChannelFree, onChannelOpen, onChannelRequest, onExtendedData, onLocalEOF, onRemoteClose, onRemoteEOF, processReadEvent, processWriteEvent, registrationCompleted, setSelectionKey, setThread, shutdownSocket, wantsRead, wantsWrite

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

getHost, getOriginatingHost, getOriginatingPort, getPort

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

addEventListener, checkWindowSpace, clearIdleState, close, close, close, 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, onChannelError, onWindowAdjust, 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

Methods inherited from interface com.sshtools.synergy.nio.SelectorRegistrationListener

registrationCompleted

Methods inherited from interface com.sshtools.synergy.nio.SocketHandler

getConnection, getContext

Constructor Details

LocalForwardingChannel

public LocalForwardingChannel(String channelType,
 SshConnection con)

LocalForwardingChannel

public LocalForwardingChannel(String channelType,
 SshConnection con,
 String hostToConnect,
 int portToConnect,
 SocketChannel socketChannel)

Constructs a forwarding channel of the type "forwarded-tcpip"

Parameters:

addressToBind - String

portToBind - int

socketChannel - SocketChannel

Method Details

createChannel

protected byte[] createChannel()
                        throws IOException

Create the forwarding channel.

Specified by:

createChannel in class SocketForwardingChannel<T extends SshContext>

Returns:

byte[]

Throws:

IOException

openChannel

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

Open a forwarding channel.

Specified by:

openChannel in class SocketForwardingChannel<T extends SshContext>

Parameters:

requestdata - byte[]

Returns:

byte[]

Throws:

WriteOperationRequest

ChannelOpenException

readForwarding

protected void readForwarding(com.sshtools.common.util.ByteArrayReader bar)
                       throws IOException

Throws:

IOException

createSocketAddress

protected SocketAddress createSocketAddress()

createSocketChannel

protected SocketChannel createSocketChannel()
                                     throws IOException

Throws:

IOException

checkPermissions

protected boolean checkPermissions()

onRegistrationComplete

protected void onRegistrationComplete()

Called when the forwarded sockets selector has been registered with a {@link com,maverick.nio.SelectorThread}.

Specified by:

onRegistrationComplete in class SocketForwardingChannel<T extends SshContext>

finishConnect

public boolean finishConnect(SelectionKey key)

Called when the forwarded socket has been connected.

Specified by:

finishConnect in interface ClientConnector

Parameters:

key - SelectionKey

Returns:

boolean

onConnectionError

protected void onConnectionError(IOException ex)

onConnectionComplete

protected void onConnectionComplete()

onChannelOpenConfirmation

protected void onChannelOpenConfirmation()

Called when the channel has been confirmed as open.

Specified by:

onChannelOpenConfirmation in class SocketForwardingChannel<T extends SshContext>

onChannelOpenFailure

protected void onChannelOpenFailure()

Either nothing was listening on the clients end of the tunnel, or the connection was rejected. Now we close the connection from the server to the start of the tunnel.

Overrides:

onChannelOpenFailure in class ChannelNG<T extends SshContext>

initialize

public void initialize(ProtocolEngine engine,
 SshEngine daemon,
 SelectableChannel channel)

Description copied from interface: SocketHandler

Initialise this socket with a ProtocolEngine and the current SshEngine.

Specified by:

initialize in interface SocketHandler

Parameters:

engine - ProtocolEngine

daemon - Daemon