org.snf4j.core

Class SSLSession

java.lang.Object

org.snf4j.core.IdentifiableObject

org.snf4j.core.session.AbstractSession

org.snf4j.core.StreamSession

org.snf4j.core.EngineStreamSession

org.snf4j.core.SSLSession

All Implemented Interfaces:

IEngineSession, IEngineStreamSession, ISession, IStreamSession

public class SSLSession
extends EngineStreamSession

The stream-oriented session that handles SSL/TLS connections.

It uses SSLEngine to handle secure protocols such as the Secure Sockets Layer (SSL) or IETF RFC 2246 "Transport Layer Security" (TLS) protocols.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
SSLSession(IStreamHandler handler, boolean clientMode) Constructs the SSL/TLS session associated with a handler.
SSLSession(SocketAddress remoteAddress, IStreamHandler handler, boolean clientMode) Constructs the SSL/TLS session associated with a handler and a remote peer.
SSLSession(String name, IStreamHandler handler, boolean clientMode) Constructs the named SSL/TLS session associated with a handler.
SSLSession(String name, SocketAddress remoteAddress, IStreamHandler handler, boolean clientMode) Constructs the named SSL/TLS session associated with a handler and a remote peer.

Method Summary

Modifier and Type	Method and Description
ByteBuffer	allocate(int capacity) Allocates a byte buffer by using the allocator associated with this session.
IFuture<Void>	getCloseFuture() Gets the future that can be use to wait for the completion of the closing phase.
ICodecPipeline	getCodecPipeline() Gets the codec pipeline that is associated with this session.
ISessionConfig	getConfig() Gets the configuration of this session.
IFuture<Void>	getCreateFuture() Gets the future that can be use to wait for the completion of the creation phase.
long	getCreationTime() Gets the session's creation time in milliseconds.
IFuture<Void>	getEndFuture() Gets the future that can be use to wait for the completion of the ending phase.
SSLSession	getEngineSession() Returns the SSLSession in use in the SSLEngine driving this session.
long	getLastIoTime() Gets the time in milliseconds when I/O operation occurred lastly.
long	getLastReadTime() Gets the time in milliseconds when read operation occurred lastly.
long	getLastWriteTime() Gets the time in milliseconds when write operation occurred lastly.
IFuture<Void>	getOpenFuture() Gets the future that can be use to wait for the completion of the opening phase.
long	getReadBytes() Gets the total number of bytes which were read from this session.
double	getReadBytesThroughput() Gets the number of read bytes per second.
IFuture<Void>	getReadyFuture() Gets the future that can be use to wait for the completion of the ready phase.
SessionState	getState() Gets the current state of this session.
ISessionTimer	getTimer() Gets the session timer associated with this session.
long	getWrittenBytes() Gets the total number of bytes which were written to this session.
double	getWrittenBytesThroughput() Gets the number of written bytes per second.
boolean	isOpen() Tells if this session is open.
boolean	isReadSuspended() Tells if read operations are suspended for this session.
boolean	isWriteSuspended() Tells if write operations are suspended for this session.
void	release(ByteBuffer buffer) Release given byte buffer by the allocator associated with this session.
void	resumeRead() Resumes read operations for this session.
void	resumeWrite() Resumes write operations for this session.
void	suspendRead() Suspends read operations for this session.
void	suspendWrite() Suspends write operations for this session.

Methods inherited from class org.snf4j.core.EngineStreamSession

beginHandshake, beginLazyHandshake, close, dirtyClose, getExecutor, getHandler, quickClose, setExecutor, write, write, write, write, writenf, writenf, writenf, writenf

Methods inherited from class org.snf4j.core.StreamSession

getLocalAddress, getParent, getRemoteAddress, write, writenf

Methods inherited from class org.snf4j.core.session.AbstractSession

getAttributes

Methods inherited from class org.snf4j.core.IdentifiableObject

getId, getName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snf4j.core.session.IStreamSession

getParent, write, writenf

Methods inherited from interface org.snf4j.core.session.ISession

allocate, getAttributes, getCloseFuture, getCodecPipeline, getConfig, getCreateFuture, getCreationTime, getEndFuture, getId, getLastIoTime, getLastReadTime, getLastWriteTime, getLocalAddress, getName, getOpenFuture, getReadBytes, getReadBytesThroughput, getReadyFuture, getRemoteAddress, getState, getTimer, getWrittenBytes, getWrittenBytesThroughput, isOpen, isReadSuspended, isWriteSuspended, release, resumeRead, resumeWrite, suspendRead, suspendWrite

Constructor Detail

SSLSession

public SSLSession(String name,
                  SocketAddress remoteAddress,
                  IStreamHandler handler,
                  boolean clientMode)
           throws SSLEngineCreateException

Constructs the named SSL/TLS session associated with a handler and a remote peer.

Parameters:

name - the name for this session, or null if the handler's name should be used for this session's name

remoteAddress - the address of the remote peer

handler - the handler that should be associated with this session

clientMode - true if the engine should start its handshaking in "client" mode

Throws:

SSLEngineCreateException - when the SSL engine could not be created

SSLSession

public SSLSession(SocketAddress remoteAddress,
                  IStreamHandler handler,
                  boolean clientMode)
           throws SSLEngineCreateException

Constructs the SSL/TLS session associated with a handler and a remote peer.

Parameters:

remoteAddress - the address of the remote peer

handler - the handler that should be associated with this session

clientMode - true if the engine should start its handshaking in "client" mode

Throws:

SSLEngineCreateException - when the SSL engine could not be created

SSLSession

public SSLSession(String name,
                  IStreamHandler handler,
                  boolean clientMode)
           throws SSLEngineCreateException

Constructs the named SSL/TLS session associated with a handler.

Parameters:

name - the name for this session, or null if the handler's name should be used for this session's name

handler - the handler that should be associated with this session

clientMode - true if the engine should start its handshaking in "client" mode

Throws:

SSLEngineCreateException - when the SSL engine could not be created

SSLSession

public SSLSession(IStreamHandler handler,
                  boolean clientMode)
           throws SSLEngineCreateException

Constructs the SSL/TLS session associated with a handler.

Parameters:

handler - the handler that should be associated with this session

clientMode - true if the engine should start its handshaking in "client" mode

Throws:

SSLEngineCreateException - when the SSL engine could not be created

Method Detail

getEngineSession

public SSLSession getEngineSession()

Returns the SSLSession in use in the SSLEngine driving this session.

Specified by:

getEngineSession in interface IEngineSession

Overrides:

getEngineSession in class EngineStreamSession

Returns:

the SSLSession

getCreateFuture

public IFuture<Void> getCreateFuture()

Description copied from interface: ISession

Gets the future that can be use to wait for the completion of the creation phase.

Specified by:

getCreateFuture in interface ISession

Returns:

the future associated with the creation phase of this session

getOpenFuture

public IFuture<Void> getOpenFuture()

Description copied from interface: ISession

Gets the future that can be use to wait for the completion of the opening phase.

Specified by:

getOpenFuture in interface ISession

Returns:

the future associated with the opening phase of this session

getReadyFuture

public IFuture<Void> getReadyFuture()

Description copied from interface: ISession

Gets the future that can be use to wait for the completion of the ready phase.

Specified by:

getReadyFuture in interface ISession

Returns:

the future associated with the opening phase of this session

getCloseFuture

public IFuture<Void> getCloseFuture()

Description copied from interface: ISession

Gets the future that can be use to wait for the completion of the closing phase.

Specified by:

getCloseFuture in interface ISession

Returns:

the future associated with the closing phase of this session

getEndFuture

public IFuture<Void> getEndFuture()

Description copied from interface: ISession

Gets the future that can be use to wait for the completion of the ending phase.

Specified by:

getEndFuture in interface ISession

Returns:

the future associated with the ending phase of this session

getConfig

public ISessionConfig getConfig()

Description copied from interface: ISession

Gets the configuration of this session.

Specified by:

getConfig in interface ISession

Returns:

the configuration

getCodecPipeline

public ICodecPipeline getCodecPipeline()

Description copied from interface: ISession

Gets the codec pipeline that is associated with this session.

Specified by:

getCodecPipeline in interface ISession

Returns:

the codec pipeline or null if the session does not support it

getState

public SessionState getState()

Description copied from interface: ISession

Gets the current state of this session.

Specified by:

getState in interface ISession

Returns:

the current state

isOpen

public boolean isOpen()

Description copied from interface: ISession

Tells if this session is open. It means that the session is able to communicate with the remote end.

It is equal to:

 return getState() == SessionState.OPEN
 

Specified by:

isOpen in interface ISession

Returns:

true if the session is open.

suspendRead

public void suspendRead()

Description copied from interface: ISession

Suspends read operations for this session.

Specified by:

suspendRead in interface ISession

suspendWrite

public void suspendWrite()

Description copied from interface: ISession

Suspends write operations for this session.

Specified by:

suspendWrite in interface ISession

resumeRead

public void resumeRead()

Description copied from interface: ISession

Resumes read operations for this session.

Specified by:

resumeRead in interface ISession

resumeWrite

public void resumeWrite()

Description copied from interface: ISession

Resumes write operations for this session.

Specified by:

resumeWrite in interface ISession

isReadSuspended

public boolean isReadSuspended()

Description copied from interface: ISession

Tells if read operations are suspended for this session.

Specified by:

isReadSuspended in interface ISession

Returns:

true if suspended

isWriteSuspended

public boolean isWriteSuspended()

Description copied from interface: ISession

Tells if write operations are suspended for this session.

Specified by:

isWriteSuspended in interface ISession

Returns:

true if suspended

getReadBytes

public final long getReadBytes()

Description copied from interface: ISession

Gets the total number of bytes which were read from this session.

Specified by:

getReadBytes in interface ISession

Returns:

the total number of bytes

getWrittenBytes

public final long getWrittenBytes()

Description copied from interface: ISession

Gets the total number of bytes which were written to this session.

Specified by:

getWrittenBytes in interface ISession

Returns:

the total number of bytes

getReadBytesThroughput

public final double getReadBytesThroughput()

Description copied from interface: ISession

Gets the number of read bytes per second.

Specified by:

getReadBytesThroughput in interface ISession

Returns:

the number of read bytes per second

getWrittenBytesThroughput

public final double getWrittenBytesThroughput()

Description copied from interface: ISession

Gets the number of written bytes per second.

Specified by:

getWrittenBytesThroughput in interface ISession

Returns:

the number of written bytes per second

getCreationTime

public final long getCreationTime()

Description copied from interface: ISession

Gets the session's creation time in milliseconds.

Specified by:

getCreationTime in interface ISession

Returns:

the session's creation time

getLastIoTime

public final long getLastIoTime()

Description copied from interface: ISession

Gets the time in milliseconds when I/O operation occurred lastly.

Specified by:

getLastIoTime in interface ISession

Returns:

the time of the last I/O operation

getLastReadTime

public final long getLastReadTime()

Description copied from interface: ISession

Gets the time in milliseconds when read operation occurred lastly.

Specified by:

getLastReadTime in interface ISession

Returns:

the time of the last read operation

getLastWriteTime

public final long getLastWriteTime()

Description copied from interface: ISession

Gets the time in milliseconds when write operation occurred lastly.

Specified by:

getLastWriteTime in interface ISession

Returns:

the time of the last write operation

getTimer

public ISessionTimer getTimer()

Description copied from interface: ISession

Gets the session timer associated with this session.

Specified by:

getTimer in interface ISession

Returns:

the session timer

allocate

public ByteBuffer allocate(int capacity)

Description copied from interface: ISession

Allocates a byte buffer by using the allocator associated with this session.

Specified by:

allocate in interface ISession

Parameters:

capacity - minimal required capacity

Returns:

the allocated byte buffer

release

public void release(ByteBuffer buffer)

Description copied from interface: ISession

Release given byte buffer by the allocator associated with this session.

Specified by:

release in interface ISession

Parameters:

buffer - the byte buffer being released