org.baswell.niossl

Class SSLServerSocketChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

java.nio.channels.ServerSocketChannel

org.baswell.niossl.SSLServerSocketChannel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel, java.nio.channels.InterruptibleChannel, java.nio.channels.NetworkChannel

public class SSLServerSocketChannel
extends java.nio.channels.ServerSocketChannel

A wrapper around a real ServerSocketChannel that produces SSLSocketChannel on accept(). The real ServerSocketChannel must be bound externally (to this class) before calling the accept method.

See Also:

SSLSocketChannel

Field Summary

Fields

Modifier and Type	Field and Description
boolean	blockingMode Should the SSLSocketChannels created from the accept method be put in blocking mode.
java.util.List<java.lang.String>	excludedCipherSuites A list of ciphers to explicitly exclude for the SSL exchange.
java.util.List<java.lang.String>	excludedProtocols A list of SSL protocols (SSLv2, SSLv3, etc.) to explicitly exclude for the SSL exchange.
java.util.List<java.lang.String>	includedCipherSuites The list of ciphers allowed for the SSL exchange.
java.util.List<java.lang.String>	includedProtocols The list of SSL protocols (TLSv1, TLSv1.1, etc.) supported for the SSL exchange.
boolean	needClientAuthentication Should the SSL server require client certificate authentication? Default is false.
boolean	wantClientAuthentication Should the SS server ask for client certificate authentication? Default is false.

Constructor Summary

Constructors

Constructor and Description
SSLServerSocketChannel(java.nio.channels.ServerSocketChannel serverSocketChannel, javax.net.ssl.SSLContext sslContext, java.util.concurrent.ExecutorService threadPool, NioSslLogger logger)

Method Summary

Methods

Modifier and Type	Method and Description
java.nio.channels.SocketChannel	accept() Accepts a connection made to this channel's socket.
SSLSocketChannel	acceptOverSSL() Convenience call to keep from having to cast SocketChannel into SSLSocketChannel when calling accept().
java.nio.channels.ServerSocketChannel	bind(java.net.SocketAddress local, int backlog)
java.net.SocketAddress	getLocalAddress()
<T> T	getOption(java.net.SocketOption<T> name)
protected void	implCloseSelectableChannel()
protected void	implConfigureBlocking(boolean b)
<T> java.nio.channels.ServerSocketChannel	setOption(java.net.SocketOption<T> name, T value)
java.net.ServerSocket	socket()
java.util.Set<java.net.SocketOption<?>>	supportedOptions()

Methods inherited from class java.nio.channels.ServerSocketChannel

bind, open, validOps

Methods inherited from class java.nio.channels.spi.AbstractSelectableChannel

blockingLock, configureBlocking, implCloseChannel, isBlocking, isRegistered, keyFor, provider, register

Methods inherited from class java.nio.channels.SelectableChannel

register

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel

begin, close, end, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Field Detail

blockingMode

public boolean blockingMode

Should the SSLSocketChannels created from the accept method be put in blocking mode. Default is false.

wantClientAuthentication

public boolean wantClientAuthentication

Should the SS server ask for client certificate authentication? Default is false.

needClientAuthentication

public boolean needClientAuthentication

Should the SSL server require client certificate authentication? Default is false.

includedProtocols

public java.util.List<java.lang.String> includedProtocols

The list of SSL protocols (TLSv1, TLSv1.1, etc.) supported for the SSL exchange. Default is the JVM default.

excludedProtocols

public java.util.List<java.lang.String> excludedProtocols

A list of SSL protocols (SSLv2, SSLv3, etc.) to explicitly exclude for the SSL exchange. Default is none.

includedCipherSuites

public java.util.List<java.lang.String> includedCipherSuites

The list of ciphers allowed for the SSL exchange. Default is the JVM default.

excludedCipherSuites

public java.util.List<java.lang.String> excludedCipherSuites

A list of ciphers to explicitly exclude for the SSL exchange. Default is none.

Constructor Detail

SSLServerSocketChannel

public SSLServerSocketChannel(java.nio.channels.ServerSocketChannel serverSocketChannel,
                      javax.net.ssl.SSLContext sslContext,
                      java.util.concurrent.ExecutorService threadPool,
                      NioSslLogger logger)

Parameters:

serverSocketChannel - The real server socket channel that accepts network requests.

sslContext - The SSL context used to create the SSLEngine for incoming requests.

threadPool - The thread pool passed to SSLSocketChannel used to execute long running, blocking SSL operations such as certificate validation with a CA (NEED_TASK)

logger - The logger for debug and error messages. A null logger will result in no log operations.

Method Detail

acceptOverSSL

public SSLSocketChannel acceptOverSSL()
                               throws java.io.IOException

Convenience call to keep from having to cast SocketChannel into SSLSocketChannel when calling accept().

Returns:

An SSLSocketChannel or null if this channel is in non-blocking mode and no connection is available to be accepted.

Throws:

java.io.IOException

See Also:

accept()

accept

public java.nio.channels.SocketChannel accept()
                                       throws java.io.IOException

Accepts a connection made to this channel's socket.

If this channel is in non-blocking mode then this method will immediately return null if there are no pending connections. Otherwise it will block indefinitely until a new connection is available or an I/O error occurs.

The socket channel returned by this method, if any, will be in blocking mode regardless of the blocking mode of this channel.

This method performs exactly the same security checks as the accept method of the ServerSocket class. That is, if a security manager has been installed then for each new connection this method verifies that the address and port number of the connection's remote endpoint are permitted by the security manager's checkAccept method.

Specified by:

accept in class java.nio.channels.ServerSocketChannel

Returns:

An SSLSocketChannel or null if this channel is in non-blocking mode and no connection is available to be accepted.

Throws:

java.nio.channels.NotYetConnectedException - If this channel is not yet connected

java.nio.channels.ClosedChannelException - If this channel is closed

java.nio.channels.AsynchronousCloseException - If another thread closes this channel while the read operation is in progress

java.nio.channels.ClosedByInterruptException - If another thread interrupts the current thread while the read operation is in progress, thereby closing the channel and setting the current thread's interrupt status

java.io.IOException - If some other I/O error occurs

bind

public java.nio.channels.ServerSocketChannel bind(java.net.SocketAddress local,
                                         int backlog)
                                           throws java.io.IOException

Specified by:

bind in class java.nio.channels.ServerSocketChannel

Throws:

java.io.IOException

getLocalAddress

public java.net.SocketAddress getLocalAddress()
                                       throws java.io.IOException

Throws:

java.io.IOException

setOption

public <T> java.nio.channels.ServerSocketChannel setOption(java.net.SocketOption<T> name,
                                                  T value)
                                                throws java.io.IOException

Specified by:

setOption in interface java.nio.channels.NetworkChannel

Specified by:

setOption in class java.nio.channels.ServerSocketChannel

Throws:

java.io.IOException

getOption

public <T> T getOption(java.net.SocketOption<T> name)
            throws java.io.IOException

Throws:

java.io.IOException

supportedOptions

public java.util.Set<java.net.SocketOption<?>> supportedOptions()

socket

public java.net.ServerSocket socket()

Specified by:

socket in class java.nio.channels.ServerSocketChannel

implCloseSelectableChannel

protected void implCloseSelectableChannel()
                                   throws java.io.IOException

Specified by:

implCloseSelectableChannel in class java.nio.channels.spi.AbstractSelectableChannel

Throws:

java.io.IOException

implConfigureBlocking

protected void implConfigureBlocking(boolean b)
                              throws java.io.IOException

Specified by:

implConfigureBlocking in class java.nio.channels.spi.AbstractSelectableChannel

Throws:

java.io.IOException