Class AsyncCapableClientChannel

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.client.channel.AsyncCapableClientChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ClientChannel, ClientSessionHolder, AttributeRepository, AttributeStore, Channel, ChannelIdentifier, ChannelListenerManager, StreamingChannel, ChannelStreamWriterResolver, ChannelStreamWriterResolverManager, Closeable, PropertyResolver, SessionContextHolder, SessionHolder<Session>, ExecutorServiceCarrier

Direct Known Subclasses:

ChannelDirectTcpip, ChannelSession

public abstract class AsyncCapableClientChannel
extends AbstractClientChannel

Channel that sets up asynchronous streams, and that pumps an input stream if set via AbstractClientChannel.setIn(InputStream).

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>

Nested classes/interfaces inherited from interface StreamingChannel

StreamingChannel.Streaming

Field Summary

Fields

Modifier and Type	Field	Description
protected Future<?>	pumper
protected CloseableExecutorService	pumperService
protected final boolean	withErrorStream

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, 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

Modifier	Constructor	Description
protected	AsyncCapableClientChannel(String type, boolean withErrorStream)

Method Summary

Modifier and Type	Method	Description
protected void	closeImmediately0()
protected void	doOpen()
protected void	doWriteExtendedData(byte[] data, int off, long len)
IoInputStream	getAsyncErr()
OutputStream	getErr()
protected Closeable	getInnerCloseable()
InputStream	getInvertedErr()	Obtains an InputStream to read received SshConstants.SSH_MSG_CHANNEL_EXTENDED_DATA data directly from the channel.
protected void	pumpInputStream()
protected int	securedRead(InputStream in, int maxChunkSize, byte[] buf, int off, int len)
void	setErr(OutputStream err)	Sets an output stream for the channel to write received SshConstants.SSH_MSG_CHANNEL_EXTENDED_DATA data to.
private <T> T	unsupported(Supplier<? extends T> err)

Methods inherited from class AbstractClientChannel

addChannelSignalRequestHandlers, doWriteData, getAsyncIn, getAsyncOut, getChannelState, getChannelType, getExitSignal, getExitStatus, getIn, getInvertedIn, getInvertedOut, getOut, getStreaming, handleOpenFailure, handleOpenSuccess, handleWindowAdjust, isRedirectErrorStream, mayWrite, open, open, 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, 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, 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 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 SessionHolder

getSession, getSessionContext

Field Details

withErrorStream

protected final boolean withErrorStream

pumperService

protected CloseableExecutorService pumperService

pumper

protected Future<?> pumper

Constructor Details

AsyncCapableClientChannel

protected AsyncCapableClientChannel(String type,
 boolean withErrorStream)

Method Details

unsupported

private <T> T unsupported(Supplier<? extends T> err)

getErr

public OutputStream getErr()

Overrides:

getErr in class AbstractClientChannel

getAsyncErr

public IoInputStream getAsyncErr()

Specified by:

getAsyncErr in interface ClientChannel

Overrides:

getAsyncErr in class AbstractClientChannel

getInvertedErr

public InputStream getInvertedErr()

Description copied from interface: ClientChannel

Obtains an InputStream to read received SshConstants.SSH_MSG_CHANNEL_EXTENDED_DATA data directly from the channel. This is an alternative to ClientChannel.setErr(OutputStream). If the error stream is redirected to the output stream via setRedirectErrorStream(true), the returned stream will not receive any data and be always at EOF.

When the channel closes, it will not close the returned stream. It is the caller's responsibility to close the returned stream if needed. Closing the stream while the channel is open may cause the channel to be closed forcibly if more data arrives. The stream remains open after the channel has closed, so that the caller can read the last arrived data even afterwards.

As with all external processes, the application should read this stream (unless it was redirected) to avoid that the channel blocks when the stream's buffer is full. The buffer size for the returned stream is bounded by the channel's local window size. If the caller does not read this stream, the channel will block once the local window is exhausted.

This method should be called only after the channel has been opened.

Specified by:

getInvertedErr in interface ClientChannel

Overrides:

getInvertedErr in class AbstractClientChannel

Returns:

an InputStream for reading received data, or null if an output stream was set via ClientChannel.setErr(OutputStream)

See Also:

• ClientChannel.setErr(OutputStream)
• ClientChannel.setRedirectErrorStream(boolean)

setErr

public void setErr(OutputStream err)

Description copied from interface: ClientChannel

Sets an output stream for the channel to write received SshConstants.SSH_MSG_CHANNEL_EXTENDED_DATA data to. For remote command execution, this is typically the remote command's stderr.

The stream must be set before the channel is opened. When the channel closes, it will close the given stream.

If no stream is set by the time the channel is opened, the channel will internally forward data to a stream that can be read via the InputStream obtained via ClientChannel.getInvertedErr(). (Or it might forward the data to the output stream if setRedirectErrorStream(true) is set.)

Specified by:

setErr in interface ClientChannel

Overrides:

setErr in class AbstractClientChannel

Parameters:

err - the OutputStream

See Also:

• ClientChannel.getInvertedErr()
• ClientChannel.setRedirectErrorStream(boolean)

doWriteExtendedData

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

Overrides:

doWriteExtendedData in class AbstractClientChannel

Throws:

IOException

doOpen

protected void doOpen()
               throws IOException

Specified by:

doOpen in class AbstractClientChannel

Throws:

IOException

getInnerCloseable

protected Closeable getInnerCloseable()

Overrides:

getInnerCloseable in class AbstractClientChannel

closeImmediately0

protected void closeImmediately0()

pumpInputStream

protected void pumpInputStream()

securedRead

protected int securedRead(InputStream in,
 int maxChunkSize,
 byte[] buf,
 int off,
 int len)
                   throws IOException

Throws:

IOException