org.apache.sshd.common.session

Interface Session

All Superinterfaces:

AutoCloseable, Channel, Closeable

All Known Subinterfaces:

ClientSession, ServerSession

All Known Implementing Classes:

AbstractSession, ClientSessionImpl, ServerSessionImpl

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.
static class	Session.TimeoutStatus Timeout status.

Method Summary

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	disconnect(int reason, String msg) Send a disconnect packet with the given reason and message.
void	exceptionCaught(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.
long	getAuthTimeout()
String	getClientVersion() Retrieve the client version for this session.
FactoryManager	getFactoryManager()
long	getIdleTimeout()
int	getIntProperty(String name, int defaultValue) Retrieve a configuration property as an integer
IoSession	getIoSession()
KeyExchange	getKex()
String	getNegotiatedKexParameter(KexProposalOption paramType) Retrieve one of the negotiated values during the KEX stage
String	getServerVersion() Retrieve the server version for this session.
<T extends Service> T	getService(Class<T> clazz) Get the service of the specified type.
byte[]	getSessionId()
Session.TimeoutStatus	getTimeoutStatus() Check if timeout has occurred.
String	getUsername() Retrieve the name of the user authenticated on this session or null if the session has not been authenticated yet.
boolean	isAuthenticated()
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.
void	resetIdleTimeout()
<T,E extends T> T	setAttribute(Session.AttributeKey<T> key, E value) Sets a user-defined attribute.
void	setAuthenticated()
void	setUsername(String username)
void	startService(String name)
IoWriteFuture	writePacket(Buffer buffer) Encode and send the given buffer.
IoWriteFuture	writePacket(Buffer buffer, long timeout, TimeUnit unit) Encode and send the given buffer with the specified timeout.

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

close, isClosed, isClosing

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Method Detail

getAttribute

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

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

Type Parameters:

T - The generic attribute type

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.

Type Parameters:

T - The generic attribute type

E - The generic value type

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

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.

setUsername

void setUsername(String username)

getClientVersion

String getClientVersion()

Retrieve the client version for this session.

Returns:

the client version.

getServerVersion

String getServerVersion()

Retrieve the server version for this session.

Returns:

the server version.

getFactoryManager

FactoryManager getFactoryManager()

Returns:

the FactoryManager that has created this session, can not be null

getNegotiatedKexParameter

String getNegotiatedKexParameter(KexProposalOption paramType)

Retrieve one of the negotiated values during the KEX stage

Parameters:

paramType - The request KexProposalOption value - ignored if null

Returns:

The negotiated parameter value - null if invalid parameter or no negotiated value

getIntProperty

int getIntProperty(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 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:

IOException - if an error occurred when encoding sending the packet

writePacket

IoWriteFuture writePacket(Buffer buffer,
                          long timeout,
                          TimeUnit unit)
                   throws IOException

Encode and send the given buffer with the specified timeout. If the buffer could not be written before the timeout elapses, the returned IoWriteFuture will be set with a TimeoutException exception to indicate a timeout.

Parameters:

buffer - the buffer to encode and spend

timeout - the timeout

unit - the time unit of the timeout parameter

Returns:

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

Throws:

IOException - if an error occurred when encoding sending the packet

request

Buffer request(Buffer buffer)
        throws 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:

IOException - if an error occurred when encoding sending the packet

exceptionCaught

void exceptionCaught(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 IOException

Initiate a new key exchange.

Returns:

An SshFuture for awaiting the completion of the exchange

Throws:

IOException - If failed to negotiate keys

getService

<T extends Service> T getService(Class<T> clazz)

Get the service of the specified type. If the service is not of the specified class, an IllegalStateException will be thrown.

Type Parameters:

T - The generic service type

Parameters:

clazz - The service class

Returns:

The service instance

Throws:

IllegalStateException - If failed to find a matching service

getIoSession

IoSession getIoSession()

Returns:

the IoSession associated to this session

resetIdleTimeout

void resetIdleTimeout()

getTimeoutStatus

Session.TimeoutStatus getTimeoutStatus()

Check if timeout has occurred.

Returns:

the timeout status, never null

getAuthTimeout

long getAuthTimeout()

Returns:

Timeout value in milliseconds for authentication stage

getIdleTimeout

long getIdleTimeout()

Returns:

Timeout value in milliseconds for communication

isAuthenticated

boolean isAuthenticated()

setAuthenticated

void setAuthenticated()
               throws IOException

Throws:

IOException

getSessionId

byte[] getSessionId()

getKex

KeyExchange getKex()

disconnect

void disconnect(int reason,
                String msg)
         throws IOException

Send a disconnect packet with the given reason and message. Once the packet has been sent, the session will be closed asynchronously.

Parameters:

reason - the reason code for this disconnect

msg - the text message

Throws:

IOException - if an error occurred sending the packet

startService

void startService(String name)
           throws Exception

Parameters:

name - Service name

Throws:

Exception - If failed to start it