org.apache.sshd.agent.unix

Class ChannelAgentForwarding

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.server.channel.AbstractServerChannel

org.apache.sshd.agent.unix.ChannelAgentForwarding

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, AttributeStore, ChannelListenerManager, PropertyResolver, ExecutorServiceCarrier, ExecutorServiceConfigurer, ServerChannel, ServerSessionHolder

public class ChannelAgentForwarding
extends AbstractServerChannel

The client side channel that will receive requests forwards by the SSH server.

Nested Class Summary

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.common.AttributeStore

AttributeStore.AttributeKey<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FORWARDER_BUF_SIZE
static String	FORWARDER_BUFFER_SIZE Property that can be set on the factory manager in order to control the buffer size used to forward data from the established channel
static int	MAX_FORWARDER_BUF_SIZE
static int	MIN_FORWARDER_BUF_SIZE

Fields inherited from class org.apache.sshd.server.channel.AbstractServerChannel

exitStatusSent

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.Closeable

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ChannelAgentForwarding()

Method Summary

Modifier and Type	Method and Description
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
protected OpenFuture	doInit(Buffer buffer)
protected void	doWriteData(byte[] data, int off, long len)
protected void	doWriteExtendedData(byte[] data, int off, long len)

Methods inherited from class org.apache.sshd.server.channel.AbstractServerChannel

getServerSession, handleOpenFailure, handleOpenSuccess, open, sendExitStatus

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

addChannelListener, addPendingRequest, addRequestHandler, configureWindow, doCloseImmediately, getAttribute, getChannelListenerProxy, getExecutorService, getId, getInnerCloseable, getLocalWindow, getParentPropertyResolver, getProperties, getRecipient, getRemoteWindow, getRequestHandlers, getSession, handleChannelRequest, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleInternalRequest, handleRequest, handleSuccess, handleUnknownChannelRequest, handleWindowAdjust, init, invokeChannelSignaller, isEofSent, isEofSignalled, isInitialized, isShutdownOnExit, notifyStateChanged, notifyStateChanged, preClose, removeAttribute, removeChannelListener, removePendingRequest, removeRequestHandler, resolveAttribute, sendEof, sendResponse, sendWindowAdjust, setAttribute, setExecutorService, setRecipient, setShutdownOnExit, signalChannelClosed, signalChannelClosed, signalChannelInitialized, signalChannelInitialized, signalChannelOpenFailure, signalChannelOpenFailure, signalChannelOpenSuccess, signalChannelOpenSuccess, toString, validateIncomingDataSize, writePacket

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

doCloseGracefully

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

addCloseFutureListener, builder, 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.common.channel.Channel

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

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

getAttribute, removeAttribute, resolveAttribute, resolveAttribute, resolveAttribute, resolveAttribute, setAttribute

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

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

Field Detail

FORWARDER_BUFFER_SIZE

public static final String FORWARDER_BUFFER_SIZE

Property that can be set on the factory manager in order to control the buffer size used to forward data from the established channel

See Also:

MIN_FORWARDER_BUF_SIZE, MAX_FORWARDER_BUF_SIZE, DEFAULT_FORWARDER_BUF_SIZE, Constant Field Values

MIN_FORWARDER_BUF_SIZE

public static final int MIN_FORWARDER_BUF_SIZE

See Also:

Constant Field Values

DEFAULT_FORWARDER_BUF_SIZE

public static final int DEFAULT_FORWARDER_BUF_SIZE

See Also:

Constant Field Values

MAX_FORWARDER_BUF_SIZE

public static final int MAX_FORWARDER_BUF_SIZE

See Also:

Constant Field Values

Constructor Detail

ChannelAgentForwarding

public ChannelAgentForwarding()

Method Detail

doInit

protected OpenFuture doInit(Buffer buffer)

Overrides:

doInit in class AbstractServerChannel

close

public CloseFuture close(boolean immediately)

Description copied from interface: Closeable

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Overrides:

close in class AbstractChannel

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a CloseFuture representing the close request

doWriteData

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

Specified by:

doWriteData in class AbstractChannel

Throws:

IOException

doWriteExtendedData

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

Specified by:

doWriteExtendedData in class AbstractChannel

Throws:

IOException