software.amazon.awssdk.auth.signer.internal.chunkedencoding

Class AwsChunkedEncodingInputStream

java.lang.Object

java.io.InputStream

software.amazon.awssdk.core.io.SdkInputStream

software.amazon.awssdk.auth.signer.internal.chunkedencoding.AwsChunkedEncodingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable

public final class AwsChunkedEncodingInputStream
extends SdkInputStream

A wrapper of InputStream that implements chunked encoding.

Each chunk will be buffered for the calculation of the chunk signature which is added at the head of each chunk. The request signature and the chunk signatures will be assumed to be hex-encoded strings.

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.

Constructor Summary

Constructors

Constructor and Description
AwsChunkedEncodingInputStream(InputStream in, String headerSignature, AwsChunkSigner chunkSigner, AwsChunkedEncodingConfig config) Creates a chunked encoding input stream initialized with the originating stream, an http request seed signature and a signer that can sign a chunk of bytes according to a chosen algorithm.

Method Summary

Modifier and Type	Method and Description
static long	calculateStreamContentLength(long originalLength, int signatureLength, AwsChunkedEncodingConfig config) Calculates the expected total length of signed payload chunked stream.
protected InputStream	getWrappedInputStream()
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

Constructor Detail

AwsChunkedEncodingInputStream

public AwsChunkedEncodingInputStream(InputStream in,
                                     String headerSignature,
                                     AwsChunkSigner chunkSigner,
                                     AwsChunkedEncodingConfig config)

Creates a chunked encoding input stream initialized with the originating stream, an http request seed signature and a signer that can sign a chunk of bytes according to a chosen algorithm. 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 calculateStreamContentLength(long, int, AwsChunkedEncodingConfig).

Parameters:

in - The original InputStream.

headerSignature - The signature of the signed headers of the request. This will be used for calculating the signature of the first chunk. Observe that the format of this parameter should be a hex-encoded string.

chunkSigner - The signer for each chunk of data, implementing the AwsChunkSigner interface.

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

calculateStreamContentLength

public static long calculateStreamContentLength(long originalLength,
                                                int signatureLength,
                                                AwsChunkedEncodingConfig config)

Calculates the expected total length of signed payload chunked stream.

Parameters:

originalLength - The length of the data

signatureLength - The length of a calculated signature, dependent on which AwsChunkSigner is used

config - The chunked encoding config determines the size of the chunks. Use the same values as when initializing the stream AwsChunkedEncodingInputStream(InputStream, String, AwsChunkSigner, AwsChunkedEncodingConfig).

getWrappedInputStream

protected InputStream getWrappedInputStream()

Specified by:

getWrappedInputStream in class SdkInputStream