com.ibm.cloud.objectstorage.util

Class LengthCheckInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.ibm.cloud.objectstorage.internal.SdkFilterInputStream

com.ibm.cloud.objectstorage.util.LengthCheckInputStream

All Implemented Interfaces:

MetricAware, Releasable, Closeable, AutoCloseable

@NotThreadSafe
public class LengthCheckInputStream
extends SdkFilterInputStream

Used to perform length check to ensure the number of bytes read from the underlying input stream is the same as the expected total.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	EXCLUDE_SKIPPED_BYTES
static boolean	INCLUDE_SKIPPED_BYTES

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
LengthCheckInputStream(InputStream in, long expectedLength, boolean includeSkipped) Constructs an input stream that performs length check to ensure the number of bytes read from the underlying input stream is the same as the expected total.

Method Summary

Modifier and Type	Method and Description
void	mark(int readlimit)
int	read()
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class com.ibm.cloud.objectstorage.internal.SdkFilterInputStream

abort, abortIfNeeded, available, close, getDelegateStream, isAborted, isMetricActivated, markSupported, release

Methods inherited from class java.io.FilterInputStream

read

Methods inherited from class java.lang.Object

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

Field Detail

INCLUDE_SKIPPED_BYTES

public static final boolean INCLUDE_SKIPPED_BYTES

See Also:

Constant Field Values

EXCLUDE_SKIPPED_BYTES

public static final boolean EXCLUDE_SKIPPED_BYTES

See Also:

Constant Field Values

Constructor Detail

LengthCheckInputStream

public LengthCheckInputStream(InputStream in,
                              long expectedLength,
                              boolean includeSkipped)

Constructs an input stream that performs length check to ensure the number of bytes read from the underlying input stream is the same as the expected total.

Parameters:

in - the underlying input stream

expectedLength - the total length of the data in bytes expected to be read from the underlying input stream; must be non-negative.

includeSkipped - true if bytes skipped are to be considered as part of the data length; false otherwise. Typically, this parameter should be set to false for uploading data to AWS, but set to true for receiving data from AWS.

Method Detail

read

public int read()
         throws IOException

Overrides:

read in class SdkFilterInputStream

Throws:

SdkClientException - if the data length read has exceeded the expected total, or if the total data length is not the same as the expected total.

IOException

read

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

Overrides:

read in class SdkFilterInputStream

Throws:

SdkClientException - if the data length read has exceeded the expected total, or if the total data length is not the same as the expected total.

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class SdkFilterInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class SdkFilterInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class SdkFilterInputStream

Throws:

SdkClientException - if LengthCheckInputStream.includeSkipped is true and the data length skipped has exceeded the expected total.

IOException