ch.dermitza.securenio.socket

Interface SocketIF

All Known Implementing Classes:

PlainSocket, SecureSocket

public interface SocketIF

An interface that defines the underlying SocketChannel implementations.

These can be either of a PlainSocket implementation or a SecureSocket implementation. The interface is needed to envelop the underlying SocketChannel implementations such that the secure channel can perform handshaking, encryption and decryption of the data, as only the Oracle SocketChannel implementation is allowed to be associated with a Selector.

Since:

0.18

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Pass-through implementation of AbstractInterruptibleChannel.close()
java.nio.channels.SelectableChannel	configureBlocking(boolean block) Pass-through implementation of AbstractSelectableChannel.configureBlocking(boolean block)
boolean	connect(java.net.SocketAddress remote) Pass-through implementation of SocketChannel.connect(SocketAddress remote)
boolean	finishConnect() Pass-through implementation of SocketChannel.finishConnect()
java.nio.channels.SocketChannel	getSocket() Returns the underlying SocketChannel.
boolean	handshakePending() Used to identify whether the handshaking performed from the underlying SSLEngine is still pending.
void	initHandshake() Initialize SSL/TLS handshaking.
void	invalidateSession() Invalidate the current SSLSession.
void	processHandshake() Performs SSL/TLS handshaking.
int	read(java.nio.ByteBuffer buffer) Pass-through implementation of SocketChannel.read(ByteBuffer buffer)
java.nio.channels.SelectionKey	register(java.nio.channels.Selector sel, int ops) Pass-through implementation of SelectableChannel.register(Selector sel, int ops)
void	setTaskPending(boolean taskPending) Sets whether or not there is an SSLEngine task pending, during an SSL/TLS handshake.
void	updateResult() Update the SSLEngineResult and setTaskPending(boolean) to false.
int	write(java.nio.ByteBuffer buffer) Pass-through implementation of SocketChannel.write(ByteBuffer buffer)

Method Detail

getSocket

java.nio.channels.SocketChannel getSocket()

Returns the underlying SocketChannel. This is done in order to register the current socket with a Selector, as only the SocketChannel implementation is allowed to be associated with a Selector.

Returns:

the underlying SocketChannel

connect

boolean connect(java.net.SocketAddress remote)
                throws java.io.IOException

Pass-through implementation of SocketChannel.connect(SocketAddress remote)

Parameters:

remote - The remote address to which this channel is to be connected

Returns:

true if a connection was established, false if this channel is in non-blocking mode and the connection operation is in progress

Throws:

java.io.IOException - Propagated exceptions from the underlying SocketChannel.connect(SocketAddress remote) implementation.

finishConnect

boolean finishConnect()
                      throws java.io.IOException

Pass-through implementation of SocketChannel.finishConnect()

Returns:

true if, and only if, this channel's socket is now connected

Throws:

java.io.IOException - Propagated exceptions from the underlying SocketChannel.finishConnect() implementation.

register

java.nio.channels.SelectionKey register(java.nio.channels.Selector sel,
                                      int ops)
                                        throws java.nio.channels.ClosedChannelException

Pass-through implementation of SelectableChannel.register(Selector sel, int ops)

Parameters:

sel - The selector with which this channel is to be registered

ops - The interest set for the resulting key

Returns:

A key representing the registration of this channel with the given selector

Throws:

java.nio.channels.ClosedChannelException - Propagated exceptions from the underlying SelectableChannel.register(Selector sel, int ops) implementation.

configureBlocking

java.nio.channels.SelectableChannel configureBlocking(boolean block)
                                                      throws java.io.IOException

Pass-through implementation of AbstractSelectableChannel.configureBlocking(boolean block)

Parameters:

block - If true then this channel will be placed in blocking mode; if false then it will be placed in non-blocking mode

Returns:

This selectable channel

Throws:

java.io.IOException - Propagated exceptions from the underlying AbstractSelectableChannel.configureBlocking(boolean block) implementation.

read

int read(java.nio.ByteBuffer buffer)
         throws java.io.IOException

Pass-through implementation of SocketChannel.read(ByteBuffer buffer)

Parameters:

buffer - The buffer into which bytes are to be transferred

Returns:

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Throws:

java.io.IOException - Propagated exceptions from the underlying SocketChannel.read(ByteBuffer buffer) implementation.

write

int write(java.nio.ByteBuffer buffer)
          throws java.io.IOException

Pass-through implementation of SocketChannel.write(ByteBuffer buffer)

Parameters:

buffer -

Returns:

The number of bytes written, possibly zero

Throws:

java.io.IOException - Propagated exceptions from the underlying SocketChannel.write(ByteBuffer buffer) implementation.

close

void close()
           throws java.io.IOException

Pass-through implementation of AbstractInterruptibleChannel.close()

Throws:

java.io.IOException - Propagated exceptions from the underlying SocketChannel.close() implementation.

invalidateSession

void invalidateSession()

Invalidate the current SSLSession. This method could be periodically used via a Timeout to perform SSL/TLS session rotation if needed.

This method has NO EFFECT for a PlainSocket implementation.

initHandshake

void initHandshake()
                   throws java.io.IOException

Initialize SSL/TLS handshaking.

This method has NO EFFECT for a PlainSocket implementation.

Throws:

java.io.IOException - propagated exceptions from processHandshake()

javax.net.ssl.SSLException - if there is an SSL/TLS problem with the call to the underlying SSLEngine.beginHandshake().

See Also:

SecureSocket.initHandshake()

updateResult

void updateResult()

Update the SSLEngineResult and setTaskPending(boolean) to false.

This method has NO EFFECT for a PlainSocket implementation.

See Also:

SecureSocket.updateResult()

handshakePending

boolean handshakePending()

Used to identify whether the handshaking performed from the underlying SSLEngine is still pending.

This method has NO EFFECT for a PlainSocket implementation.

Returns:

whether the SSL/TLS handshaking is still pending. Always false for a PlainSocket implementation

See Also:

SecureSocket.handshakePending()

setTaskPending

void setTaskPending(boolean taskPending)

Sets whether or not there is an SSLEngine task pending, during an SSL/TLS handshake.

This method has NO EFFECT for a PlainSocket implementation.

Parameters:

taskPending - Set whether or not there is a SSLEngine task pending for the SSLEngine associated with the underlying SocketChannel. Has no effect in a single threaded implementation.

See Also:

SecureSocket.setTaskPending(boolean)

processHandshake

void processHandshake()
                      throws java.io.IOException

Performs SSL/TLS handshaking.

This method has NO EFFECT for a PlainSocket implementation.

Throws:

java.io.IOException - If there is an underlying IOException while performing the handshake

javax.net.ssl.SSLException - If there is an exception thrown by the underlying SSLEngine while performing the handshake

See Also:

SecureSocket.processHandshake()