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, AttributeRepository, AttributeStore, Channel, ChannelIdentifier, ChannelListenerManager, ChannelStreamWriterResolver, ChannelStreamWriterResolverManager, Closeable, PropertyResolver, SessionContextHolder, SessionHolder<Session>, ExecutorServiceCarrier, 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 AbstractChannel

AbstractChannel.GracefulChannelCloseable, AbstractChannel.GracefulState, AbstractChannel.PacketValidator

Nested classes/interfaces inherited from class AbstractCloseable

AbstractCloseable.State

Nested classes/interfaces inherited from interface AttributeRepository

AttributeRepository.AttributeKey<T>

Field Summary

Fields

Modifier and Type	Field	Description
private String	authSocket
private Future<?>	forwarder
private CloseableExecutorService	forwardService
private long	handle
private OutputStream	out
private long	pool

Fields inherited from class AbstractServerChannel

exitStatusSent

Fields inherited from class AbstractChannel

channelListenerProxy, channelListeners, closeSignaled, DEFAULT_PACKET_VALIDATOR, eofReceived, eofSent, gracefulFuture, gracefulState, initialized, RESPONSE_BUFFER_GROWTH_FACTOR, service, unregisterSignaled

Fields inherited from class AbstractCloseable

closeFuture, futureLock, state

Fields inherited from class AbstractLoggingBean

log

Fields inherited from interface Channel

CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM

Fields inherited from interface ChannelStreamWriterResolver

NONE

Fields inherited from interface PropertyResolver

EMPTY

Constructor Summary

Constructors

Constructor	Description
ChannelAgentForwarding(CloseableExecutorService executor)

Method Summary

Modifier and Type	Method	Description
private void	closeImmediately0()
protected OpenFuture	doInit(Buffer buffer)
protected void	doWriteData(byte[] data, int off, long len)
protected void	doWriteExtendedData(byte[] data, int off, long len)
protected Closeable	getInnerCloseable()
private static void	throwException(int code)	transform an APR error number in a more fancy exception

Methods inherited from class AbstractServerChannel

handleOpenFailure, handleOpenSuccess, open, sendExitStatus

Methods inherited from class AbstractChannel

addChannelListener, addPendingRequest, addRequestHandler, attributeKeys, clearAttributes, computeAttributeIfAbsent, configureWindow, getAttribute, getAttributesCount, getChannelId, getChannelListenerProxy, getChannelStreamWriterResolver, getExecutorService, getLocalWindow, getPacketValidator, getParentPropertyResolver, getProperties, getRecipient, getRemoteWindow, getRequestHandlers, getSession, handleChannelRegistrationResult, handleChannelRequest, handleChannelUnregistration, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleInternalRequest, handleRequest, handleSuccess, handleUnknownChannelRequest, handleWindowAdjust, init, invokeChannelSignaller, isEofSent, isEofSignalled, isInitialized, mayWrite, notifyStateChanged, notifyStateChanged, preClose, removeAttribute, removeChannelListener, removePendingRequest, removeRequestHandler, resolveChannelStreamWriterResolver, sendEof, sendResponse, sendWindowAdjust, setAttribute, setChannelStreamWriterResolver, setPacketValidator, setRecipient, signalChannelClosed, signalChannelClosed, signalChannelInitialized, signalChannelInitialized, signalChannelOpenFailure, signalChannelOpenFailure, signalChannelOpenSuccess, signalChannelOpenSuccess, toString, validateIncomingDataSize, writePacket

Methods inherited from class AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

Methods inherited from class AbstractCloseable

addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, removeCloseFutureListener

Methods inherited from class 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 Object

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

Methods inherited from interface AttributeRepository

attributeKeys, getAttribute, getAttributesCount

Methods inherited from interface AttributeStore

clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

Methods inherited from interface Channel

addRequestHandler, addRequestHandlers, getLocalWindow, getRecipient, getRemoteWindow, getRequestHandlers, handleChannelRegistrationResult, handleChannelUnregistration, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleRequest, handleSuccess, handleWindowAdjust, init, isEofSignalled, isInitialized, removeRequestHandler, removeRequestHandlers, resolveAttribute, writePacket

Methods inherited from interface ChannelIdentifier

getChannelId

Methods inherited from interface ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface ChannelStreamWriterResolverManager

getChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolver

Methods inherited from interface Closeable

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

Methods inherited from interface PropertyResolver

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

Methods inherited from interface ServerChannel

getServerSession

Methods inherited from interface SessionHolder

getSession, getSessionContext

Field Details

authSocket

private String authSocket

pool

private long pool

handle

private long handle

out

private OutputStream out

forwardService

private CloseableExecutorService forwardService

forwarder

private Future<?> forwarder

Constructor Details

ChannelAgentForwarding

public ChannelAgentForwarding(CloseableExecutorService executor)

Method Details

doInit

protected OpenFuture doInit(Buffer buffer)

Overrides:

doInit in class AbstractServerChannel

closeImmediately0

private void closeImmediately0()

getInnerCloseable

protected Closeable getInnerCloseable()

Overrides:

getInnerCloseable in class AbstractChannel

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

throwException

private static void throwException(int code)
                            throws IOException

transform an APR error number in a more fancy exception

Parameters:

code - APR error code

Throws:

IOException - the produced exception for the given APR error number