com.mysql.cj.protocol

Class TlsAsynchronousSocketChannel

java.lang.Object

java.nio.channels.AsynchronousSocketChannel

com.mysql.cj.protocol.TlsAsynchronousSocketChannel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.AsynchronousByteChannel, java.nio.channels.AsynchronousChannel, java.nio.channels.Channel, java.nio.channels.CompletionHandler<java.lang.Integer,java.lang.Void>, java.nio.channels.NetworkChannel

public class TlsAsynchronousSocketChannel
extends java.nio.channels.AsynchronousSocketChannel
implements java.nio.channels.CompletionHandler<java.lang.Integer,java.lang.Void>

FilterInputStream-esque byte channel that decrypts incoming packets. We proxy calls to the read method from the caller. We replace the provided completion handler with our own handler that decrypts the incoming message and an then delegates to the original handler.

Note: This implementation does not support attachments for reads. They are not used in AsyncMessageReader which this class is in direct support of.

Constructor Summary

Constructors

Constructor and Description
TlsAsynchronousSocketChannel(java.nio.channels.AsynchronousSocketChannel in, javax.net.ssl.SSLEngine sslEngine) Create a new decrypting input stream.

Method Summary

Modifier and Type	Method and Description
java.nio.channels.AsynchronousSocketChannel	bind(java.net.SocketAddress local)
void	close()
void	completed(java.lang.Integer result, java.lang.Void attachment) Completion handler for a read.
java.util.concurrent.Future<java.lang.Void>	connect(java.net.SocketAddress remote)
<A> void	connect(java.net.SocketAddress remote, A attachment, java.nio.channels.CompletionHandler<java.lang.Void,? super A> hdlr)
void	failed(java.lang.Throwable exc, java.lang.Void attachment)
java.net.SocketAddress	getLocalAddress()
<T> T	getOption(java.net.SocketOption<T> name)
java.net.SocketAddress	getRemoteAddress()
boolean	isOpen()
java.util.concurrent.Future<java.lang.Integer>	read(java.nio.ByteBuffer dest) Unused.
<A> void	read(java.nio.ByteBuffer[] dsts, int offset, int length, long timeout, java.util.concurrent.TimeUnit unit, A attachment, java.nio.channels.CompletionHandler<java.lang.Long,? super A> hdlr)
<A> void	read(java.nio.ByteBuffer dest, long timeout, java.util.concurrent.TimeUnit unit, A attachment, java.nio.channels.CompletionHandler<java.lang.Integer,? super A> hdlr) Main entry point from caller.
<T> java.nio.channels.AsynchronousSocketChannel	setOption(java.net.SocketOption<T> name, T value)
java.nio.channels.AsynchronousSocketChannel	shutdownInput()
java.nio.channels.AsynchronousSocketChannel	shutdownOutput()
java.util.Set<java.net.SocketOption<?>>	supportedOptions()
java.util.concurrent.Future<java.lang.Integer>	write(java.nio.ByteBuffer src) Unused.
<A> void	write(java.nio.ByteBuffer[] srcs, int offset, int length, long timeout, java.util.concurrent.TimeUnit unit, A attachment, java.nio.channels.CompletionHandler<java.lang.Long,? super A> hdlr) Handle a request to write an array of buffers to the channel.
<A> void	write(java.nio.ByteBuffer src, long timeout, java.util.concurrent.TimeUnit unit, A attachment, java.nio.channels.CompletionHandler<java.lang.Integer,? super A> hdlr)

Methods inherited from class java.nio.channels.AsynchronousSocketChannel

open, open, provider, read, write

Methods inherited from class java.lang.Object

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

Constructor Detail

TlsAsynchronousSocketChannel

public TlsAsynchronousSocketChannel(java.nio.channels.AsynchronousSocketChannel in,
                                    javax.net.ssl.SSLEngine sslEngine)

Create a new decrypting input stream.

Parameters:

in - The underlying inputstream to read encrypted data from.

sslEngine - A configured SSLEngine which has already completed the handshake.

Method Detail

completed

public void completed(java.lang.Integer result,
                      java.lang.Void attachment)

Completion handler for a read. Prepare the buffer for decryption and continue with decryptAndDispatch().

Specified by:

completed in interface java.nio.channels.CompletionHandler<java.lang.Integer,java.lang.Void>

Parameters:

result - number of processed bytes

attachment - Void

failed

public void failed(java.lang.Throwable exc,
                   java.lang.Void attachment)

Specified by:

failed in interface java.nio.channels.CompletionHandler<java.lang.Integer,java.lang.Void>

read

public <A> void read(java.nio.ByteBuffer dest,
                     long timeout,
                     java.util.concurrent.TimeUnit unit,
                     A attachment,
                     java.nio.channels.CompletionHandler<java.lang.Integer,? super A> hdlr)

Main entry point from caller.

Specified by:

read in class java.nio.channels.AsynchronousSocketChannel

read

public <A> void read(java.nio.ByteBuffer[] dsts,
                     int offset,
                     int length,
                     long timeout,
                     java.util.concurrent.TimeUnit unit,
                     A attachment,
                     java.nio.channels.CompletionHandler<java.lang.Long,? super A> hdlr)

Specified by:

read in class java.nio.channels.AsynchronousSocketChannel

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.nio.channels.AsynchronousChannel

Specified by:

close in interface java.nio.channels.Channel

Throws:

java.io.IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface java.nio.channels.Channel

read

public java.util.concurrent.Future<java.lang.Integer> read(java.nio.ByteBuffer dest)

Unused. Should not be called.

Specified by:

read in interface java.nio.channels.AsynchronousByteChannel

Specified by:

read in class java.nio.channels.AsynchronousSocketChannel

write

public java.util.concurrent.Future<java.lang.Integer> write(java.nio.ByteBuffer src)

Unused. Should not be called.

Specified by:

write in interface java.nio.channels.AsynchronousByteChannel

Specified by:

write in class java.nio.channels.AsynchronousSocketChannel

write

public <A> void write(java.nio.ByteBuffer[] srcs,
                      int offset,
                      int length,
                      long timeout,
                      java.util.concurrent.TimeUnit unit,
                      A attachment,
                      java.nio.channels.CompletionHandler<java.lang.Long,? super A> hdlr)

Handle a request to write an array of buffers to the channel. We build one or more encrypted packets and write them to the server.

Specified by:

write in class java.nio.channels.AsynchronousSocketChannel

Parameters:

srcs - source buffers to write

offset - offset into buffer array

length - number of buffers

timeout - ignored

unit - ignored

attachment - ignored

hdlr - completion handler to be called when all buffers have been written

write

public <A> void write(java.nio.ByteBuffer src,
                      long timeout,
                      java.util.concurrent.TimeUnit unit,
                      A attachment,
                      java.nio.channels.CompletionHandler<java.lang.Integer,? super A> hdlr)

Specified by:

write in class java.nio.channels.AsynchronousSocketChannel

getOption

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

Specified by:

getOption in interface java.nio.channels.NetworkChannel

Throws:

java.io.IOException

supportedOptions

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

Specified by:

supportedOptions in interface java.nio.channels.NetworkChannel

bind

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

Throws:

java.io.IOException

setOption

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

Throws:

java.io.IOException

shutdownInput

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

Specified by:

shutdownInput in class java.nio.channels.AsynchronousSocketChannel

Throws:

java.io.IOException

shutdownOutput

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

Specified by:

shutdownOutput in class java.nio.channels.AsynchronousSocketChannel

Throws:

java.io.IOException

getRemoteAddress

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

Specified by:

getRemoteAddress in class java.nio.channels.AsynchronousSocketChannel

Throws:

java.io.IOException

connect

public <A> void connect(java.net.SocketAddress remote,
                        A attachment,
                        java.nio.channels.CompletionHandler<java.lang.Void,? super A> hdlr)

Specified by:

connect in class java.nio.channels.AsynchronousSocketChannel

connect

public java.util.concurrent.Future<java.lang.Void> connect(java.net.SocketAddress remote)

Specified by:

connect in class java.nio.channels.AsynchronousSocketChannel

getLocalAddress

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

Specified by:

getLocalAddress in interface java.nio.channels.NetworkChannel

Specified by:

getLocalAddress in class java.nio.channels.AsynchronousSocketChannel

Throws:

java.io.IOException