com.ibm.cloud.objectstorage.internal

Class SdkFilterInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.ibm.cloud.objectstorage.internal.SdkFilterInputStream

All Implemented Interfaces:

MetricAware, Releasable, Closeable, AutoCloseable

Direct Known Subclasses:

AbstractRepeatableCipherInputStream, ByteRangeCapturingInputStream, CipherLiteInputStream, CountingInputStream, CRC32ChecksumCalculatingInputStream, InputSubstream, LengthCheckInputStream, MD5DigestCalculatingInputStream, MetricFilterInputStream, ProgressInputStream, ReleasableInputStream, S3AbortableInputStream, S3ObjectInputStream, ServiceClientHolderInputStream

public class SdkFilterInputStream
extends FilterInputStream
implements MetricAware, Releasable

Base class for AWS Java SDK specific FilterInputStream.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SdkFilterInputStream(InputStream in)

Method Summary

Modifier and Type	Method and Description
void	abort() Can be used to provide abortion logic prior to throwing the AbortedException.
protected void	abortIfNeeded() Aborts with subclass specific abortion logic executed if needed.
int	available()
void	close()
InputStream	getDelegateStream()
protected boolean	isAborted()
boolean	isMetricActivated() Returns true if this object or one of it's inner wrapped objects has metrics gathering activity turned on; false otherwise.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	release() Releases the allocated resource.
void	reset()
long	skip(long n)

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

Constructor Detail

SdkFilterInputStream

protected SdkFilterInputStream(InputStream in)

Method Detail

getDelegateStream

public InputStream getDelegateStream()

Returns:

The wrapped stream.

isMetricActivated

public boolean isMetricActivated()

Description copied from interface: MetricAware

Returns true if this object or one of it's inner wrapped objects has metrics gathering activity turned on; false otherwise.

Specified by:

isMetricActivated in interface MetricAware

abortIfNeeded

protected final void abortIfNeeded()

Aborts with subclass specific abortion logic executed if needed. Note the interrupted status of the thread is cleared by this method.

Throws:

AbortedException - if found necessary.

abort

public void abort()

Can be used to provide abortion logic prior to throwing the AbortedException. If the wrapped InputStream is also an instance of this class, then it will also be aborted, otherwise this is a no-op.

isAborted

protected boolean isAborted()

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class FilterInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class FilterInputStream

release

public void release()

Description copied from interface: Releasable

Releases the allocated resource. This method should not be called except by the caller who allocated the resource at the very top of the call stack. This allows, typically, a Closeable resource to be not unintentionally released owing to the calling of the Closeable.close() methods by implementation deep down in the call stack.

For example, the creation of a ResettableInputStream would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing via ResettableInputStream#disableClose(), so that the release method becomes the only way to truly close the opened file.

Specified by:

release in interface Releasable