com.mysql.cj.protocol.x

Class CompressionSplittedInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.mysql.cj.protocol.x.CompressionSplittedInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class CompressionSplittedInputStream
extends java.io.FilterInputStream

An InputStream wrapper that analyzes X Protocol frames and, if compressed, routes them to a secondary compressor-able InputStream that also knows how to rebuild uncompressed X Protocol frames from compressed ones.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	closed
private java.io.InputStream	compressorIn
private CompressorStreamsFactory	compressorIoStreamsFactory
private byte[]	frameHeader
private int	frameHeaderConsumed
private int	framePayloadConsumed
private int	framePayloadLength
private byte[]	singleByte
private XMessageHeader	xMessageHeader

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
CompressionSplittedInputStream(java.io.InputStream in, CompressorStreamsFactory streamsFactory)

Method Summary

Modifier and Type	Method and Description
int	available() Same as InputStream.available(), except that the exact number of bytes that can be read from the underlying InputStream may not be accurate until it is known if the next bytes contain compressed data or not.
void	close() Closes this stream.
private void	ensureOpen() Ensures that this InputStream wasn't closed yet.
private boolean	isCompressedDataAvailable() Checks if there is data available in the compressed InputStream to be consumed.
private boolean	isCompressedDataReadComplete() Checks if all data from the compressed InputStream was fully consumed.
private boolean	isCompressedFrame() Checks if current X Protocol frame is compressed.
private boolean	isDataAvailable() Checks if there is data available to be consumed.
(package private) boolean	isFrameHeaderFullyConsumed() Checks if the X Protocol frame header was fully consumed.
private MysqlxConnection.Compression	parseCompressedMessage() Parses the next X Protocol message as a compressed one.
private void	peekNextFrame() Checks the header of the next X Protocol frame and, depending on its type, sets up this class to read from an alternative compressor able underlying InputStream.
int	read() Forwards the read to read(byte[], int, int).
int	read(byte[] b) Forwards the read to read(byte[], int, int).
int	read(byte[] b, int off, int len) Reads bytes from the underlying InputStream either from the one that gets data directly from the original source InputStream or from a compressor able InputStream, if reading of a compressed X Protocol frame is in progress.
int	readFully(byte[] b) Reads the number of bytes required to fill the given buffer from the underlying InputStream, blocking if needed.
private int	readFully(byte[] b, int off, int len) Reads the exact number of requested bytes from the underlying InputStream, blocking if needed.
private int	readFully(java.io.InputStream inStream, byte[] b, int off, int len) Reads the exact number of requested bytes from the given InputStream, blocking if needed.

Methods inherited from class java.io.FilterInputStream

mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

Field Detail

compressorIoStreamsFactory

private CompressorStreamsFactory compressorIoStreamsFactory

frameHeader

private byte[] frameHeader

frameHeaderConsumed

private int frameHeaderConsumed

framePayloadLength

private int framePayloadLength

framePayloadConsumed

private int framePayloadConsumed

xMessageHeader

private XMessageHeader xMessageHeader

compressorIn

private java.io.InputStream compressorIn

singleByte

private byte[] singleByte

closed

private boolean closed

Constructor Detail

CompressionSplittedInputStream

public CompressionSplittedInputStream(java.io.InputStream in,
                                      CompressorStreamsFactory streamsFactory)

Method Detail

available

public int available()
              throws java.io.IOException

Same as InputStream.available(), except that the exact number of bytes that can be read from the underlying InputStream may not be accurate until it is known if the next bytes contain compressed data or not.

Overrides:

available in class java.io.FilterInputStream

Returns:

an approximate number of available bytes to read.

Throws:

java.io.IOException

See Also:

FilterInputStream.available()

close

public void close()
           throws java.io.IOException

Closes this stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterInputStream

Throws:

java.io.IOException

See Also:

FilterInputStream.close()

read

public int read()
         throws java.io.IOException

Forwards the read to read(byte[], int, int).

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

See Also:

FilterInputStream.read()

read

public int read(byte[] b)
         throws java.io.IOException

Forwards the read to read(byte[], int, int).

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

See Also:

FilterInputStream.read(byte[])

read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

Reads bytes from the underlying InputStream either from the one that gets data directly from the original source InputStream or from a compressor able InputStream, if reading of a compressed X Protocol frame is in progress.

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

See Also:

FilterInputStream.read(byte[], int, int)

peekNextFrame

private void peekNextFrame()
                    throws java.io.IOException

Checks the header of the next X Protocol frame and, depending on its type, sets up this class to read from an alternative compressor able underlying InputStream.

Throws:

java.io.IOException - if any of the underlying I/O operations fail.

isCompressedFrame

private boolean isCompressedFrame()

Checks if current X Protocol frame is compressed.

Returns:

true if the type of current frame is Mysqlx.ServerMessages.Type.COMPRESSION, false otherwise.

parseCompressedMessage

private MysqlxConnection.Compression parseCompressedMessage()

Parses the next X Protocol message as a compressed one.

Returns:

The Protobuf MysqlxConnection.Compression message.

isDataAvailable

private boolean isDataAvailable()
                         throws java.io.IOException

Checks if there is data available to be consumed.

Returns:

true if this frame's bytes weren't all consumed yet, false otherwise.

Throws:

java.io.IOException - if any of the underlying I/O operations fail.

isCompressedDataAvailable

private boolean isCompressedDataAvailable()
                                   throws java.io.IOException

Checks if there is data available in the compressed InputStream to be consumed.

Returns:

true if there is compressed data available, false otherwise.

Throws:

java.io.IOException - if any of the underlying I/O operations fail.

isCompressedDataReadComplete

private boolean isCompressedDataReadComplete()
                                      throws java.io.IOException

Checks if all data from the compressed InputStream was fully consumed.

Returns:

true if all compressed data was consumed, false otherwise.

Throws:

java.io.IOException - if any of the underlying I/O operations fail.

isFrameHeaderFullyConsumed

boolean isFrameHeaderFullyConsumed()

Checks if the X Protocol frame header was fully consumed.

Returns:

true if the frame header was fully consumed, false otherwise.

readFully

public int readFully(byte[] b)
              throws java.io.IOException

Reads the number of bytes required to fill the given buffer from the underlying InputStream, blocking if needed.

Parameters:

b - the buffer into which the data is read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

java.io.IOException - if any of the underlying I/O operations fail.

readFully

private final int readFully(byte[] b,
                            int off,
                            int len)
                     throws java.io.IOException

Reads the exact number of requested bytes from the underlying InputStream, blocking if needed.

Parameters:

b - the buffer into which the data is read.

off - the start offset in the destination array b

len - the maximum number of bytes read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

java.io.IOException - if any of the underlying I/O operations fail.

readFully

private final int readFully(java.io.InputStream inStream,
                            byte[] b,
                            int off,
                            int len)
                     throws java.io.IOException

Reads the exact number of requested bytes from the given InputStream, blocking if needed.

Parameters:

inStream - input stream to read from

b - the buffer into which the data is read.

off - the start offset in the destination array b

len - the maximum number of bytes read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

java.io.IOException - if any of the underlying I/O operations fail.

ensureOpen

private void ensureOpen()
                 throws java.io.IOException

Ensures that this InputStream wasn't closed yet.

Throws:

java.io.IOException - if this InputStream was closed.