com.maverick.sshd

Class LocalForwardingChannel

java.lang.Object

com.maverick.sshd.Channel

com.maverick.sshd.ForwardingChannel

com.maverick.sshd.SocketForwardingChannel

com.maverick.sshd.LocalForwardingChannel

All Implemented Interfaces:

ClientConnector, SelectionKeyAware, SelectorRegistrationListener, SocketHandler, Runnable

public class LocalForwardingChannel
extends SocketForwardingChannel
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.

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	CHANNEL_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

Constructor and Description
LocalForwardingChannel() Constructs a forwarding channel of the type "direct-tcpip"

Method Summary

Modifier and Type	Method and Description
protected boolean	checkPermissions() Performs permission check with the ForwardingPolicy.
protected byte[]	createChannel() Create the forwarding channel.
boolean	finishConnect(SelectionKey key) Called when the forwarded socket has been connected.
String	getUuid()
protected void	onChannelOpenConfirmation() Called when the channel has been confirmed as open.
protected void	onConnectionComplete()
protected void	onConnectionError(IOException e)
protected void	onRegistrationComplete() Called when the forwarded sockets selector has been registered with a com,maverick.nio.SelectorThread.
protected byte[]	openChannel(byte[] requestdata) Open a forwarding channel.

Methods inherited from class com.maverick.sshd.SocketForwardingChannel

canClose, canClose, evaluateClosure, evaluateWindowSpace, getInterestedOps, initialize, onChannelClosed, onChannelClosing, onChannelData, onChannelFree, onChannelOpen, onChannelRequest, onExtendedData, onLocalEOF, onRemoteClose, onRemoteEOF, 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, onChannelOpenFailure, 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

Methods inherited from interface com.maverick.nio.SelectorRegistrationListener

registrationCompleted

Field Detail

CHANNEL_TYPE

public static final String CHANNEL_TYPE

See Also:

Constant Field Values

Constructor Detail

LocalForwardingChannel

public LocalForwardingChannel()

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

Method Detail

createChannel

protected byte[] createChannel()

Create the forwarding channel.

Specified by:

createChannel in class SocketForwardingChannel

Returns:

byte[]

openChannel

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

Open a forwarding channel.

Specified by:

openChannel in class SocketForwardingChannel

Parameters:

requestdata - byte[]

Returns:

byte[]

Throws:

WriteOperationRequest

ChannelOpenException

checkPermissions

protected boolean checkPermissions()

Performs permission check with the ForwardingPolicy.

Returns:

onRegistrationComplete

protected void onRegistrationComplete()

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

Specified by:

onRegistrationComplete in class SocketForwardingChannel

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

onConnectionComplete

protected void onConnectionComplete()

onConnectionError

protected void onConnectionError(IOException e)

onChannelOpenConfirmation

protected void onChannelOpenConfirmation()

Called when the channel has been confirmed as open.

Specified by:

onChannelOpenConfirmation in class SocketForwardingChannel

getUuid

public String getUuid()

Specified by:

getUuid in interface SocketHandler