Package org.apache.sshd.client.channel

Class ChannelExec

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

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 ChannelExec
extends PtyCapableChannelSession

Client channel to run a remote command

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.channel.AbstractChannel

AbstractChannel.GracefulChannelCloseable, AbstractChannel.GracefulState, AbstractChannel.PacketValidator

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

AbstractCloseable.State

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

AttributeRepository.AttributeKey<T extends Object>

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

StreamingChannel.Streaming

Field Summary

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

pumper, pumperService

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

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

channelListenerProxy, channelListeners, closeSignaled, DEFAULT_PACKET_VALIDATOR, eofReceived, eofSent, 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 org.apache.sshd.common.channel.Channel

CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM

Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolver

NONE

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

EMPTY

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

Constructor Summary

Constructors

Constructor	Description
ChannelExec(byte[] command, PtyChannelConfigurationHolder configHolder, Map<String,?> env)
ChannelExec(String command, Charset charset, PtyChannelConfigurationHolder configHolder, Map<String,?> env)
ChannelExec(String command, 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 org.apache.sshd.client.channel.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 org.apache.sshd.client.channel.ChannelSession

closeImmediately0, getInnerCloseable, handleInternalRequest, handleXonXoff, pumpInputStream, securedRead, sendEnvVariables, setEnv

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, isRedirectErrorStream, mayWrite, open, open, setErr, setIn, setOut, setRedirectErrorStream, setStreaming, updateCurrentChannelState, waitFor

Methods inherited from class org.apache.sshd.common.channel.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 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 java.lang.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 org.apache.sshd.common.channel.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 org.apache.sshd.common.channel.ChannelIdentifier

getChannelId

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

addChannelListener, getChannelListenerProxy, removeChannelListener

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

getChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolver

Methods inherited from interface org.apache.sshd.client.channel.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 org.apache.sshd.common.session.SessionHolder

getSession, getSessionContext

Constructor Detail

ChannelExec

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

ChannelExec

public ChannelExec(String command,
                   Charset charset,
                   PtyChannelConfigurationHolder configHolder,
                   Map<String,?> env)

ChannelExec

public ChannelExec(byte[] command,
                   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

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