net.officefloor.plugin.socket.server.ssl.protocol

Class SslConnectionHandler

java.lang.Object

net.officefloor.plugin.socket.server.ssl.protocol.SslConnectionHandler

All Implemented Interfaces:

ConnectionHandler, ConnectionHandlerContext, HeartBeatContext, ReadContext

public class SslConnectionHandler
extends Object
implements ConnectionHandler, ReadContext, HeartBeatContext

SSL ConnectionHandler.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
SslConnectionHandler(Connection connection, SSLEngine engine, SslTaskExecutor taskExecutor, int sendBufferSize, CommunicationProtocol wrappedCommunicationProtocol) Initiate.

Method Summary

Modifier and Type	Method and Description
byte[]	getData() Obtains the data just read to be consumed by the ConnectionHandler.
long	getTime() Obtains the current time in milliseconds.
void	handleHeartbeat(HeartBeatContext context) Handles a heart beat on Connection.
void	handleRead(ReadContext context) Handles a read from the SocketChannel.

Methods inherited from class java.lang.Object

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

Constructor Detail

SslConnectionHandler

public SslConnectionHandler(Connection connection,
                            SSLEngine engine,
                            SslTaskExecutor taskExecutor,
                            int sendBufferSize,
                            CommunicationProtocol wrappedCommunicationProtocol)

Initiate.

Parameters:

connection - Connection.

engine - SSLEngine.

taskExecutor - SslTaskExecutor.

sendBufferSize - Send buffer size.

wrappedCommunicationProtocol - Wrapped CommunicationProtocol.

Method Detail

handleRead

public void handleRead(ReadContext context)
                throws IOException

Description copied from interface: ConnectionHandler

Handles a read from the SocketChannel.

Specified by:

handleRead in interface ConnectionHandler

Parameters:

context - ReadContext.

Throws:

IOException - If fails to obtain data from the ReadContext.

handleHeartbeat

public void handleHeartbeat(HeartBeatContext context)
                     throws IOException

Description copied from interface: ConnectionHandler

Handles a heart beat on Connection.

Typical use of the heart beat is to allow the ConnectionHandler to close an idle Connection.

Specified by:

handleHeartbeat in interface ConnectionHandler

Parameters:

context - HeartBeatContext.

Throws:

IOException - If fails to handle heart beat. Possibly from attempting to close it.

getTime

public long getTime()

Description copied from interface: ConnectionHandlerContext

Obtains the current time in milliseconds.

This should return similar to System.currentTimeMillis() but is provided to cache time for multiple quick operations that require only estimates of time (e.g. time out idle connections in seconds).

Note CPU operations should be in the nanoseconds.

Specified by:

getTime in interface ConnectionHandlerContext

Returns:

Time measured in milliseconds.

getData

public byte[] getData()

Description copied from interface: ReadContext

Obtains the data just read to be consumed by the ConnectionHandler.

The returned array is always new and must be consumed (or stored to be consumed) by the ConnectionHandler.

Specified by:

getData in interface ReadContext

Returns:

Data to be consumed by the ConnectionHandler.