software.amazon.awssdk.core.internal.io

Class AwsChunkedEncodingInputStream

java.lang.Object

java.io.InputStream

software.amazon.awssdk.core.io.SdkInputStream

software.amazon.awssdk.core.internal.io.AwsChunkedEncodingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable

Direct Known Subclasses:

AwsUnsignedChunkedEncodingInputStream

public abstract class AwsChunkedEncodingInputStream
extends SdkInputStream

A wrapper of InputStream that implements pseudo-chunked-encoding. Each chunk will be buffered for the calculation of the chunk signature which is added at the head of each chunk.
The default chunk size cannot be customized, since we need to calculate the expected encoded stream length before reading the wrapped stream.
This class will use the mark() & reset() of the wrapped InputStream if they are supported, otherwise it will create a buffer for bytes read from the wrapped stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AwsChunkedEncodingInputStream.Builder<T extends AwsChunkedEncodingInputStream.Builder>

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	calculatedChecksum
protected String	checksumHeaderForTrailer
protected static String	CRLF
static int	DEFAULT_CHUNK_SIZE
protected static byte[]	FINAL_CHUNK
protected static String	HEADER_COLON_SEPARATOR
protected boolean	isTrailingTerminated
protected static int	SKIP_BUFFER_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AwsChunkedEncodingInputStream(InputStream in, SdkChecksum sdkChecksum, String checksumHeaderForTrailer, AwsChunkedEncodingConfig config) Creates a chunked encoding input stream initialized with the originating stream.

Method Summary

Modifier and Type	Method and Description
protected abstract byte[]	createChecksumChunkHeader()
protected abstract byte[]	createChunk(byte[] chunkData) Creates chunk for the given buffer.
protected abstract byte[]	createFinalChunk(byte[] finalChunk) The final chunk.
protected InputStream	getWrappedInputStream() Returns the underlying input stream, if any, from the subclass; or null if there is no underlying input stream.
void	mark(int readlimit) The readlimit parameter is ignored.
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset() Reset the stream, either by resetting the wrapped stream or using the buffer created by this class.
long	skip(long n)

Methods inherited from class software.amazon.awssdk.core.io.SdkInputStream

abort, abortIfNeeded, release

Methods inherited from class java.io.InputStream

available, close, read

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.core.internal.io.Releasable

release

Field Detail

DEFAULT_CHUNK_SIZE

public static final int DEFAULT_CHUNK_SIZE

See Also:

Constant Field Values

SKIP_BUFFER_SIZE

protected static final int SKIP_BUFFER_SIZE

See Also:

Constant Field Values

CRLF

protected static final String CRLF

See Also:

Constant Field Values

FINAL_CHUNK

protected static final byte[] FINAL_CHUNK

HEADER_COLON_SEPARATOR

protected static final String HEADER_COLON_SEPARATOR

See Also:

Constant Field Values

calculatedChecksum

protected byte[] calculatedChecksum

checksumHeaderForTrailer

protected final String checksumHeaderForTrailer

isTrailingTerminated

protected boolean isTrailingTerminated

Constructor Detail

AwsChunkedEncodingInputStream

protected AwsChunkedEncodingInputStream(InputStream in,
                                        SdkChecksum sdkChecksum,
                                        String checksumHeaderForTrailer,
                                        AwsChunkedEncodingConfig config)

Creates a chunked encoding input stream initialized with the originating stream. The configuration allows specification of the size of each chunk, as well as the buffer size. Use the same values as when calculating total length of the stream.

Parameters:

in - The original InputStream.

config - The configuration allows the user to customize chunk size and buffer size. See AwsChunkedEncodingConfig for default values.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

See Also:

InputStream.markSupported()

mark

public void mark(int readlimit)

The readlimit parameter is ignored.

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Reset the stream, either by resetting the wrapped stream or using the buffer created by this class.

Overrides:

reset in class InputStream

Throws:

IOException

getWrappedInputStream

protected InputStream getWrappedInputStream()

Description copied from class: SdkInputStream

Returns the underlying input stream, if any, from the subclass; or null if there is no underlying input stream.

Specified by:

getWrappedInputStream in class SdkInputStream

createFinalChunk

protected abstract byte[] createFinalChunk(byte[] finalChunk)

The final chunk.

Parameters:

finalChunk - The last byte which will be often 0 byte.

Returns:

Final chunk that will be appended with CRLF or any required signatures.

createChunk

protected abstract byte[] createChunk(byte[] chunkData)

Creates chunk for the given buffer. The chucks could be appended with Signatures or any additional bytes by Concrete classes.

Parameters:

chunkData - The chunk of original data.

Returns:

Chunked data which will have signature if signed or just data if unsigned.

createChecksumChunkHeader

protected abstract byte[] createChecksumChunkHeader()

Returns:

ChecksumChunkHeader in bytes based on the Header name field.