Class AbstractServerChannel

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.server.channel.AbstractServerChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, org.apache.sshd.common.AttributeRepository, org.apache.sshd.common.AttributeStore, Channel, ChannelIdentifier, ChannelListenerManager, 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, ServerChannel, ServerSessionHolder

Direct Known Subclasses:

ChannelAgentForwarding, ChannelAgentForwarding, ChannelSession, TcpipServerChannel

public abstract class AbstractServerChannel
extends AbstractChannel
implements ServerChannel

TODO Add javadoc

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>

Field Summary

Fields

Modifier and Type	Field	Description
protected final AtomicBoolean	exitStatusSent

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

Modifier	Constructor	Description
protected	AbstractServerChannel(String discriminator, Collection<? extends RequestHandler<Channel>> handlers, org.apache.sshd.common.util.threads.CloseableExecutorService executor)
protected	AbstractServerChannel(org.apache.sshd.common.util.threads.CloseableExecutorService executor)

Method Summary

Modifier and Type	Method	Description
protected OpenFuture	doInit(org.apache.sshd.common.util.buffer.Buffer buffer)
void	handleOpenFailure(org.apache.sshd.common.util.buffer.Buffer buffer)	For a client channel, this method will be called internally by the session when the server has rejected this channel opening.
void	handleOpenSuccess(long recipient, long rwSize, long packetSize, org.apache.sshd.common.util.buffer.Buffer buffer)	For a client channel, this method will be called internally by the session when the confirmation has been received.
OpenFuture	open(long recipient, long rwSize, long packetSize, org.apache.sshd.common.util.buffer.Buffer buffer)	For a server channel, this method will actually open the channel
protected void	sendExitStatus(int v)

Methods inherited from class AbstractChannel

addChannelListener, addPendingRequest, addRequestHandler, attributeKeys, clearAttributes, computeAttributeIfAbsent, configureWindow, doWriteData, doWriteExtendedData, getAttribute, getAttributesCount, getChannelId, getChannelListenerProxy, getChannelStreamWriterResolver, getExecutorService, getInnerCloseable, getLocalWindow, getPacketValidator, getParentPropertyResolver, getProperties, getRecipient, getRemoteWindow, getRequestHandlers, getSession, handleChannelRegistrationResult, handleChannelRequest, handleChannelUnregistration, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleInternalRequest, handleRequest, handleSuccess, handleUnknownChannelRequest, handleWindowAdjust, init, invokeChannelSignaller, isEofSent, isEofSignalled, isInitialized, mayWrite, 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, handleWindowAdjust, 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 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 ServerChannel

getServerSession

Methods inherited from interface SessionHolder

getSession, getSessionContext

Field Details

exitStatusSent

protected final AtomicBoolean exitStatusSent

Constructor Details

AbstractServerChannel

protected AbstractServerChannel(org.apache.sshd.common.util.threads.CloseableExecutorService executor)

AbstractServerChannel

protected AbstractServerChannel(String discriminator,
 Collection<? extends RequestHandler<Channel>> handlers,
 org.apache.sshd.common.util.threads.CloseableExecutorService executor)

Method Details

open

public OpenFuture open(long recipient,
 long rwSize,
 long packetSize,
 org.apache.sshd.common.util.buffer.Buffer buffer)

Description copied from interface: Channel

For a server channel, this method will actually open the channel

Specified by:

open in interface Channel

Parameters:

recipient - Recipient identifier (UINT32 represented as a long)

rwSize - Read/Write window size (uint32)

packetSize - Preferred maximum packet size (uint32)

buffer - Incoming Buffer that triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded

Returns:

An OpenFuture for the channel open request

handleOpenSuccess

public void handleOpenSuccess(long recipient,
 long rwSize,
 long packetSize,
 org.apache.sshd.common.util.buffer.Buffer buffer)
                       throws IOException

Description copied from interface: Channel

For a client channel, this method will be called internally by the session when the confirmation has been received.

Specified by:

handleOpenSuccess in interface Channel

Parameters:

recipient - Recipient identifier (UINT32 represented as a long)

rwSize - Read/Write window size (uint32)

packetSize - Preferred maximum packet size (uint32)

buffer - Incoming Buffer that triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded

Throws:

IOException - If failed to handle the success

handleOpenFailure

public void handleOpenFailure(org.apache.sshd.common.util.buffer.Buffer buffer)

Description copied from interface: Channel

For a client channel, this method will be called internally by the session when the server has rejected this channel opening.

Specified by:

handleOpenFailure in interface Channel

Parameters:

buffer - Incoming Buffer that triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded

doInit

protected OpenFuture doInit(org.apache.sshd.common.util.buffer.Buffer buffer)

sendExitStatus

protected void sendExitStatus(int v)
                       throws IOException

Throws:

IOException