org.restlet.ext.nio.internal.connection

Class SslConnection<T extends Connector>

java.lang.Object

org.restlet.ext.nio.internal.connection.Connection<T>

org.restlet.ext.nio.internal.connection.SslConnection<T>

Type Parameters:

T -

All Implemented Interfaces:

SelectionListener

public class SslConnection<T extends Connector>
extends Connection<T>

Connection secured with SSL/TLS protocols.

Author:

Jerome Louvel

Constructor Summary

Constructors

Constructor and Description
SslConnection(ConnectionHelper<T> helper, SocketChannel socketChannel, ConnectionController controller, InetSocketAddress socketAddress, SSLEngine sslEngine) Constructor.

Method Summary

Modifier and Type	Method and Description
protected ReadableSelectionChannel	createReadableSelectionChannel() Creates a new readable channel.
protected WritableSelectionChannel	createWritableSelectionChannel() Creates a new writable channel.
int	getApplicationBufferSize() Returns the suggested application buffer size.
int	getInboundBufferSize() Returns the size of the content buffer for receiving messages.
int	getOutboundBufferSize() Returns the size of the content buffer for sending responses.
int	getPacketBufferSize() Returns the suggested SSL packet buffer size.
InetSocketAddress	getPeerAddress() Returns the peer address.
String	getSslCipherSuite() Returns the SSL cipher suite.
List<Certificate>	getSslClientCertificates() Returns the list of client SSL certificates.
SSLEngine	getSslEngine() Returns the engine to use for wrapping and unwrapping.
SSLEngineResult	getSslEngineResult() Returns the engine result.
SSLEngineResult.Status	getSslEngineStatus() Returns the latest SSL engine status, or SSLEngineResult.Status#OK otherwise.
SSLEngineResult.HandshakeStatus	getSslHandshakeStatus() Returns the SSL handshake status, either from the latest engine result or from the SSL engine.
Integer	getSslKeySize() Returns the SSL key size, if available and accessible.
SSLSession	getSslSession() Returns the current SSL session or null.
void	handleSslResult() Handles the result of a previous SSL engine processing.
void	initSslEngine() Initializes the SSL engine with the current SSL context and socket address.
boolean	isSslHandshaking() Indicates if the SSL handshake is going on.
void	reuse(SocketChannel socketChannel, ConnectionController controller, InetSocketAddress socketAddress) Reuses the connection and associates it to the given socket.
void	setPeerAddress(InetSocketAddress peerAddress) Sets the peer address.
void	setSslEngine(SSLEngine engine) Sets the engine to use for wrapping and unwrapping.
protected void	setSslEngineResult(SSLEngineResult engineResult) Sets the engine result.
void	setSslResult(SSLEngineResult sslResult) Saves the result of a previous SSL engine processing.
protected void	shutdown(Socket socket) Shutdowns the socket, first its input then its output.
String	toString()

Methods inherited from class org.restlet.ext.nio.internal.connection.Connection

clear, close, commit, getAddress, getHelper, getInboundWay, getLastActivity, getLoadScore, getLogger, getMaxIoIdleTimeMs, getOutboundWay, getPort, getReadableSelectionChannel, getRegistration, getSocket, getSocketAddress, getSocketChannel, getState, getWritableSelectionChannel, hasTimedOut, init, isAvailable, isClientSide, isEmpty, isPersistent, isPipelining, isReady, isServerSide, onActivity, onError, onSelected, onTimeOut, open, setPersistent, setPipelining, setRegistration, setState, updateState

Methods inherited from class java.lang.Object

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

Constructor Detail

SslConnection

public SslConnection(ConnectionHelper<T> helper,
                     SocketChannel socketChannel,
                     ConnectionController controller,
                     InetSocketAddress socketAddress,
                     SSLEngine sslEngine)
              throws IOException

Constructor.

Parameters:

helper - The parent connector helper.

socketChannel - The underlying NIO socket channel.

controller - The IO controller.

socketAddress - The associated IP address.

Throws:

IOException

Method Detail

createReadableSelectionChannel

protected ReadableSelectionChannel createReadableSelectionChannel()

Description copied from class: Connection

Creates a new readable channel.

Overrides:

createReadableSelectionChannel in class Connection<T extends Connector>

Returns:

A new readable channel.

createWritableSelectionChannel

protected WritableSelectionChannel createWritableSelectionChannel()

Description copied from class: Connection

Creates a new writable channel.

Overrides:

createWritableSelectionChannel in class Connection<T extends Connector>

Returns:

A new writable channel.

getApplicationBufferSize

public int getApplicationBufferSize()

Returns the suggested application buffer size.

Returns:

The suggested application buffer size.

getInboundBufferSize

public int getInboundBufferSize()

Description copied from class: Connection

Returns the size of the content buffer for receiving messages. By default, it calls Connection.getInboundBufferSize().

Overrides:

getInboundBufferSize in class Connection<T extends Connector>

Returns:

The size of the content buffer for receiving messages.

getOutboundBufferSize

public int getOutboundBufferSize()

Description copied from class: Connection

Returns the size of the content buffer for sending responses. By default, it calls Connection.getOutboundBufferSize().

Overrides:

getOutboundBufferSize in class Connection<T extends Connector>

Returns:

The size of the content buffer for sending responses.

getPacketBufferSize

public int getPacketBufferSize()

Returns the suggested SSL packet buffer size.

Returns:

The suggested SSL packet buffer size.

getPeerAddress

public InetSocketAddress getPeerAddress()

Returns the peer address.

Returns:

The peer address.

getSslCipherSuite

public String getSslCipherSuite()

Returns the SSL cipher suite.

Returns:

The SSL cipher suite.

getSslClientCertificates

public List<Certificate> getSslClientCertificates()

Returns the list of client SSL certificates.

Returns:

The list of client SSL certificates.

getSslEngine

public SSLEngine getSslEngine()

Returns the engine to use for wrapping and unwrapping.

Returns:

The engine to use for wrapping and unwrapping.

getSslEngineResult

public SSLEngineResult getSslEngineResult()

Returns the engine result.

Returns:

The engine result.

getSslEngineStatus

public SSLEngineResult.Status getSslEngineStatus()

Returns the latest SSL engine status, or SSLEngineResult.Status#OK otherwise.

Returns:

The latest SSL engine status.

getSslHandshakeStatus

public SSLEngineResult.HandshakeStatus getSslHandshakeStatus()

Returns the SSL handshake status, either from the latest engine result or from the SSL engine.

Returns:

The SSL handshake status.

getSslKeySize

public Integer getSslKeySize()

Returns the SSL key size, if available and accessible.

Returns:

The SSL key size, if available and accessible.

getSslSession

public SSLSession getSslSession()

Returns the current SSL session or null.

Returns:

The current SSL session or null.

handleSslResult

public void handleSslResult()
                     throws IOException

Handles the result of a previous SSL engine processing.

Throws:

IOException

initSslEngine

public void initSslEngine()
                   throws SSLException

Initializes the SSL engine with the current SSL context and socket address.

Throws:

SSLException

isSslHandshaking

public boolean isSslHandshaking()

Indicates if the SSL handshake is going on.

Returns:

True if the SSL handshake is going on.

reuse

public void reuse(SocketChannel socketChannel,
                  ConnectionController controller,
                  InetSocketAddress socketAddress)
           throws IOException

Description copied from class: Connection

Reuses the connection and associates it to the given socket.

Overrides:

reuse in class Connection<T extends Connector>

Parameters:

socketChannel - The underlying NIO socket channel.

controller - The underlying IO controller.

socketAddress - The associated socket address.

Throws:

IOException

setPeerAddress

public void setPeerAddress(InetSocketAddress peerAddress)

Sets the peer address.

Parameters:

peerAddress - The peer address.

setSslEngine

public void setSslEngine(SSLEngine engine)

Sets the engine to use for wrapping and unwrapping.

Parameters:

engine - The engine to use for wrapping and unwrapping.

setSslEngineResult

protected void setSslEngineResult(SSLEngineResult engineResult)

Sets the engine result.

Parameters:

engineResult - The engine result.

setSslResult

public void setSslResult(SSLEngineResult sslResult)
                  throws IOException

Saves the result of a previous SSL engine processing.

Parameters:

sslResult - The SSL result to handle.

Throws:

IOException

shutdown

protected void shutdown(Socket socket)
                 throws IOException

Description copied from class: Connection

Shutdowns the socket, first its input then its output.

Overrides:

shutdown in class Connection<T extends Connector>

Parameters:

socket - The socket to shutdown.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Connection<T extends Connector>