org.apache.sshd.client.channel

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

org.apache.sshd.client.channel.PtyCapableChannelSession

org.apache.sshd.client.channel.ChannelShell

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ClientChannel, ClientSessionHolder, AttributeRepository, AttributeStore, ChannelListenerManager, PtyChannelConfigurationHolder, PtyChannelConfigurationMutator, ChannelStreamPacketWriterResolver, ChannelStreamPacketWriterResolverManager, PacketWriter, PropertyResolver, SessionContextHolder, SessionHolder<Session>, ExecutorServiceCarrier

public class ChannelShell
extends PtyCapableChannelSession

Client channel to open a remote shell

Author:

Apache MINA SSHD Project

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

ClientChannel.Streaming

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

AttributeRepository.AttributeKey<T>

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_REQUEST_SHELL_REPLY
static String	REQUEST_SHELL_REPLY Configure whether reply for the "shell" request is required

Fields inherited from class org.apache.sshd.client.channel.ChannelSession

DEFAULT_INPUT_STREAM_PUMP_CHUNK_SIZE, INPUT_STREAM_PUMP_CHUNK_SIZE

Fields inherited from class org.apache.sshd.client.channel.AbstractClientChannel

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

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

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

log

Fields inherited from interface org.apache.sshd.common.channel.PtyChannelConfigurationHolder

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

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.channel.throttle.ChannelStreamPacketWriterResolver

NONE

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

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 org.apache.sshd.client.channel.PtyCapableChannelSession

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

Methods inherited from class org.apache.sshd.client.channel.ChannelSession

closeImmediately0, getInnerCloseable, handleInternalRequest, handleXonXoff, pumpInputStream, securedRead

Methods inherited from class org.apache.sshd.client.channel.AbstractClientChannel

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

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

addChannelListener, addPendingRequest, addRequestHandler, attributeKeys, clearAttributes, computeAttributeIfAbsent, configureWindow, getAttribute, getAttributesCount, getChannelListenerProxy, getChannelStreamPacketWriterResolver, getExecutorService, getId, getLocalWindow, getParentPropertyResolver, getProperties, getRecipient, getRemoteWindow, getRequestHandlers, getSession, handleChannelRequest, handleClose, handleData, handleEof, handleExtendedData, handleRequest, handleUnknownChannelRequest, init, invokeChannelSignaller, isEofSent, isEofSignalled, isInitialized, notifyStateChanged, notifyStateChanged, preClose, removeAttribute, removeChannelListener, removePendingRequest, removeRequestHandler, resolveChannelStreamPacketWriterResolver, sendEof, sendResponse, sendWindowAdjust, setAttribute, setChannelStreamPacketWriterResolver, setRecipient, signalChannelClosed, signalChannelClosed, signalChannelInitialized, signalChannelInitialized, signalChannelOpenFailure, signalChannelOpenFailure, signalChannelOpenSuccess, 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

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

copyConfiguration, setupSensitiveDefaultPtyConfiguration

Methods inherited from interface org.apache.sshd.client.channel.ClientChannel

getClientSession, validateCommandExitStatusCode

Methods inherited from interface org.apache.sshd.common.channel.Channel

addRequestHandler, addRequestHandlers, getId, getLocalWindow, getRecipient, getRemoteWindow, getRequestHandlers, handleClose, handleData, handleEof, handleExtendedData, handleRequest, init, isEofSignalled, isInitialized, removeRequestHandler, removeRequestHandlers, resolveAttribute, resolveAttribute

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSession, getSessionContext

Methods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

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

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

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

clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

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

attributeKeys, getAttribute, getAttributesCount, ofAttributesMap, ofKeyValuePair

Methods inherited from interface org.apache.sshd.common.io.PacketWriter

calculatePadLength, writePacket

Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolverManager

getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver

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

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

Field Detail

REQUEST_SHELL_REPLY

public static final String REQUEST_SHELL_REPLY

Configure whether reply for the "shell" request is required

See Also:

DEFAULT_REQUEST_SHELL_REPLY, Constant Field Values

DEFAULT_REQUEST_SHELL_REPLY

public static final boolean DEFAULT_REQUEST_SHELL_REPLY

See Also:

Constant Field Values

Constructor Detail

ChannelShell

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

Method Detail

doOpen

protected void doOpen()
               throws IOException

Overrides:

doOpen in class ChannelSession

Throws:

IOException

handleSuccess

public void handleSuccess()
                   throws IOException

Description copied from interface: Channel

Invoked when SSH_MSG_CHANNEL_SUCCESS received

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

Overrides:

handleFailure in class AbstractChannel

Throws:

IOException - If failed to handle the message