com.sleepycat.je.rep.utilint.net

Class SSLDataChannel

java.lang.Object

com.sleepycat.je.rep.utilint.net.AbstractDataChannel

com.sleepycat.je.rep.utilint.net.SSLDataChannel

All Implemented Interfaces:

DataChannel, Closeable, AutoCloseable, ByteChannel, Channel, GatheringByteChannel, ReadableByteChannel, ScatteringByteChannel, WritableByteChannel

public class SSLDataChannel
extends AbstractDataChannel

SSLDataChannel provides SSL-based communications on top of a SocketChannel. We attempt to maintain a degree of compatibility with SocketChannel in terms of request completion semantics. In particular, If in blocking mode: read() will return at least one byte if the buffer has room write() will write the entire buffer If in non-blocking mode: read() and write are not guaranteed to consume or produce anything.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sleepycat.je.rep.net.DataChannel

DataChannel.CloseAsyncStatus, DataChannel.FlushStatus

Field Summary

Fields inherited from class com.sleepycat.je.rep.utilint.net.AbstractDataChannel

configuredBlocking, socketChannel

Constructor Summary

Constructors

Constructor and Description
SSLDataChannel(SocketChannel socketChannel, SSLEngine sslEngine, String targetHost, HostnameVerifier hostVerifier, SSLAuthenticator authenticator, InstanceLogger logger) Construct an SSLDataChannel given a SocketChannel and an SSLEngine

Method Summary

Modifier and Type	Method and Description
void	close() Closes this channel, which should be a blocking channel.
DataChannel.CloseAsyncStatus	closeAsync() Closes this channel, which should be a non-blocking channel.
void	closeForcefully() Closes this channel forcefully.
void	configureBlocking(boolean block) Configures the channel to be blocking.
DataChannel.FlushStatus	flush() Attempt to flush any pending writes to the underlying socket buffer.
boolean	isOpen()
boolean	isSecure() Is the channel encrypted?
boolean	isTrustCapable() Is the channel capable of determining peer trust? In this case, we are capable only if the application has configured an SSL authenticator
boolean	isTrusted() Is the channel peer trusted? A channel is trusted if the peer should be treated as authenticated.
int	read(ByteBuffer toFill) Read data into the toFill data buffer.
long	read(ByteBuffer[] toFill)
long	read(ByteBuffer[] toFill, int offset, int length) Reads a sequence of bytes from this channel into a subsequence of the given buffers.
int	write(ByteBuffer toSend)
long	write(ByteBuffer[] toSend)
long	write(ByteBuffer[] toSend, int offset, int length) Writes a sequence of bytes to this channel from a subsequence of the given buffers.

Methods inherited from class com.sleepycat.je.rep.utilint.net.AbstractDataChannel

ensureCloseAsyncForNonBlocking, ensureCloseForBlocking, getRemoteAddress, getSocketChannel, isBlocking, isConnected, socket

Methods inherited from class java.lang.Object

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

Constructor Detail

SSLDataChannel

public SSLDataChannel(SocketChannel socketChannel,
                      SSLEngine sslEngine,
                      String targetHost,
                      HostnameVerifier hostVerifier,
                      SSLAuthenticator authenticator,
                      InstanceLogger logger)

Construct an SSLDataChannel given a SocketChannel and an SSLEngine

Parameters:

socketChannel - a SocketChannel over which SSL communcation will occur. This should generally be connected, but that is not absolutely required until the first read/write operation.

sslEngine - an SSLEngine instance that will control the SSL interaction with the peer.

Method Detail

configureBlocking

public void configureBlocking(boolean block)
                       throws IOException

Configures the channel to be blocking.

Specified by:

configureBlocking in interface DataChannel

Overrides:

configureBlocking in class AbstractDataChannel

Throws:

IOException

isSecure

public boolean isSecure()

Is the channel encrypted?

Returns:

true if the channel is encrypted

isTrustCapable

public boolean isTrustCapable()

Is the channel capable of determining peer trust? In this case, we are capable only if the application has configured an SSL authenticator

Returns:

true if this data channel is capable of determining trust

isTrusted

public boolean isTrusted()

Is the channel peer trusted? A channel is trusted if the peer should be treated as authenticated. The meaning of this is context dependent. The channel will only be trusted if the configured peer authenticator says it should be trusted, so the creator of this SSLDataChannel knows what "trusted" means.

Returns:

true if the SSL peer should be trusted

read

public int read(ByteBuffer toFill)
         throws IOException,
                SSLException

Read data into the toFill data buffer.

Parameters:

toFill - the data buffer into which data will be read. This buffer is expected to be ready for a put. It need not be empty.

Returns:

the count of bytes read into toFill.

Throws:

IOException

SSLException

read

public long read(ByteBuffer[] toFill)
          throws IOException,
                 SSLException

Throws:

IOException

SSLException

read

public long read(ByteBuffer[] toFill,
                 int offset,
                 int length)
          throws IOException,
                 SSLException

Description copied from interface: DataChannel

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

The method throws ClosedChannelException after channel is closed. The channel is closed if any of the DataChannel.close(), DataChannel.closeForcefully() or DataChannel.closeAsync() was called (regardless of the return value or exception thrown). The method may throw AsynchronousCloseException when another thread is closing the channel concurrently.

The method should not block any of the close methods.

Throws:

IOException

SSLException

write

public int write(ByteBuffer toSend)
          throws IOException,
                 SSLException

Throws:

IOException

SSLException

write

public long write(ByteBuffer[] toSend)
           throws IOException,
                  SSLException

Throws:

IOException

SSLException

write

public long write(ByteBuffer[] toSend,
                  int offset,
                  int length)
           throws IOException,
                  SSLException

Description copied from interface: DataChannel

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

The behavior w.r.t the DataChannel.flush() method:

• If the channel is configured blocking, the method should flush the written data before it normally exits.
• If the channel is configured non-blocking, the write method does not guarantee the written data is flushed. The caller should call the flush method, or close the socket with close or closeAsync, if it needs to make sure that the data has been completely written.

The behavior w.r.t the channel-close methods:

• The method throws ClosedChannelException after channel is closed. The channel is closed if any of the DataChannel.close(), DataChannel.closeForcefully() or DataChannel.closeAsync() was called and exited (regardless of the return value or exception thrown). The method may throw AsynchronousCloseException when another thread is closing the channel concurrently.
• The method should not block any of the close methods.

Throws:

IOException

SSLException

flush

public DataChannel.FlushStatus flush()
                              throws IOException

Attempt to flush any pending writes to the underlying socket buffer. The caller should ensure that it is the only thread accessing the DataChannel in order that the return value be meaningful.

Returns:

flush status

Throws:

IOException

close

public void close()
           throws IOException,
                  SSLException

Description copied from interface: DataChannel

Closes this channel, which should be a blocking channel.

It is considered a coding error to call this method if the channel is configured as non-blocking: use DataChannel.closeAsync() or DataChannel.closeForcefully() instead. If called for a non-blocking channel, this method closes the channel forcefully and throws IllegalStateException.

The method cleanly closes the channel, blocking if necessary. The method should only be blocked for its own connection operations (i.e., not by concurrent DataChannel.read(java.nio.ByteBuffer[], int, int),DataChannel.write(java.nio.ByteBuffer[], int, int), DataChannel.flush() methods or lock acquisitions, etc). The method throws IOException if the connection is unresponsive and timed out.

If the method detects a concurrent DataChannel.read(java.nio.ByteBuffer[], int, int), DataChannel.write(java.nio.ByteBuffer[], int, int) or DataChannel.flush() method being called, the method throws IOException.

Implementations of this method should flush written data before closing the channel.

If an error occurs, the method attempts to forcefully close the channel, before throwing the exception. Only the first encountered exception is thrown.

The channel is closed (i.e., isOpen returns false) after this method returns, even if an exception is thrown. The DataChannel.read(java.nio.ByteBuffer[], int, int), DataChannel.write(java.nio.ByteBuffer[], int, int) and DataChannel.flush() methods will throw ClosedChannelException when the channel is closed. These methods may throw AsynchronousCloseException if called concurrently with this method.

Throws:

IOException - if an error occurs

SSLException

closeAsync

public DataChannel.CloseAsyncStatus closeAsync()
                                        throws IOException

Description copied from interface: DataChannel

Closes this channel, which should be a non-blocking channel.

It is considered a coding error to call this method if the channel is configured as blocking: use DataChannel.close() or DataChannel.closeForcefully() instead. If called for a blocking channel, this method closes the channel forcefully and throws IllegalStateException.

The method cleanly closes the channel in a non-blocking manner. The channel is closed (i.e., isOpen returns false) once the method is called (regardless of return value or exception thrown). The caller, however, should keep calling this method until it returns true or throws exception. The channel is cleanly closed if the method returns true or forcefully closed if the method throws exception.

Implementations of this method should flush written data before closing the channel.

If the method detects a concurrent DataChannel.read(java.nio.ByteBuffer[], int, int), DataChannel.write(java.nio.ByteBuffer[], int, int) or DataChannel.flush() method being called, the method throws IOException.

If an error occurs, the method attempts to forcefully close the channel, before throwing the exception. Only the first encountered exception is thrown.

The DataChannel.read(java.nio.ByteBuffer[], int, int), DataChannel.write(java.nio.ByteBuffer[], int, int) and DataChannel.flush() methods will throw ClosedChannelException when the channel is closed. These methods may throw AsynchronousCloseException if called concurrently with this method.

Returns:

true if the channel is cleanly closed

Throws:

IOException - if there is an error

closeForcefully

public void closeForcefully()
                     throws IOException

Description copied from interface: DataChannel

Closes this channel forcefully.

The method returns immediately, i.e., it should not be blocked by concurrent DataChannel.read(java.nio.ByteBuffer[], int, int), DataChannel.write(java.nio.ByteBuffer[], int, int) or DataChannel.flush() methods, nor should it be blocked by socket operations.

The method does not guarantee to flush written data before closing the channel, nor does it guarantee to do any procedure required for a clean close.

The channel is closed (i.e., isOpen returns false) after this method returns. The DataChannel.read(java.nio.ByteBuffer[], int, int), DataChannel.write(java.nio.ByteBuffer[], int, int) and DataChannel.flush() methods will throw ClosedChannelException when the channel is closed. These methods may throw AsynchronousCloseException if called concurrently with this method.

Throws:

IOException - if an error occurs

isOpen

public boolean isOpen()