org.apache.sshd.server.session

Class ServerSession

java.lang.Object

org.apache.sshd.common.session.AbstractSession

org.apache.sshd.server.session.ServerSession

All Implemented Interfaces:

Session

public class ServerSession
extends AbstractSession

TODO: handle key re-exchange key re-exchange should be performed after each gigabyte of transferred data or one hour time connection (see RFC4253, section 9) TODO: better use of SSH_MSG_DISCONNECT and disconnect error codes TODO Add javadoc

Author:

Apache MINA SSHD Project

Nested Class Summary

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

Session.AttributeKey<T>, Session.State

Field Summary

Fields inherited from class org.apache.sshd.common.session.AbstractSession

attributes, authed, channels, clientProposal, clientVersion, closeFuture, closing, decodeLock, decoderBuffer, decoderLength, decoderState, encodeLock, factoryManager, I_C, I_S, inCipher, inCipherSize, inCompression, inMac, inMacResult, ioSession, kex, listeners, lock, log, negociated, nextChannelId, outCipher, outCipherSize, outCompression, outMac, random, requestLock, requestResult, seqi, seqo, serverProposal, serverVersion, SESSION, sessionId, tcpipForwarder, uncompressBuffer, username

Constructor Summary

Constructors

Constructor and Description
ServerSession(ServerFactoryManager server, IoSession ioSession)

Method Summary

Methods

Modifier and Type	Method and Description
CloseFuture	close(boolean immediately) Close this session.
String	createX11Display(boolean singleConnection, String authenticationProtocol, String authenticationCookie, int screen)
protected int	getActiveSessionCountForUser(String userName) Retrieve the current number of sessions active for a given username.
KeyPair	getHostKey()
long	getId() Returns the session id.
KeyExchange	getKex()
String	getNegociated(int index)
protected ScheduledExecutorService	getScheduledExecutorService()
ServerFactoryManager	getServerFactoryManager()
byte[]	getSessionId()
protected void	handleMessage(Buffer buffer) Abstract method for processing incoming decoded packets.
String	initAgentForward()
protected boolean	readIdentification(Buffer buffer) Read the other side identification.
IoWriteFuture	writePacket(Buffer buffer) Encode and send the given buffer.

Methods inherited from class org.apache.sshd.common.session.AbstractSession

addListener, attachSession, channelClose, channelData, channelEof, channelExtendedData, channelFailure, channelOpenConfirmation, channelOpenFailure, channelRequest, channelWindowAdjust, createBuffer, createProposal, decode, disconnect, doReadIdentification, exceptionCaught, getAttribute, getChannel, getFactoryManager, getIntProperty, getIoSession, getNextChannelId, getSession, getSession, getState, getTcpipForwarder, getUsername, messageReceived, negociate, notImplemented, receiveKexInit, receiveNewKeys, registerChannel, removeListener, request, requestFailure, requestSuccess, sendIdentification, sendKexInit, sendNewKeys, setAttribute, setState, unregisterChannel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerSession

public ServerSession(ServerFactoryManager server,
             IoSession ioSession)
              throws Exception

Throws:

Exception

Method Detail

close

public CloseFuture close(boolean immediately)

Description copied from class: AbstractSession

Close this session. This method will close all channels, then close the underlying MINA session. The call will not block until the mina session is actually closed.

Overrides:

close in class AbstractSession

getNegociated

public String getNegociated(int index)

getKex

public KeyExchange getKex()

getSessionId

public byte[] getSessionId()

getServerFactoryManager

public ServerFactoryManager getServerFactoryManager()

getScheduledExecutorService

protected ScheduledExecutorService getScheduledExecutorService()

writePacket

public IoWriteFuture writePacket(Buffer buffer)
                          throws IOException

Description copied from class: AbstractSession

Encode and send the given buffer. The buffer has to have 5 bytes free at the beginning to allow the encoding to take place. Also, the write position of the buffer has to be set to the position of the last byte to write.

Specified by:

writePacket in interface Session

Overrides:

writePacket in class AbstractSession

Parameters:

buffer - the buffer to encode and send

Returns:

a future that can be used to check when the packet has actually been sent

Throws:

IOException - if an error occured when encoding sending the packet

handleMessage

protected void handleMessage(Buffer buffer)
                      throws Exception

Description copied from class: AbstractSession

Abstract method for processing incoming decoded packets. The given buffer will hold the decoded packet, starting from the command byte at the read position. Packets must be processed within this call or be copied because the given buffer is meant to be changed and updated when this method returns.

Specified by:

handleMessage in class AbstractSession

Parameters:

buffer - the buffer containing the packet

Throws:

Exception - if an exeption occurs while handling this packet.

readIdentification

protected boolean readIdentification(Buffer buffer)
                              throws IOException

Description copied from class: AbstractSession

Read the other side identification. This method is specific to the client or server side, but both should call AbstractSession.doReadIdentification(org.apache.sshd.common.util.Buffer) and store the result in the needed property.

Specified by:

readIdentification in class AbstractSession

Parameters:

buffer - the buffer containing the remote identification

Returns:

true if the identification has been fully read or false if more data is needed

Throws:

IOException - if an error occurs such as a bad protocol version

getHostKey

public KeyPair getHostKey()

getActiveSessionCountForUser

protected int getActiveSessionCountForUser(String userName)

Retrieve the current number of sessions active for a given username.

Parameters:

userName - The name of the user

Returns:

The current number of live SshSession objects associated with the user

initAgentForward

public String initAgentForward()
                        throws IOException

Throws:

IOException

createX11Display

public String createX11Display(boolean singleConnection,
                      String authenticationProtocol,
                      String authenticationCookie,
                      int screen)
                        throws IOException

Throws:

IOException

getId

public long getId()

Returns the session id.

Returns:

The session id.