org.apache.sshd.common.forward

Class TcpipClientChannel

java.lang.Object

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

org.apache.sshd.common.util.closeable.IoBaseCloseable

org.apache.sshd.common.util.closeable.AbstractCloseable

org.apache.sshd.common.util.closeable.AbstractInnerCloseable

org.apache.sshd.common.channel.AbstractChannel

org.apache.sshd.client.channel.AbstractClientChannel

org.apache.sshd.common.forward.TcpipClientChannel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel, ClientChannel, ClientSessionHolder, AttributeRepository, AttributeStore, ChannelListenerManager, ChannelStreamPacketWriterResolver, ChannelStreamPacketWriterResolverManager, ForwardingTunnelEndpointsProvider, PacketWriter, PropertyResolver, ExecutorServiceCarrier

public class TcpipClientChannel
extends AbstractClientChannel
implements ForwardingTunnelEndpointsProvider

TODO Add javadoc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TcpipClientChannel.Type Type of channel being created.

Nested classes/interfaces inherited from class org.apache.sshd.common.channel.AbstractChannel

AbstractChannel.GracefulChannelCloseable, AbstractChannel.GracefulState

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

AbstractCloseable.State

Nested classes/interfaces inherited from interface org.apache.sshd.client.channel.ClientChannel

ClientChannel.Streaming

Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeRepository

AttributeRepository.AttributeKey<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected SshdSocketAddress	localEntry
private ClientChannelPendingMessagesQueue	messagesQueue
protected SshdSocketAddress	remote
protected IoSession	serverSession
private SshdSocketAddress	tunnelEntrance
private SshdSocketAddress	tunnelExit
private TcpipClientChannel.Type	typeEnum

Fields inherited from class org.apache.sshd.client.channel.AbstractClientChannel

asyncErr, asyncIn, asyncOut, err, exitSignalHolder, exitStatusHolder, in, invertedErr, invertedIn, invertedOut, opened, openFailureLang, openFailureMsg, openFailureReason, openFuture, out, streaming

Fields inherited from class org.apache.sshd.common.channel.AbstractChannel

channelListenerProxy, channelListeners, eofReceived, eofSent, gracefulFuture, gracefulState, initialized, RESPONSE_BUFFER_GROWTH_FACTOR, service

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, lock, state

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

log

Fields inherited from interface org.apache.sshd.common.channel.Channel

CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM

Fields inherited from interface org.apache.sshd.common.PropertyResolver

EMPTY

Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolver

NONE

Fields inherited from interface org.apache.sshd.common.Closeable

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
TcpipClientChannel(TcpipClientChannel.Type type, IoSession serverSession, SshdSocketAddress remote)

Method Summary

Modifier and Type	Method and Description
protected void	doOpen()
protected void	doWriteData(byte[] data, int off, long len)
protected void	doWriteExtendedData(byte[] data, int off, long len)
protected Closeable	getInnerCloseable()
OpenFuture	getOpenFuture()
ClientChannelPendingMessagesQueue	getPendingMessagesQueue()
TcpipClientChannel.Type	getTcpipChannelType()
SshdSocketAddress	getTunnelEntrance()
SshdSocketAddress	getTunnelExit()
OpenFuture	open()
protected void	preClose() preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.
void	updateLocalForwardingEntry(LocalForwardingEntry entry)

Methods inherited from class org.apache.sshd.client.channel.AbstractClientChannel

addChannelSignalRequestHandlers, getAsyncErr, getAsyncIn, getAsyncOut, getChannelState, getChannelType, getClientSession, getErr, getExitSignal, getExitStatus, getIn, getInvertedErr, getInvertedIn, getInvertedOut, getOut, getStreaming, handleOpenFailure, handleOpenSuccess, handleWindowAdjust, open, setErr, setIn, setOut, setStreaming, updateCurrentChannelState, waitFor

Methods inherited from class org.apache.sshd.common.channel.AbstractChannel

addChannelListener, addPendingRequest, addRequestHandler, attributeKeys, clearAttributes, computeAttributeIfAbsent, configureWindow, getAttribute, getAttributesCount, getChannelListenerProxy, getChannelStreamPacketWriterResolver, getExecutorService, getId, getLocalWindow, getParentPropertyResolver, getProperties, getRecipient, getRemoteWindow, getRequestHandlers, getSession, handleChannelRequest, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleInternalRequest, handleRequest, handleSuccess, handleUnknownChannelRequest, init, invokeChannelSignaller, isEofSent, isEofSignalled, isInitialized, notifyStateChanged, notifyStateChanged, removeAttribute, removeChannelListener, removePendingRequest, removeRequestHandler, resolveChannelStreamPacketWriterResolver, sendEof, sendResponse, sendWindowAdjust, setAttribute, setChannelStreamPacketWriterResolver, setRecipient, signalChannelClosed, signalChannelClosed, signalChannelInitialized, signalChannelInitialized, signalChannelOpenFailure, signalChannelOpenFailure, signalChannelOpenSuccess, signalChannelOpenSuccess, toString, validateIncomingDataSize, writePacket

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

addCloseFutureListener, builder, close, isClosed, isClosing, removeCloseFutureListener

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

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.client.channel.ClientChannel

validateCommandExitStatusCode

Methods inherited from interface org.apache.sshd.common.channel.Channel

addRequestHandler, addRequestHandlers, getId, getLocalWindow, getRecipient, getRemoteWindow, getRequestHandlers, getSession, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleRequest, handleSuccess, init, isEofSignalled, isInitialized, removeRequestHandler, removeRequestHandlers, resolveAttribute, resolveAttribute

Methods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface org.apache.sshd.common.PropertyResolver

getBoolean, getBooleanProperty, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty

Methods inherited from interface org.apache.sshd.common.AttributeStore

clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

Methods inherited from interface org.apache.sshd.common.AttributeRepository

attributeKeys, getAttribute, getAttributesCount, ofAttributesMap, ofKeyValuePair

Methods inherited from interface org.apache.sshd.common.io.PacketWriter

writePacket

Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolverManager

getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver

Methods inherited from interface org.apache.sshd.common.Closeable

addCloseFutureListener, close, close, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener

Field Detail

remote

protected final SshdSocketAddress remote

serverSession

protected final IoSession serverSession

localEntry

protected SshdSocketAddress localEntry

typeEnum

private final TcpipClientChannel.Type typeEnum

messagesQueue

private final ClientChannelPendingMessagesQueue messagesQueue

tunnelEntrance

private SshdSocketAddress tunnelEntrance

tunnelExit

private SshdSocketAddress tunnelExit

Constructor Detail

TcpipClientChannel

public TcpipClientChannel(TcpipClientChannel.Type type,
                          IoSession serverSession,
                          SshdSocketAddress remote)

Method Detail

getOpenFuture

public OpenFuture getOpenFuture()

getTcpipChannelType

public TcpipClientChannel.Type getTcpipChannelType()

getPendingMessagesQueue

public ClientChannelPendingMessagesQueue getPendingMessagesQueue()

updateLocalForwardingEntry

public void updateLocalForwardingEntry(LocalForwardingEntry entry)

open

public OpenFuture open()
                throws java.io.IOException

Specified by:

open in interface ClientChannel

Overrides:

open in class AbstractClientChannel

Throws:

java.io.IOException

doOpen

protected void doOpen()
               throws java.io.IOException

Specified by:

doOpen in class AbstractClientChannel

Throws:

java.io.IOException

preClose

protected void preClose()

Description copied from class: AbstractCloseable

preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately. When preClose() is called, isClosing() == true

Overrides:

preClose in class AbstractChannel

getInnerCloseable

protected Closeable getInnerCloseable()

Overrides:

getInnerCloseable in class AbstractClientChannel

doWriteData

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

Overrides:

doWriteData in class AbstractClientChannel

Throws:

java.io.IOException

doWriteExtendedData

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

Overrides:

doWriteExtendedData in class AbstractClientChannel

Throws:

java.io.IOException

getTunnelEntrance

public SshdSocketAddress getTunnelEntrance()

Specified by:

getTunnelEntrance in interface ForwardingTunnelEndpointsProvider

getTunnelExit

public SshdSocketAddress getTunnelExit()

Specified by:

getTunnelExit in interface ForwardingTunnelEndpointsProvider