Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	TcpipServerChannel.PortIoHandler
public abstract static class	TcpipServerChannel.TcpipFactory

Modifier and Type	Field and Description
private IoConnector	connector
private SocketAddress	localAddress
private SshdSocketAddress	originatorAddress
private ChannelAsyncOutputStream	out
private ChannelToPortHandler	port
private SshdSocketAddress	tunnelEntrance
private SshdSocketAddress	tunnelExit
private final TcpForwardingFilter.Type	type

Constructor Summary

Access	Constructor and Description
public	TcpipServerChannel(TcpForwardingFilter.Type type, CloseableExecutorService executor)

Modifier and Type	Method and Description
protected ChannelToPortHandler	createChannelToPortHandler(IoSession session)
protected OpenFuture	doInit(Buffer buffer) Overrides org.apache.sshd.server.channel.AbstractServerChannel.doInit.
protected void	doWriteData(byte[] data, int off, long len) Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteData.
protected void	doWriteExtendedData(byte[] data, int off, long len) Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteExtendedData.
protected Closeable	getInnerCloseable() Overrides org.apache.sshd.common.channel.AbstractChannel.getInnerCloseable.
public SocketAddress	getLocalAddress()
public SshdSocketAddress	getOriginatorAddress()
public TcpForwardingFilter.Type	getTcpipChannelType()
public SshdSocketAddress	getTunnelEntrance() Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelEntrance.
public SshdSocketAddress	getTunnelExit() Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelExit.
protected void	handleChannelConnectResult(OpenFuture f, IoConnectFuture future)
protected void	handleChannelOpenFailure(OpenFuture f, Throwable problem)
protected void	handleChannelOpenSuccess(OpenFuture f, IoSession session)
public void	handleEof() Overrides org.apache.sshd.common.channel.AbstractChannel.handleEof. Implements org.apache.sshd.common.channel.Channel.handleEof. Invoked when `SSH_MSG_CHANNEL_EOF` received
public void	handleWindowAdjust(Buffer The rest of the message data `Buffer` after decoding the channel identifiers buffer) Overrides org.apache.sshd.common.channel.AbstractChannel.handleWindowAdjust. Implements org.apache.sshd.common.channel.Channel.handleWindowAdjust. Invoked when `SSH_MSG_CHANNEL_WINDOW_ADJUST` received
protected boolean	mayWrite() Overrides org.apache.sshd.common.channel.AbstractChannel.mayWrite.
public void	setLocalAddress(SocketAddress localAddress)

Field Detail

connector	back to summary
private IoConnector connector

localAddress	back to summary
private SocketAddress localAddress

originatorAddress	back to summary
private SshdSocketAddress originatorAddress

out	back to summary
private ChannelAsyncOutputStream out

port	back to summary
private ChannelToPortHandler port

tunnelEntrance	back to summary
private SshdSocketAddress tunnelEntrance

tunnelExit	back to summary
private SshdSocketAddress tunnelExit

type	back to summary
private final TcpForwardingFilter.Type type

Constructor Detail

TcpipServerChannel	back to summary
public TcpipServerChannel(TcpForwardingFilter.Type type, CloseableExecutorService executor)

Method Detail

createChannelToPortHandler	back to summary
protected ChannelToPortHandler createChannelToPortHandler(IoSession session)

doInit	back to summary
protected OpenFuture doInit(Buffer buffer) Overrides org.apache.sshd.server.channel.AbstractServerChannel.doInit. Annotations @Override

doInit

back to summary

protected OpenFuture doInit(Buffer buffer)

Overrides org.apache.sshd.server.channel.AbstractServerChannel.doInit.

Annotations

@Override

doWriteData	back to summary
protected void doWriteData(byte[] data, int off, long len) throws IOException Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteData. Annotations @Override

doWriteData

back to summary

protected void doWriteData(byte[] data, int off, long len) throws IOException

Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteData.

Annotations

@Override

doWriteExtendedData	back to summary
protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteExtendedData. Annotations @Override

doWriteExtendedData

back to summary

protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException

Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteExtendedData.

Annotations

@Override

getInnerCloseable	back to summary
protected Closeable getInnerCloseable() Overrides org.apache.sshd.common.channel.AbstractChannel.getInnerCloseable. Annotations @Override

getInnerCloseable

back to summary

protected Closeable getInnerCloseable()

Overrides org.apache.sshd.common.channel.AbstractChannel.getInnerCloseable.

Annotations

@Override

getLocalAddress	back to summary
public SocketAddress getLocalAddress()

getOriginatorAddress	back to summary
public SshdSocketAddress getOriginatorAddress()

getTcpipChannelType	back to summary
public TcpForwardingFilter.Type getTcpipChannelType()

getTunnelEntrance	back to summary
public SshdSocketAddress getTunnelEntrance() Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelEntrance. Annotations @Override

getTunnelEntrance

back to summary

public SshdSocketAddress getTunnelEntrance()

Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelEntrance.

Annotations

@Override

getTunnelExit	back to summary
public SshdSocketAddress getTunnelExit() Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelExit. Annotations @Override

getTunnelExit

back to summary

public SshdSocketAddress getTunnelExit()

Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelExit.

Annotations

@Override

handleChannelConnectResult	back to summary
protected void handleChannelConnectResult(OpenFuture f, IoConnectFuture future)

handleChannelOpenFailure	back to summary
protected void handleChannelOpenFailure(OpenFuture f, Throwable problem)

handleChannelOpenSuccess	back to summary
protected void handleChannelOpenSuccess(OpenFuture f, IoSession session)

handleEof back to summary

handleEof	back to summary
public void handleEof() throws IOException Overrides org.apache.sshd.common.channel.AbstractChannel.handleEof. Implements org.apache.sshd.common.channel.Channel.handleEof. Doc from org.apache.sshd.common.channel.Channel.handleEof. Invoked when `SSH_MSG_CHANNEL_EOF` received Annotations @Override Exceptions IOException: If failed to handle the message

public void handleEof() throws IOException

Overrides org.apache.sshd.common.channel.AbstractChannel.handleEof.

Implements org.apache.sshd.common.channel.Channel.handleEof.

Doc from org.apache.sshd.common.channel.Channel.handleEof.

Invoked when SSH_MSG_CHANNEL_EOF received

Annotations

@Override

Exceptions

IOException:: If failed to handle the message

handleWindowAdjust back to summary

handleWindowAdjust	back to summary
public void handleWindowAdjust(Buffer buffer) throws IOException Overrides org.apache.sshd.common.channel.AbstractChannel.handleWindowAdjust. Implements org.apache.sshd.common.channel.Channel.handleWindowAdjust. Doc from org.apache.sshd.common.channel.Channel.handleWindowAdjust. Invoked when `SSH_MSG_CHANNEL_WINDOW_ADJUST` received Parameters buffer:Buffer The rest of the message data `Buffer` after decoding the channel identifiers Annotations @Override Exceptions IOException: If failed to handle the message

public void handleWindowAdjust(Buffer buffer) throws IOException

Overrides org.apache.sshd.common.channel.AbstractChannel.handleWindowAdjust.

Implements org.apache.sshd.common.channel.Channel.handleWindowAdjust.

Doc from org.apache.sshd.common.channel.Channel.handleWindowAdjust.

Invoked when SSH_MSG_CHANNEL_WINDOW_ADJUST received

Parameters

buffer:Buffer: The rest of the message data Buffer after decoding the channel identifiers

Annotations

@Override

Exceptions

IOException:: If failed to handle the message

mayWrite	back to summary
protected boolean mayWrite() Overrides org.apache.sshd.common.channel.AbstractChannel.mayWrite. Annotations @Override

mayWrite

back to summary

protected boolean mayWrite()

Overrides org.apache.sshd.common.channel.AbstractChannel.mayWrite.

Annotations

@Override

setLocalAddress	back to summary
public void setLocalAddress(SocketAddress localAddress)

Access	Constructor and Description
pack-priv	PortIoHandler()

Modifier and Type	Method and Description
public void	exceptionCaught(IoSession session, Throwable cause) Implements org.apache.sshd.common.io.IoHandler.exceptionCaught.
public void	messageReceived(IoSession session, Readable message) Implements org.apache.sshd.common.io.IoHandler.messageReceived.
public void	sessionClosed(IoSession session) Implements org.apache.sshd.common.io.IoHandler.sessionClosed.
public void	sessionCreated(IoSession session) Implements org.apache.sshd.common.io.IoHandler.sessionCreated.

Constructor Detail

PortIoHandler	back to summary
pack-priv PortIoHandler()

Method Detail

exceptionCaught	back to summary
public void exceptionCaught(IoSession session, Throwable cause) throws Exception Implements org.apache.sshd.common.io.IoHandler.exceptionCaught. Annotations @Override

exceptionCaught

back to summary

public void exceptionCaught(IoSession session, Throwable cause) throws Exception

Implements org.apache.sshd.common.io.IoHandler.exceptionCaught.

Annotations

@Override

messageReceived	back to summary
public void messageReceived(IoSession session, Readable message) throws Exception Implements org.apache.sshd.common.io.IoHandler.messageReceived. Annotations @Override

messageReceived

back to summary

public void messageReceived(IoSession session, Readable message) throws Exception

Implements org.apache.sshd.common.io.IoHandler.messageReceived.

Annotations

@Override

sessionClosed	back to summary
public void sessionClosed(IoSession session) throws Exception Implements org.apache.sshd.common.io.IoHandler.sessionClosed. Annotations @Override

sessionClosed

back to summary

public void sessionClosed(IoSession session) throws Exception

Implements org.apache.sshd.common.io.IoHandler.sessionClosed.

Annotations

@Override

sessionCreated	back to summary
public void sessionCreated(IoSession session) throws Exception Implements org.apache.sshd.common.io.IoHandler.sessionCreated. Annotations @Override

sessionCreated

back to summary

public void sessionCreated(IoSession session) throws Exception

Implements org.apache.sshd.common.io.IoHandler.sessionCreated.

Annotations

@Override

org.apache.sshd.server.forward back to summary

public abstract Class TcpipServerChannel.TcpipFactory

Class Inheritance

extends Object
implements ChannelFactory, ExecutorServiceCarrier

java.lang.Object
org.apache.sshd.server.forward.TcpipServerChannel.TcpipFactory

All Implemented Interfaces

org.apache.sshd.common.util.threads.ExecutorServiceCarrier, org.apache.sshd.common.channel.ChannelFactory, org.apache.sshd.common.NamedResource

Known Direct Subclasses

org.apache.sshd.server.forward.DirectTcpipFactory, org.apache.sshd.server.forward.ForwardedTcpipFactory

Field Summary

Modifier and Type	Field and Description
private final TcpForwardingFilter.Type	type

Constructor Summary

Access	Constructor and Description
protected	TcpipFactory(TcpForwardingFilter.Type type)

Method Summary

Modifier and Type	Method and Description
public Channel	createChannel(Session The `Session` through which the request is made session) Implements org.apache.sshd.common.channel.ChannelFactory.createChannel.
public CloseableExecutorService	getExecutorService() Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.
public final String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public final TcpForwardingFilter.Type	getType()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

type	back to summary
private final TcpForwardingFilter.Type type

Constructor Detail

TcpipFactory	back to summary
protected TcpipFactory(TcpForwardingFilter.Type type)

Method Detail

createChannel back to summary

createChannel	back to summary
public Channel createChannel(Session session) throws IOException Implements org.apache.sshd.common.channel.ChannelFactory.createChannel. Parameters session:Session Doc from org.apache.sshd.common.channel.ChannelFactory.createChannel. The `Session` through which the request is made Returns:Channel Doc from org.apache.sshd.common.channel.ChannelFactory.createChannel. The relevant `Channel` Annotations @Override Exceptions IOException: Doc from org.apache.sshd.common.channel.ChannelFactory.createChannel. If failed to create the requested instance

public Channel createChannel(Session session) throws IOException

Implements org.apache.sshd.common.channel.ChannelFactory.createChannel.

Parameters

session:Session

Doc from org.apache.sshd.common.channel.ChannelFactory.createChannel.

The Session through which the request is made

Returns:Channel

Doc from org.apache.sshd.common.channel.ChannelFactory.createChannel.

The relevant Channel

Annotations

@Override

Exceptions

IOException:

Doc from org.apache.sshd.common.channel.ChannelFactory.createChannel.

If failed to create the requested instance

getExecutorService back to summary

getExecutorService	back to summary
public CloseableExecutorService getExecutorService() Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService. Returns:CloseableExecutorService Doc from org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService. The `CloseableExecutorService` to use Annotations @Override

public CloseableExecutorService getExecutorService()

Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.

Returns:CloseableExecutorService

Doc from org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.

The CloseableExecutorService to use

Annotations

@Override

getName	back to summary
public final String getName() Implements org.apache.sshd.common.NamedResource.getName. Returns:String Doc from org.apache.sshd.common.NamedResource.getName. The resource name Annotations @Override

getName

back to summary

public final String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations

@Override

getType	back to summary
public final TcpForwardingFilter.Type getType()

public Class TcpipServerChannel

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class TcpipServerChannel.PortIoHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public abstract Class TcpipServerChannel.TcpipFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail