Package org.apache.sshd.common.forward

Class ChannelToPortHandler

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.forward.ChannelToPortHandler

public class ChannelToPortHandler
extends AbstractLoggingBean

Implements forwarding messages received from a channel to a port in TCP/IP port forwarding.

Field Summary

Fields

Modifier and Type	Field	Description
private Channel	channel
private IoSession	port

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor	Description
ChannelToPortHandler(IoSession port, Channel channel)

Method Summary

Modifier and Type	Method	Description
private void	checkWindow(byte cmd, long len)
IoSession	getPortSession()	Retrieves the IoSession for the port connection.
void	handleEof()	Perform appropriate actions on the port session when the channel received an SSH_MSG_CHANNEL_EOF message.
protected void	handleWriteDataFailure(byte cmd, byte[] data, int off, int len, java.lang.Throwable t)
protected void	handleWriteDataSuccess(byte cmd, byte[] data, int off, int len)
void	sendToPort(byte cmd, byte[] data, int off, long len)	Forwards data received on the SSH channel to the port and adjust the channel window once the data has been written.
IoWriteFuture	sendToPort(Buffer buffer)	Write data to the port directly without adjusting the channel window.

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

port

private final IoSession port

channel

private final Channel channel

Constructor Detail

ChannelToPortHandler

public ChannelToPortHandler(IoSession port,
                            Channel channel)

Method Detail

getPortSession

public IoSession getPortSession()

Retrieves the IoSession for the port connection.

Returns:

the IoSession, never null

handleEof

public void handleEof()
               throws java.io.IOException

Perform appropriate actions on the port session when the channel received an SSH_MSG_CHANNEL_EOF message.

Throws:

java.io.IOException

sendToPort

public IoWriteFuture sendToPort(Buffer buffer)
                         throws java.io.IOException

Write data to the port directly without adjusting the channel window.

Parameters:

buffer - data to write to the port

Returns:

an IoWriteFuture fulfilled once the data has been written

Throws:

java.io.IOException - if an error occurs

sendToPort

public void sendToPort(byte cmd,
                       byte[] data,
                       int off,
                       long len)
                throws java.io.IOException

Forwards data received on the SSH channel to the port and adjust the channel window once the data has been written.

Parameters:

cmd - the SSH command, typically @link SshConstants#SSH_MSG_CHANNEL_DATA}, used for logging only

data - to forward

off - offset in data of the start of the data to forward

len - number of bytes to forward

Throws:

java.io.IOException - if an error occurs

handleWriteDataSuccess

protected void handleWriteDataSuccess(byte cmd,
                                      byte[] data,
                                      int off,
                                      int len)

handleWriteDataFailure

protected void handleWriteDataFailure(byte cmd,
                                      byte[] data,
                                      int off,
                                      int len,
                                      java.lang.Throwable t)

checkWindow

private void checkWindow(byte cmd,
                         long len)