Class AgentForwardedChannel

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.agent.local.AgentForwardedChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ClientChannel, ClientSessionHolder, org.apache.sshd.common.AttributeRepository, org.apache.sshd.common.AttributeStore, Channel, ChannelIdentifier, ChannelListenerManager, StreamingChannel, ChannelStreamWriterResolver, ChannelStreamWriterResolverManager, org.apache.sshd.common.Closeable, org.apache.sshd.common.PropertyResolver, org.apache.sshd.common.session.SessionContextHolder, SessionHolder<Session>, org.apache.sshd.common.util.threads.ExecutorServiceCarrier

public class AgentForwardedChannel
extends AbstractClientChannel

Nested Class Summary

Nested classes/interfaces inherited from class AbstractChannel

AbstractChannel.GracefulChannelCloseable, AbstractChannel.GracefulState, AbstractChannel.PacketValidator

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

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

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

org.apache.sshd.common.AttributeRepository.AttributeKey<T>

Nested classes/interfaces inherited from interface StreamingChannel

StreamingChannel.Streaming

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_MESSAGE_POLL_FREQUENCY	Default value for "agent-fwd-channel-message-poll-time"
static final String	MESSAGE_POLL_FREQUENCY	Time to wait for new incoming messages before checking if the channel is still active

Fields inherited from class AbstractClientChannel

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

Fields inherited from class AbstractChannel

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

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

closeFuture, futureLock, state

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

log

Fields inherited from interface Channel

CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM

Fields inherited from interface ChannelStreamWriterResolver

NONE

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
AgentForwardedChannel(String channelType)

Method Summary

Modifier and Type	Method	Description
protected void	doOpen()
protected void	doWriteData(byte[] data, int off, long len)
SshAgent	getAgent()
protected org.apache.sshd.common.util.buffer.Buffer	request(org.apache.sshd.common.util.buffer.Buffer buffer)
protected org.apache.sshd.common.util.buffer.Buffer	waitForMessageBuffer()

Methods inherited from class AbstractClientChannel

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

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, init, invokeChannelSignaller, isEofSent, isEofSignalled, isInitialized, notifyStateChanged, preClose, removeAttribute, removeChannelListener, removePendingRequest, removeRequestHandler, resolveChannelStreamWriterResolver, sendEof, sendResponse, sendWindowAdjust, setAttribute, setChannelStreamWriterResolver, setPacketValidator, setRecipient, signalChannelClosed, signalChannelInitialized, signalChannelOpenFailure, 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, getFutureLock, isClosed, isClosing, removeCloseFutureListener

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 Object

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

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

attributeKeys, getAttribute, getAttributesCount

Methods inherited from interface org.apache.sshd.common.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, 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 ClientChannel

getClientSession, waitFor

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

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

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

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

Methods inherited from interface SessionHolder

getSession, getSessionContext

Field Details

MESSAGE_POLL_FREQUENCY

public static final String MESSAGE_POLL_FREQUENCY

Time to wait for new incoming messages before checking if the channel is still active

See Also:

• Constant Field Values

DEFAULT_MESSAGE_POLL_FREQUENCY

public static final long DEFAULT_MESSAGE_POLL_FREQUENCY

Default value for "agent-fwd-channel-message-poll-time"

Constructor Details

AgentForwardedChannel

public AgentForwardedChannel(String channelType)

Method Details

getAgent

public SshAgent getAgent()

request

protected org.apache.sshd.common.util.buffer.Buffer request(org.apache.sshd.common.util.buffer.Buffer buffer)
                                                     throws IOException

Throws:

IOException

waitForMessageBuffer

protected org.apache.sshd.common.util.buffer.Buffer waitForMessageBuffer()
                                                                  throws IOException

Throws:

IOException

doOpen

protected void doOpen()
               throws IOException

Specified by:

doOpen in class AbstractClientChannel

Throws:

IOException

doWriteData

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

Overrides:

doWriteData in class AbstractClientChannel

Throws:

IOException