org.apache.sshd.common.session

Class AbstractConnectionService

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

org.apache.sshd.common.session.AbstractConnectionService

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, Service, ConnectionService

Direct Known Subclasses:

ClientConnectionService, ServerConnectionService

public abstract class AbstractConnectionService
extends CloseableUtils.AbstractInnerCloseable
implements ConnectionService

Base implementation of ConnectionService.

Author:

Apache MINA SSHD Project

Nested Class Summary

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

CloseableUtils.AbstractCloseable.State

Field Summary

Fields

Modifier and Type	Field and Description
protected AgentForwardSupport	agentForward
protected boolean	allowMoreSessions
protected Map<Integer,Channel>	channels Map of channels keyed by the identifier
static int	DEFAULT_MAX_CHANNELS
static String	MAX_CONCURRENT_CHANNELS_PROP Property that can be used to configure max.
protected AtomicInteger	nextChannelId Next channel identifier
static Int2IntFunction	RESPONSE_BUFFER_GROWTH_FACTOR Default growth factor function used to resize response buffers
protected AbstractSession	session
protected TcpipForwarder	tcpipForwarder The tcpip forwarder
protected X11ForwardSupport	x11Forward

Fields inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

closeFuture, lock, state

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

log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConnectionService(Session session)

Method Summary

Modifier and Type	Method and Description
void	channelClose(Buffer buffer) Close a channel due to a close packet received
void	channelData(Buffer buffer) Process incoming data on a channel
void	channelEof(Buffer buffer) Process end of file on a channel
void	channelExtendedData(Buffer buffer) Process incoming extended data on a channel
void	channelFailure(Buffer buffer) Process a failure on a channel
protected void	channelOpen(Buffer buffer)
void	channelOpenConfirmation(Buffer buffer)
void	channelOpenFailure(Buffer buffer)
void	channelRequest(Buffer buffer) Service a request on a channel
void	channelWindowAdjust(Buffer buffer) Process a window adjust packet on a channel
protected Channel	getChannel(Buffer buffer) Retrieve the channel designated by the given packet
Collection<Channel>	getChannels()
protected Closeable	getInnerCloseable()
protected int	getNextChannelId()
AbstractSession	getSession()
TcpipForwarder	getTcpipForwarder() Retrieve the tcpip forwarder
protected void	globalRequest(Buffer buffer) Process global requests
void	process(int cmd, Buffer buffer) Service the request.
int	registerChannel(Channel channel) Register a newly created channel with a new unique identifier
protected void	requestFailure(Buffer buffer)
protected void	requestSuccess(Buffer buffer)
protected void	sendResponse(Buffer buffer, String req, RequestHandler.Result result, boolean wantReply)
void	setAllowMoreSessions(boolean allow)
void	start()
String	toString()
void	unregisterChannel(Channel channel) Remove this channel from the list of managed channels

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

builder, close, isClosed, isClosing, preClose

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

close, isOpen

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.session.ConnectionService

createX11Display, initAgentForward

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

close, isClosed, isClosing

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Field Detail

MAX_CONCURRENT_CHANNELS_PROP

public static final String MAX_CONCURRENT_CHANNELS_PROP

Property that can be used to configure max. allowed concurrent active channels

See Also:

registerChannel(Channel), Constant Field Values

DEFAULT_MAX_CHANNELS

public static final int DEFAULT_MAX_CHANNELS

See Also:

Constant Field Values

RESPONSE_BUFFER_GROWTH_FACTOR

public static final Int2IntFunction RESPONSE_BUFFER_GROWTH_FACTOR

Default growth factor function used to resize response buffers

channels

protected final Map<Integer,Channel> channels

Map of channels keyed by the identifier

nextChannelId

protected final AtomicInteger nextChannelId

Next channel identifier

session

protected final AbstractSession session

tcpipForwarder

protected final TcpipForwarder tcpipForwarder

The tcpip forwarder

agentForward

protected final AgentForwardSupport agentForward

x11Forward

protected final X11ForwardSupport x11Forward

allowMoreSessions

protected boolean allowMoreSessions

Constructor Detail

AbstractConnectionService

protected AbstractConnectionService(Session session)

Method Detail

getChannels

public Collection<Channel> getChannels()

getSession

public AbstractSession getSession()

Specified by:

getSession in interface Service

start

public void start()

Specified by:

start in interface Service

getTcpipForwarder

public TcpipForwarder getTcpipForwarder()

Description copied from interface: ConnectionService

Retrieve the tcpip forwarder

Specified by:

getTcpipForwarder in interface ConnectionService

Returns:

The TcpipForwarder

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class CloseableUtils.AbstractInnerCloseable

getNextChannelId

protected int getNextChannelId()

registerChannel

public int registerChannel(Channel channel)
                    throws IOException

Description copied from interface: ConnectionService

Register a newly created channel with a new unique identifier

Specified by:

registerChannel in interface ConnectionService

Parameters:

channel - The Channel to register

Returns:

The assigned id of this channel

Throws:

IOException - If failed to initialize and register the channel

unregisterChannel

public void unregisterChannel(Channel channel)

Remove this channel from the list of managed channels

Specified by:

unregisterChannel in interface ConnectionService

Parameters:

channel - the channel

process

public void process(int cmd,
                    Buffer buffer)
             throws Exception

Description copied from interface: Service

Service the request.

Specified by:

process in interface Service

Parameters:

cmd - The incoming command type

buffer - The Buffer containing optional command parameters

Throws:

Exception - If failed to process the command

setAllowMoreSessions

public void setAllowMoreSessions(boolean allow)

Specified by:

setAllowMoreSessions in interface ConnectionService

channelOpenConfirmation

public void channelOpenConfirmation(Buffer buffer)
                             throws IOException

Throws:

IOException

channelOpenFailure

public void channelOpenFailure(Buffer buffer)
                        throws IOException

Throws:

IOException

channelData

public void channelData(Buffer buffer)
                 throws IOException

Process incoming data on a channel

Parameters:

buffer - the buffer containing the data

Throws:

IOException - if an error occurs

channelExtendedData

public void channelExtendedData(Buffer buffer)
                         throws IOException

Process incoming extended data on a channel

Parameters:

buffer - the buffer containing the data

Throws:

IOException - if an error occurs

channelWindowAdjust

public void channelWindowAdjust(Buffer buffer)
                         throws IOException

Process a window adjust packet on a channel

Parameters:

buffer - the buffer containing the window adjustement parameters

Throws:

IOException - if an error occurs

channelEof

public void channelEof(Buffer buffer)
                throws IOException

Process end of file on a channel

Parameters:

buffer - the buffer containing the packet

Throws:

IOException - if an error occurs

channelClose

public void channelClose(Buffer buffer)
                  throws IOException

Close a channel due to a close packet received

Parameters:

buffer - the buffer containing the packet

Throws:

IOException - if an error occurs

channelRequest

public void channelRequest(Buffer buffer)
                    throws IOException

Service a request on a channel

Parameters:

buffer - the buffer containing the request

Throws:

IOException - if an error occurs

channelFailure

public void channelFailure(Buffer buffer)
                    throws IOException

Process a failure on a channel

Parameters:

buffer - the buffer containing the packet

Throws:

IOException - if an error occurs

getChannel

protected Channel getChannel(Buffer buffer)
                      throws IOException

Retrieve the channel designated by the given packet

Parameters:

buffer - the incoming packet

Returns:

the target channel

Throws:

IOException - if the channel does not exists

channelOpen

protected void channelOpen(Buffer buffer)
                    throws Exception

Throws:

Exception

globalRequest

protected void globalRequest(Buffer buffer)
                      throws Exception

Process global requests

Parameters:

buffer - The request Buffer

Throws:

Exception - If failed to process the request

sendResponse

protected void sendResponse(Buffer buffer,
                            String req,
                            RequestHandler.Result result,
                            boolean wantReply)
                     throws IOException

Throws:

IOException

requestSuccess

protected void requestSuccess(Buffer buffer)
                       throws Exception

Throws:

Exception

requestFailure

protected void requestFailure(Buffer buffer)
                       throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object