org.baswell.niossl

Class SSLSocketChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

java.nio.channels.SocketChannel

org.baswell.niossl.SSLSocketChannel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.ByteChannel, java.nio.channels.Channel, java.nio.channels.GatheringByteChannel, java.nio.channels.InterruptibleChannel, java.nio.channels.NetworkChannel, java.nio.channels.ReadableByteChannel, java.nio.channels.ScatteringByteChannel, java.nio.channels.WritableByteChannel

public class SSLSocketChannel
extends java.nio.channels.SocketChannel

A wrapper around a real SocketChannel that adds SSL support.

Constructor Summary

Constructors

Constructor and Description
SSLSocketChannel(java.nio.channels.SocketChannel socketChannel, javax.net.ssl.SSLEngine sslEngine, java.util.concurrent.ExecutorService executorService, NioSslLogger log)

Method Summary

Methods

Modifier and Type	Method and Description
java.nio.channels.SocketChannel	bind(java.net.SocketAddress local)
boolean	connect(java.net.SocketAddress socketAddress)
boolean	finishConnect()
java.net.SocketAddress	getLocalAddress()
<T> T	getOption(java.net.SocketOption<T> name)
java.net.SocketAddress	getRemoteAddress()
java.nio.channels.SocketChannel	getWrappedSocketChannel()
protected void	implCloseSelectableChannel()
protected void	implConfigureBlocking(boolean b)
boolean	isConnected()
boolean	isConnectionPending()
int	read(java.nio.ByteBuffer applicationBuffer) Reads a sequence of bytes from this channel into the given buffer.
long	read(java.nio.ByteBuffer[] applicationByteBuffers, int offset, int length) Reads a sequence of bytes from this channel into a subsequence of the given buffers.
<T> java.nio.channels.SocketChannel	setOption(java.net.SocketOption<T> name, T value)
java.nio.channels.SocketChannel	shutdownInput()
java.nio.channels.SocketChannel	shutdownOutput()
java.net.Socket	socket()
java.util.Set<java.net.SocketOption<?>>	supportedOptions()
int	write(java.nio.ByteBuffer applicationBuffer) Writes a sequence of bytes to this channel from the given buffer.
long	write(java.nio.ByteBuffer[] applicationByteBuffers, int offset, int length) Writes a sequence of bytes to this channel from a subsequence of the given buffers.

Methods inherited from class java.nio.channels.SocketChannel

open, open, read, validOps, write

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

Constructor Detail

SSLSocketChannel

public SSLSocketChannel(java.nio.channels.SocketChannel socketChannel,
                javax.net.ssl.SSLEngine sslEngine,
                java.util.concurrent.ExecutorService executorService,
                NioSslLogger log)

Parameters:

socketChannel - The real SocketChannel.

sslEngine - The SSL engine to use for traffic back and forth on the given SocketChannel.

executorService - Used to execute long running, blocking SSL operations such as certificate validation with a CA (NEED_TASK)

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

Throws:

java.io.IOException

Method Detail

getWrappedSocketChannel

public java.nio.channels.SocketChannel getWrappedSocketChannel()

read

public int read(java.nio.ByteBuffer applicationBuffer)
         throws java.io.IOException,
                java.lang.IllegalArgumentException

Reads a sequence of bytes from this channel into the given buffer.

An attempt is made to read up to r bytes from the channel, where r is the number of bytes remaining in the buffer, that is, dst.remaining(), at the moment this method is invoked.

Suppose that a byte sequence of length n is read, where 0 <= n <= r. This byte sequence will be transferred into the buffer so that the first byte in the sequence is at index p and the last byte is at index p + n - 1, where p is the buffer's position at the moment this method is invoked. Upon return the buffer's position will be equal to p + n; its limit will not have changed.

A read operation might not fill the buffer, and in fact it might not read any bytes at all. Whether or not it does so depends upon the nature and state of the channel. A socket channel in non-blocking mode, for example, cannot read any more bytes than are immediately available from the socket's input buffer; similarly, a file channel cannot read any more bytes than remain in the file. It is guaranteed, however, that if a channel is in blocking mode and there is at least one byte remaining in the buffer then this method will block until at least one byte is read.This method may be invoked at any time. If another thread has already initiated a read operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Specified by:

read in interface java.nio.channels.ReadableByteChannel

Specified by:

read in class java.nio.channels.SocketChannel

Parameters:

applicationBuffer - 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.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

java.lang.IllegalArgumentException - If the given applicationBuffer capacity (Buffer.capacity() is less then the application buffer size of the SSLEngine session application buffer size (SSLSession.getApplicationBufferSize() this channel was constructed was.

write

public int write(java.nio.ByteBuffer applicationBuffer)
          throws java.io.IOException,
                 java.lang.IllegalArgumentException

Writes a sequence of bytes to this channel from the given buffer.

An attempt is made to write up to r bytes to the channel, where r is the number of bytes remaining in the buffer, that is, src.remaining(), at the moment this method is invoked.

Suppose that a byte sequence of length n is written, where 0 <= n <= r. This byte sequence will be transferred from the buffer starting at index p, where p is the buffer's position at the moment this method is invoked; the index of the last byte written will be p + n - 1. Upon return the buffer's position will be equal to p + n; its limit will not have changed.

Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer.

This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Specified by:

write in interface java.nio.channels.WritableByteChannel

Specified by:

write in class java.nio.channels.SocketChannel

Parameters:

applicationBuffer - The buffer from which bytes are to be retrieved

Returns:

The number of bytes written, possibly zero

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

java.lang.IllegalArgumentException - If the given applicationBuffer capacity (Buffer.capacity() is less then the application buffer size of the SSLEngine session application buffer size (SSLSession.getApplicationBufferSize() this channel was constructed was.

read

public long read(java.nio.ByteBuffer[] applicationByteBuffers,
        int offset,
        int length)
          throws java.io.IOException,
                 java.lang.IllegalArgumentException

Reads a sequence of bytes from this channel into a subsequence of the given buffers.

An invocation of this method attempts to read up to r bytes from this channel, where r is the total number of bytes remaining the specified subsequence of the given buffer array, that is,

 dsts[offset].remaining()
   + dsts[offset+1].remaining()
   + ... + dsts[offset+length-1].remaining()
 
 

at the moment that this method is invoked.

Suppose that a byte sequence of length n is read, where 0 <= n <= r. Up to the first dsts[offset].remaining() bytes of this sequence are transferred into buffer dsts[offset], up to the next dsts[offset+1].remaining() bytes are transferred into buffer dsts[offset+1], and so forth, until the entire byte sequence is transferred into the given buffers. As many bytes as possible are transferred into each buffer, hence the final position of each updated buffer, except the last updated buffer, is guaranteed to be equal to that buffer's limit.

This method may be invoked at any time. If another thread has already initiated a read operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Specified by:

read in interface java.nio.channels.ScatteringByteChannel

Specified by:

read in class java.nio.channels.SocketChannel

Parameters:

applicationByteBuffers - The buffers into which bytes are to be transferred

offset - The offset within the buffer array of the first buffer into which bytes are to be transferred; must be non-negative and no larger than dsts.length

length - The maximum number of buffers to be accessed; must be non-negative and no larger than dsts.length - offset

Returns:

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

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

java.lang.IllegalArgumentException - If one of the given applicationBuffers capacity (Buffer.capacity() is less then the application buffer size of the SSLEngine session application buffer size (SSLSession.getApplicationBufferSize() this channel was constructed was.

write

public long write(java.nio.ByteBuffer[] applicationByteBuffers,
         int offset,
         int length)
           throws java.io.IOException,
                  java.lang.IllegalArgumentException

Writes a sequence of bytes to this channel from a subsequence of the given buffers.

An attempt is made to write up to r bytes to this channel, where r is the total number of bytes remaining in the specified subsequence of the given buffer array, that is,

 srcs[offset].remaining()
   + srcs[offset+1].remaining()
   + ... + srcs[offset+length-1].remaining()
 
 

at the moment that this method is invoked.

Suppose that a byte sequence of length n is written, where 0 <= n <= r. Up to the first srcs[offset].remaining() bytes of this sequence are written from buffer srcs[offset], up to the next srcs[offset+1].remaining() bytes are written from buffer srcs[offset+1], and so forth, until the entire byte sequence is written. As many bytes as possible are written from each buffer, hence the final position of each updated buffer, except the last updated buffer, is guaranteed to be equal to that buffer's limit.

Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer.

This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Specified by:

write in interface java.nio.channels.GatheringByteChannel

Specified by:

write in class java.nio.channels.SocketChannel

Parameters:

applicationByteBuffers - The buffers from which bytes are to be retrieved

offset - offset - The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length

length - The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset

Returns:

The number of bytes written, possibly zero

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

java.lang.IllegalArgumentException - If one of the given applicationBuffers capacity (Buffer.capacity() is less then the application buffer size of the SSLEngine session application buffer size (SSLSession.getApplicationBufferSize() this channel was constructed was.

socket

public java.net.Socket socket()

Specified by:

socket in class java.nio.channels.SocketChannel

isConnected

public boolean isConnected()

Specified by:

isConnected in class java.nio.channels.SocketChannel

isConnectionPending

public boolean isConnectionPending()

Specified by:

isConnectionPending in class java.nio.channels.SocketChannel

connect

public boolean connect(java.net.SocketAddress socketAddress)
                throws java.io.IOException

Specified by:

connect in class java.nio.channels.SocketChannel

Throws:

java.io.IOException

finishConnect

public boolean finishConnect()
                      throws java.io.IOException

Specified by:

finishConnect in class java.nio.channels.SocketChannel

Throws:

java.io.IOException

bind

public java.nio.channels.SocketChannel bind(java.net.SocketAddress local)
                                     throws java.io.IOException

Specified by:

bind in interface java.nio.channels.NetworkChannel

Overrides:

bind in class java.nio.channels.SocketChannel

Throws:

java.io.IOException

getLocalAddress

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

Throws:

java.io.IOException

setOption

public <T> java.nio.channels.SocketChannel 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.SocketChannel

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()

shutdownInput

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

Specified by:

shutdownInput in class java.nio.channels.SocketChannel

Throws:

java.io.IOException

shutdownOutput

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

Specified by:

shutdownOutput in class java.nio.channels.SocketChannel

Throws:

java.io.IOException

getRemoteAddress

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

Specified by:

getRemoteAddress in class java.nio.channels.SocketChannel

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

implCloseSelectableChannel

protected void implCloseSelectableChannel()
                                   throws java.io.IOException

Specified by:

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

Throws:

java.io.IOException