com.ibm.cloud.objectstorage.auth

Class AwsChunkedEncodingInputStream

java.lang.Object

java.io.InputStream

com.ibm.cloud.objectstorage.internal.SdkInputStream

com.ibm.cloud.objectstorage.auth.AwsChunkedEncodingInputStream

All Implemented Interfaces:

MetricAware, Releasable, Closeable, AutoCloseable

public final class AwsChunkedEncodingInputStream
extends SdkInputStream

A wrapper class of InputStream that implements chunked-encoding.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_ENCODING

Constructor Summary

Constructors

Constructor and Description
AwsChunkedEncodingInputStream(InputStream in, byte[] kSigning, String datetime, String keyPath, String headerSignature, AWS4Signer aws4Signer)
AwsChunkedEncodingInputStream(InputStream in, int maxBufferSize, byte[] kSigning, String datetime, String keyPath, String headerSignature, AWS4Signer aws4Signer) A wrapper of InputStream that implements pseudo-chunked-encoding.

Method Summary

Modifier and Type	Method and Description
static long	calculateStreamContentLength(long originalLength)
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 com.ibm.cloud.objectstorage.internal.SdkInputStream

abort, abortIfNeeded, isMetricActivated, 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

Field Detail

DEFAULT_ENCODING

protected static final String DEFAULT_ENCODING

See Also:

Constant Field Values

Constructor Detail

AwsChunkedEncodingInputStream

public AwsChunkedEncodingInputStream(InputStream in,
                                     byte[] kSigning,
                                     String datetime,
                                     String keyPath,
                                     String headerSignature,
                                     AWS4Signer aws4Signer)

AwsChunkedEncodingInputStream

public AwsChunkedEncodingInputStream(InputStream in,
                                     int maxBufferSize,
                                     byte[] kSigning,
                                     String datetime,
                                     String keyPath,
                                     String headerSignature,
                                     AWS4Signer aws4Signer)

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.

Parameters:

in - The original InputStream.

maxBufferSize - Maximum number of bytes buffered by this class.

kSigning - Signing key.

datetime - Datetime, as used in SigV4.

keyPath - Keypath/Scope, as used in SigV4.

headerSignature - The signature of the signed headers. This will be used for calculating the signature of the first chunk.

aws4Signer - The AWS4Signer used for hashing and signing.

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)

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