Class ChannelShell

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

org.apache.sshd.client.channel.ChannelSession

org.apache.sshd.client.channel.PtyCapableChannelSession

org.apache.sshd.client.channel.ChannelShell

All Implemented Interfaces:

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

public class ChannelShell
extends PtyCapableChannelSession

Client channel to open a remote shell

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 inherited from class ChannelSession

pumper, pumperService

Fields inherited from class AsyncCapableClientChannel

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

Fields inherited from interface PtyChannelConfigurationHolder

DEFAULT_COLUMNS_COUNT, DEFAULT_HEIGHT, DEFAULT_PTY_MODES, DEFAULT_ROWS_COUNT, DEFAULT_WIDTH, DUMMY_PTY_TYPE, WINDOWS_PTY_TYPE

Constructor Summary

Constructors

Constructor	Description
ChannelShell(PtyChannelConfigurationHolder configHolder, Map<String,?> env)

Method Summary

Modifier and Type	Method	Description
protected void	doOpen()
void	handleFailure()	Invoked when SSH_MSG_CHANNEL_FAILURE received
void	handleSuccess()	Invoked when SSH_MSG_CHANNEL_SUCCESS received

Methods inherited from class PtyCapableChannelSession

doOpenPty, getPtyColumns, getPtyHeight, getPtyLines, getPtyModes, getPtyType, getPtyWidth, isAgentForwarding, isUsePty, resolvePtyType, sendWindowChange, sendWindowChange, setAgentForwarding, setPtyColumns, setPtyHeight, setPtyLines, setPtyModes, setPtyType, setPtyWidth, setupSensibleDefaultPty, setUsePty

Methods inherited from class ChannelSession

handleInternalRequest, handleXonXoff, sendEnvVariables, setEnv

Methods inherited from class AsyncCapableClientChannel

closeImmediately0, doWriteExtendedData, getAsyncErr, getErr, getInnerCloseable, getInvertedErr, pumpInputStream, securedRead, setErr

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

Constructor Details

ChannelShell

public ChannelShell(PtyChannelConfigurationHolder configHolder,
 Map<String,?> env)

Method Details

doOpen

protected void doOpen()
               throws IOException

Overrides:

doOpen in class AsyncCapableClientChannel

Throws:

IOException

handleSuccess

public void handleSuccess()
                   throws IOException

Description copied from interface: Channel

Invoked when SSH_MSG_CHANNEL_SUCCESS received

Specified by:

handleSuccess in interface Channel

Overrides:

handleSuccess in class AbstractChannel

Throws:

IOException - If failed to handle the message

handleFailure

public void handleFailure()
                   throws IOException

Description copied from interface: Channel

Invoked when SSH_MSG_CHANNEL_FAILURE received

Specified by:

handleFailure in interface Channel

Overrides:

handleFailure in class AbstractChannel

Throws:

IOException - If failed to handle the message