org.apache.sshd.server.session

Class ServerSession

java.lang.Object

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

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

org.apache.sshd.common.session.AbstractSession

org.apache.sshd.server.session.ServerSession

All Implemented Interfaces:

Closeable, Session

public class ServerSession
extends AbstractSession

TODO Add javadoc

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.session.AbstractSession

AbstractSession.PendingWriteFuture

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

Session.AttributeKey<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	MAX_PACKETS

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

attributes, authed, clientProposal, clientVersion, currentService, decodeLock, decoderBuffer, decoderLength, decoderState, encodeLock, factoryManager, I_C, I_S, inBytes, inCipher, inCipherSize, inCompression, inMac, inMacResult, inPackets, ioSession, isServer, kex, KEX_STATE_DONE, KEX_STATE_INIT, KEX_STATE_KEYS, KEX_STATE_RUN, kexState, lastKeyTime, listeners, negotiated, outBytes, outCipher, outCipherSize, outCompression, outMac, outPackets, pendingPackets, random, reexchangeFuture, requestLock, requestResult, seqi, seqo, serverProposal, serverVersion, SESSION, sessionId, uncompressBuffer, username

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

CLOSED, closeFuture, GRACEFUL, IMMEDIATE, lock, log, OPENED, state

Constructor Summary

Constructors

Constructor and Description
ServerSession(ServerFactoryManager server, IoSession ioSession)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkForTimeouts() Checks whether the server session has timed out (both auth and idle timeouts are checked).
protected void	checkKeys()
protected void	checkRekey()
protected int	getActiveSessionCountForUser(java.lang.String userName) Retrieve the current number of sessions active for a given username.
ServerFactoryManager	getFactoryManager() Retrieve the factory manager
java.security.KeyPair	getHostKey()
long	getId() Returns the session id.
java.lang.String	getNegotiated(int index)
protected boolean	readIdentification(Buffer buffer) Read the other side identification.
protected void	receiveKexInit(Buffer buffer)
void	resetIdleTimeout()
protected void	sendKexInit()
protected void	serviceAccept()
void	startService(java.lang.String name)

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

addListener, attachSession, createBuffer, createBuffer, createProposal, decode, disconnect, doHandleMessage, doReadIdentification, doWritePacket, exceptionCaught, getAttribute, getClientVersion, getInnerCloseable, getIntProperty, getIoSession, getKex, getLock, getLongProperty, getServerVersion, getServices, getSession, getSession, getSessionId, getUsername, handleMessage, isAuthenticated, messageReceived, negotiate, notImplemented, postClose, receiveKexInit, receiveNewKeys, reExchangeKeys, removeListener, request, requestFailure, requestSuccess, sendEvent, sendIdentification, sendKexInit, sendNewKeys, setAttribute, setAuthenticated, setUsername, toString, writePacket

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

doCloseGracefully, doCloseImmediately

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

close

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.Closeable

close

Field Detail

MAX_PACKETS

protected static final long MAX_PACKETS

See Also:

Constant Field Values

Constructor Detail

ServerSession

public ServerSession(ServerFactoryManager server,
             IoSession ioSession)
              throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getNegotiated

public java.lang.String getNegotiated(int index)

getFactoryManager

public ServerFactoryManager getFactoryManager()

Description copied from class: AbstractSession

Retrieve the factory manager

Specified by:

getFactoryManager in interface Session

Overrides:

getFactoryManager in class AbstractSession

Returns:

the factory manager for this session

checkKeys

protected void checkKeys()

Specified by:

checkKeys in class AbstractSession

startService

public void startService(java.lang.String name)
                  throws java.lang.Exception

Specified by:

startService in class AbstractSession

Throws:

java.lang.Exception

serviceAccept

protected void serviceAccept()
                      throws java.io.IOException

Overrides:

serviceAccept in class AbstractSession

Throws:

java.io.IOException

checkForTimeouts

protected void checkForTimeouts()
                         throws java.io.IOException

Checks whether the server session has timed out (both auth and idle timeouts are checked). If the session has timed out, a DISCONNECT message will be sent to the client.

Throws:

java.io.IOException

checkRekey

protected void checkRekey()
                   throws java.io.IOException

Overrides:

checkRekey in class AbstractSession

Throws:

java.io.IOException

resetIdleTimeout

public void resetIdleTimeout()

Specified by:

resetIdleTimeout in class AbstractSession

sendKexInit

protected void sendKexInit()
                    throws java.io.IOException

Specified by:

sendKexInit in class AbstractSession

Throws:

java.io.IOException

readIdentification

protected boolean readIdentification(Buffer buffer)
                              throws java.io.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:

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

receiveKexInit

protected void receiveKexInit(Buffer buffer)
                       throws java.io.IOException

Specified by:

receiveKexInit in class AbstractSession

Throws:

java.io.IOException

getHostKey

public java.security.KeyPair getHostKey()

getActiveSessionCountForUser

protected int getActiveSessionCountForUser(java.lang.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

getId

public long getId()

Returns the session id.

Returns:

The session id.