org.apache.sshd.common.session

Class AbstractConnectionService

java.lang.Object

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

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

org.apache.sshd.common.session.AbstractConnectionService

All Implemented Interfaces:

Closeable, 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
protected AtomicInteger	nextChannelId Next channel identifier
protected Session	session
protected TcpipForwarder	tcpipForwarder The tcpip forwarder
protected X11ForwardSupport	x11Forward

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

closeFuture, lock, log, state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConnectionService(Session session)

Method Summary

Methods

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(byte 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)
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 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.Service

close

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

isClosed, isClosing

Field Detail

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 Session 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:

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class CloseableUtils.AbstractInnerCloseable

getNextChannelId

protected int getNextChannelId()

registerChannel

public int registerChannel(Channel channel)
                    throws IOException

Register a newly created channel with a new unique identifier

Specified by:

registerChannel in interface ConnectionService

Parameters:

channel - the channel to register

Returns:

the id of this channel

Throws:

IOException

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(byte cmd,
           Buffer buffer)
             throws Exception

Description copied from interface: Service

Service the request.

Specified by:

process in interface Service

Throws:

Exception

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

Throws:

Exception

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