Class ChannelSession

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

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

Direct Known Subclasses:

ChannelSubsystem, PtyCapableChannelSession

public class ChannelSession
extends AsyncCapableClientChannel

Client side channel session

Author:

Apache MINA SSHD Project

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
protected Future<?>	pumper
protected org.apache.sshd.common.util.threads.CloseableExecutorService	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, 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
ChannelSession()

Method Summary

Modifier and Type	Method	Description
protected RequestHandler.Result	handleInternalRequest(String req, boolean wantReply, org.apache.sshd.common.util.buffer.Buffer buffer)	Called by AbstractChannel.handleUnknownChannelRequest(String, boolean, Buffer) in order to allow channel request handling if none of the registered handlers processed the request - last chance.
protected RequestHandler.Result	handleXonXoff(org.apache.sshd.common.util.buffer.Buffer buffer, boolean wantReply)
protected void	sendEnvVariables(Session session)
Object	setEnv(String key, Object value)

Methods inherited from class AsyncCapableClientChannel

closeImmediately0, doOpen, 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, handleFailure, 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

pumperService

protected org.apache.sshd.common.util.threads.CloseableExecutorService pumperService

pumper

protected Future<?> pumper

Constructor Details

ChannelSession

public ChannelSession()

Method Details

handleInternalRequest

protected RequestHandler.Result handleInternalRequest(String req,
 boolean wantReply,
 org.apache.sshd.common.util.buffer.Buffer buffer)
                                               throws IOException

Description copied from class: AbstractChannel

Called by AbstractChannel.handleUnknownChannelRequest(String, boolean, Buffer) in order to allow channel request handling if none of the registered handlers processed the request - last chance.

Overrides:

handleInternalRequest in class AbstractChannel

Parameters:

req - The request type

wantReply - Whether reply is requested

buffer - The Buffer containing extra request-specific data

Returns:

The handling result - if null or Unsupported and reply is required then a failure message will be sent

Throws:

IOException - If failed to process the request internally

handleXonXoff

protected RequestHandler.Result handleXonXoff(org.apache.sshd.common.util.buffer.Buffer buffer,
 boolean wantReply)
                                       throws IOException

Throws:

IOException

setEnv

public Object setEnv(String key,
 Object value)

Parameters:

key - The (never null) key (Note: may be empty...)

value - The value to set - if null then the pre-existing value for the key (if any) is removed.

Returns:

The replaced/removed previous value - null if no previous value set for the key.

sendEnvVariables

protected void sendEnvVariables(Session session)
                         throws IOException

Throws:

IOException