com.maverick.sshd

Class RemoteForwardingChannel

java.lang.Object

com.maverick.sshd.Channel

com.maverick.sshd.ForwardingChannel

com.maverick.sshd.SocketForwardingChannel

com.maverick.sshd.RemoteForwardingChannel

All Implemented Interfaces:

SelectionKeyAware, SelectorRegistrationListener, SocketHandler, Runnable

public class RemoteForwardingChannel
extends SocketForwardingChannel

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

Author:

Lee David Painter

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
static String	REMOTE_TYPE
static String	X11_TYPE

Fields inherited from class com.maverick.sshd.ForwardingChannel

hostToConnect, originatingHost, originatingPort, portToConnect

Fields inherited from class com.maverick.sshd.Channel

connection, localwindow, localWindowLock

Constructor Summary

Constructors

Modifier	Constructor and Description
	RemoteForwardingChannel(String addressToBind, int portToBind, SocketChannel socketChannel) Constructs a forwarding channel of the type "forwarded-tcpip"
protected	RemoteForwardingChannel(String name, String addressToBind, int portToBind, SocketChannel socketChannel)

Method Summary

Modifier and Type	Method and Description
protected byte[]	createChannel() Creates the end of the channelopenmessage string address that was connected uint32 port that was connected string originator IP address uint32 originator port
String	getUuid()
protected void	onChannelOpenConfirmation() Called when the channel has been confirmed as open by the remote side - this method is only called when the channel has been requested by this side of the connection
protected void	onChannelOpenFailure() Either nothing was listening on the clients end of the tunnel, or the connection was rejected.
protected void	onRegistrationComplete() Called by the subsystem when the selector registration has been completed.
protected void	onRemoteEOF() Called when the remote side is EOF.
protected byte[]	openChannel(byte[] requestdata) Called when the channel is being opened.

Methods inherited from class com.maverick.sshd.SocketForwardingChannel

canClose, canClose, evaluateClosure, evaluateWindowSpace, getInterestedOps, initialize, onChannelClosed, onChannelClosing, onChannelData, onChannelFree, onChannelOpen, onChannelRequest, onExtendedData, onLocalEOF, onRemoteClose, onWindowAdjust, processReadEvent, processWriteEvent, registrationCompleted, run, setSelectionKey, setThread, shutdownSocket

Methods inherited from class com.maverick.sshd.ForwardingChannel

getHost, getOriginatingHost, getOriginatingPort, getPort

Methods inherited from class com.maverick.sshd.Channel

addEventListener, addInputListener, addOutputListener, clearIdleState, close, close, consumeWindowSpace, createCloseTask, executeTask, getChannelType, getConnection, getContext, getLocalId, getLocalPacket, getLocalWindow, getQueueSize, getRemoteId, getRemotePacket, getRemoteWindow, getSessionIdentifier, isClosed, isClosing, isEOF, isOpen, isSelfManagedWindowSpace, markEOF, 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

REMOTE_TYPE

public static final String REMOTE_TYPE

See Also:

Constant Field Values

X11_TYPE

public static final String X11_TYPE

See Also:

Constant Field Values

Constructor Detail

RemoteForwardingChannel

public RemoteForwardingChannel(String addressToBind,
                               int portToBind,
                               SocketChannel socketChannel)

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

Parameters:

addressToBind - String

portToBind - int

socketChannel - SocketChannel

RemoteForwardingChannel

protected RemoteForwardingChannel(String name,
                                  String addressToBind,
                                  int portToBind,
                                  SocketChannel socketChannel)

Parameters:

name -

addressToBind -

portToBind -

socketChannel -

Method Detail

createChannel

protected byte[] createChannel()
                        throws IOException

Creates the end of the channelopenmessage string address that was connected uint32 port that was connected string originator IP address uint32 originator port

Specified by:

createChannel in class SocketForwardingChannel

Returns:

byte[], the end of the channelopenmessage

Throws:

IOException

onRemoteEOF

protected void onRemoteEOF()

Called when the remote side is EOF.

Overrides:

onRemoteEOF in class SocketForwardingChannel

onRegistrationComplete

protected void onRegistrationComplete()

Description copied from class: SocketForwardingChannel

Called by the subsystem when the selector registration has been completed.

Specified by:

onRegistrationComplete in class SocketForwardingChannel

onChannelOpenConfirmation

protected void onChannelOpenConfirmation()

Description copied from class: Channel

Called when the channel has been confirmed as open by the remote side - this method is only called when the channel has been requested by this side of the connection

Specified by:

onChannelOpenConfirmation in class SocketForwardingChannel

openChannel

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

Description copied from class: Channel

Called when the channel is being opened. You can retrun data to be sent in the channel open confirmation message, or null for none.

Specified by:

openChannel in class SocketForwardingChannel

Returns:

byte[]

Throws:

WriteOperationRequest

ChannelOpenException

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 Channel

getUuid

public String getUuid()