net.officefloor.plugin.socket.server.impl

Class ConnectionImpl

java.lang.Object

net.officefloor.plugin.socket.server.impl.ConnectionImpl

All Implemented Interfaces:

ManagedConnection, Connection, WriteDataAction, WriteBufferReceiver

public class ConnectionImpl
extends Object
implements Connection, ManagedConnection, WriteDataAction

Implementation of a Connection.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
ConnectionImpl(SelectionKey selectionKey, SocketChannel socketChannel, CommunicationProtocol communicationProtocol, SocketListener socketListener) Initiate.

Method Summary

Modifier and Type	Method and Description
void	close() Flags to close the WriteBufferReceiver.
WriteBuffer	createWriteBuffer(byte[] data, int length) Creates a WriteBuffer for the data.
WriteBuffer	createWriteBuffer(ByteBuffer buffer) Creates the WriteBuffer for the ByteBuffer.
ManagedConnection	getConnection() Obtains the ManagedConnection for the WriteDataAction.
ConnectionHandler	getConnectionHandler() Obtains the ConnectionHandler.
InetSocketAddress	getLocalAddress() Obtains the local address for the Connection.
Object	getLock() Obtains the lock to synchronize for using this WriteBufferReceiver.
InetSocketAddress	getRemoteAddress() Obtains the remote address for the Connection.
SelectionKey	getSelectionKey() Obtains the SelectionKey for the Connection.
SocketChannel	getSocketChannel() Obtains the SocketChannel for the Connection.
boolean	isClosed() Indicates if the WriteBufferReceiver is closed.
boolean	isSecure() Indicates if the connection is over a secure channel (e.g.
boolean	processWriteQueue() Undertakes the queued writes and possible Connection close.
void	terminate() Terminates this Connection immediately.
void	writeData(WriteBuffer[] data) Writes data to client of this Connection.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionImpl

public ConnectionImpl(SelectionKey selectionKey,
                      SocketChannel socketChannel,
                      CommunicationProtocol communicationProtocol,
                      SocketListener socketListener)

Initiate.

Parameters:

selectionKey - SelectionKey for this Connection.

socketChannel - SocketChannel for this Connection.

communicationProtocol - CommunicationProtocol.

socketListener - SocketListener.

Method Detail

getLock

public Object getLock()

Description copied from interface: WriteBufferReceiver

Obtains the lock to synchronize for using this WriteBufferReceiver.

Specified by:

getLock in interface WriteBufferReceiver

Returns:

Lock for this WriteBufferReceiver.

isSecure

public boolean isSecure()

Description copied from interface: Connection

Indicates if the connection is over a secure channel (e.g. utilising SSL).

Specified by:

isSecure in interface Connection

Returns:

true if connection is over a secure channel.

createWriteBuffer

public WriteBuffer createWriteBuffer(byte[] data,
                                     int length)

Description copied from interface: WriteBufferReceiver

Creates a WriteBuffer for the data.

Specified by:

createWriteBuffer in interface WriteBufferReceiver

Parameters:

data - Data.

length - Length of data.

Returns:

WriteBuffer.

createWriteBuffer

public WriteBuffer createWriteBuffer(ByteBuffer buffer)

Description copied from interface: WriteBufferReceiver

Creates the WriteBuffer for the ByteBuffer.

Specified by:

createWriteBuffer in interface WriteBufferReceiver

Parameters:

buffer - ByteBuffer.

Returns:

WriteBuffer.

writeData

public void writeData(WriteBuffer[] data)
               throws IOException

Description copied from interface: WriteBufferReceiver

Writes data to client of this Connection.

Specified by:

writeData in interface WriteBufferReceiver

Parameters:

data - Data to be written.

Throws:

IOException - If fails to write data.

getLocalAddress

public InetSocketAddress getLocalAddress()

Description copied from interface: Connection

Obtains the local address for the Connection.

Specified by:

getLocalAddress in interface Connection

Returns:

InetSocketAddress describing the local Socket for the Connection.

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: Connection

Obtains the remote address for the Connection.

Specified by:

getRemoteAddress in interface Connection

Returns:

InetSocketAddress describing the remote Socket for the Connection.

close

public void close()
           throws IOException

Description copied from interface: WriteBufferReceiver

Flags to close the WriteBufferReceiver.

Close occurs after all data has been written.

Specified by:

close in interface WriteBufferReceiver

Throws:

IOException - If fails to close.

isClosed

public boolean isClosed()

Description copied from interface: WriteBufferReceiver

Indicates if the WriteBufferReceiver is closed.

Specified by:

isClosed in interface WriteBufferReceiver

Returns:

true if the WriteBufferReceiver is closed.

getSelectionKey

public SelectionKey getSelectionKey()

Description copied from interface: ManagedConnection

Obtains the SelectionKey for the Connection.

Specified by:

getSelectionKey in interface ManagedConnection

Returns:

SelectionKey for the Connection.

getSocketChannel

public SocketChannel getSocketChannel()

Description copied from interface: ManagedConnection

Obtains the SocketChannel for the Connection.

Specified by:

getSocketChannel in interface ManagedConnection

Returns:

SocketChannel for the Connection.

getConnectionHandler

public ConnectionHandler getConnectionHandler()

Description copied from interface: ManagedConnection

Obtains the ConnectionHandler.

Specified by:

getConnectionHandler in interface ManagedConnection

Returns:

ConnectionHandler.

processWriteQueue

public boolean processWriteQueue()
                          throws IOException

Description copied from interface: ManagedConnection

Undertakes the queued writes and possible Connection close.

Specified by:

processWriteQueue in interface ManagedConnection

Returns:

true if all data written. false indicating not able to write all data, requiring waiting for client to consume data (clear space in socket buffer).

Throws:

IOException - If fails to process the queued writes.

terminate

public void terminate()
               throws IOException

Description copied from interface: ManagedConnection

Terminates this Connection immediately.

Specified by:

terminate in interface ManagedConnection

Throws:

IOException - If fails to terminate the Connection.

getConnection

public ManagedConnection getConnection()

Description copied from interface: WriteDataAction

Obtains the ManagedConnection for the WriteDataAction.

Specified by:

getConnection in interface WriteDataAction

Returns:

ManagedConnection for the WriteDataAction.