org.apache.sshd.common

Interface Session

All Superinterfaces:

Closeable

All Known Subinterfaces:

ClientSession

All Known Implementing Classes:

AbstractSession, ClientSessionImpl, ServerSession

public interface Session
extends Closeable

Represents an SSH session

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Session.AttributeKey<T> Type safe key for storage within the user attributes of AbstractSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(SessionListener listener) Add a session |listener|.
Buffer	createBuffer(byte cmd) Create a new buffer for the specified SSH packet and reserve the needed space (5 bytes) for the packet header.
Buffer	createBuffer(byte cmd, int estimatedSize) Create a new buffer for the specified SSH packet and reserve the needed space (5 bytes) for the packet header.
void	exceptionCaught(java.lang.Throwable t) Handle any exceptions that occured on this session.
<T> T	getAttribute(Session.AttributeKey<T> key) Returns the value of the user-defined attribute of this session.
java.lang.String	getClientVersion() Retrieve the client version for this session.
FactoryManager	getFactoryManager() Retrieve the FactoryManager that has created this session
int	getIntProperty(java.lang.String name, int defaultValue) Retrieve a configuration property as an integer
java.lang.String	getServerVersion() Retrieve the server version for this session.
java.lang.String	getUsername() Retrieve the name of the user authenticated on this session or null if the session has not been authenticated yet.
SshFuture	reExchangeKeys() Initiate a new key exchange.
void	removeListener(SessionListener listener) Remove a session |listener|.
Buffer	request(Buffer buffer) Send a global request and wait for the response.
<T,E extends T> T	setAttribute(Session.AttributeKey<T> key, E value) Sets a user-defined attribute.
IoWriteFuture	writePacket(Buffer buffer) Encode and send the given buffer.

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

close

Method Detail

getAttribute

<T> T getAttribute(Session.AttributeKey<T> key)

Returns the value of the user-defined attribute of this session.

Parameters:

key - the key of the attribute; must not be null.

Returns:

null if there is no attribute with the specified key

setAttribute

<T,E extends T> T setAttribute(Session.AttributeKey<T> key,
                             E value)

Sets a user-defined attribute.

Parameters:

key - the key of the attribute; must not be null.

value - the value of the attribute; must not be null.

Returns:

The old value of the attribute. null if it is new.

getUsername

java.lang.String getUsername()

Retrieve the name of the user authenticated on this session or null if the session has not been authenticated yet.

Returns:

the user name.

getClientVersion

java.lang.String getClientVersion()

Retrieve the client version for this session.

Returns:

the client version.

getServerVersion

java.lang.String getServerVersion()

Retrieve the server version for this session.

Returns:

the server version.

getFactoryManager

FactoryManager getFactoryManager()

Retrieve the FactoryManager that has created this session

Returns:

the factory manager, can not be null.

getIntProperty

int getIntProperty(java.lang.String name,
                 int defaultValue)

Retrieve a configuration property as an integer

Parameters:

name - the name of the property

defaultValue - the default value

Returns:

the value of the configuration property or the default value if not found

createBuffer

Buffer createBuffer(byte cmd)

Create a new buffer for the specified SSH packet and reserve the needed space (5 bytes) for the packet header.

Parameters:

cmd - the SSH command

Returns:

a new buffer ready for write

createBuffer

Buffer createBuffer(byte cmd,
                  int estimatedSize)

Create a new buffer for the specified SSH packet and reserve the needed space (5 bytes) for the packet header.

Parameters:

cmd - the SSH command

estimatedSize - estimated number of bytes the buffer will hold, 0 if unknown.

Returns:

a new buffer ready for write

writePacket

IoWriteFuture writePacket(Buffer buffer)
                          throws java.io.IOException

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.

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:

java.io.IOException - if an error occured when encoding sending the packet

request

Buffer request(Buffer buffer)
               throws java.io.IOException

Send a global request and wait for the response. This must only be used when sending a SSH_MSG_GLOBAL_REQUEST with a result expected, else it will wait forever.

Parameters:

buffer - the buffer containing the global request

Returns:

the return buffer if the request was successful, null otherwise.

Throws:

java.io.IOException - if an error occurred when encoding sending the packet

exceptionCaught

void exceptionCaught(java.lang.Throwable t)

Handle any exceptions that occured on this session. The session will be closed and a disconnect packet will be sent before if the given exception is an SshException.

Parameters:

t - the exception to process

addListener

void addListener(SessionListener listener)

Add a session |listener|.

Parameters:

listener - the session listener to add

removeListener

void removeListener(SessionListener listener)

Remove a session |listener|.

Parameters:

listener - the session listener to remove

reExchangeKeys

SshFuture reExchangeKeys()
                         throws java.io.IOException

Initiate a new key exchange.

Throws:

java.io.IOException