com.ibm.cloud.objectstorage.services.s3.internal

Class S3AbortableInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.ibm.cloud.objectstorage.internal.SdkFilterInputStream

com.ibm.cloud.objectstorage.services.s3.internal.S3AbortableInputStream

All Implemented Interfaces:

MetricAware, Releasable, Closeable, AutoCloseable

public final class S3AbortableInputStream
extends SdkFilterInputStream

Does EOS detection for objects returned by S3. Will abort the HTTP connection if not all data is read from the stream which means a new connection must be established. This is likely an error on the customers part as they should only request the bytes they need (or drain the stream after use) to ensure the connection can be reused.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
S3AbortableInputStream(InputStream in, org.apache.http.client.methods.HttpRequestBase httpRequest, long contentLength)

Method Summary

Modifier and Type	Method and Description
void	abort() Can be used to provide abortion logic prior to throwing the AbortedException.
int	available() Returns the value of super.available() if the result is nonzero, or 1 otherwise.
void	close() Delegates to S3ObjectInputStream.abort() if there is any data remaining in the stream.
void	mark(int readlimit)
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

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

abortIfNeeded, getDelegateStream, isAborted, isMetricActivated, markSupported, release

Methods inherited from class java.lang.Object

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

Constructor Detail

S3AbortableInputStream

public S3AbortableInputStream(InputStream in,
                              org.apache.http.client.methods.HttpRequestBase httpRequest,
                              long contentLength)

Method Detail

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. Aborts the underlying http request without reading any more data and closes the stream.

By default Apache HttpClient tries to reuse http connections by reading to the end of an attached input stream on InputStream.close(). This is efficient from a socket pool management perspective, but for objects with large payloads can incur significant overhead while bytes are read from s3 and discarded. It's up to clients to decide when to take the performance hit implicit in not reusing an http connection in order to not read unnecessary information from S3.

Overrides:

abort in class SdkFilterInputStream

See Also:

EofSensorInputStream

available

public int available()
              throws IOException

Returns the value of super.available() if the result is nonzero, or 1 otherwise.

This is necessary to work around a known bug in GZIPInputStream.available(), which returns zero in some edge cases, causing file truncation.

Ref: http://bugs.java.com/bugdatabase/view_bug.do?bug_id=7036144

Overrides:

available in class SdkFilterInputStream

Throws:

IOException

read

public int read()
         throws IOException

Overrides:

read in class SdkFilterInputStream

Throws:

IOException

read

public int read(byte[] b)
         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 SdkFilterInputStream

Throws:

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:

IOException

close

public void close()
           throws IOException

Delegates to S3ObjectInputStream.abort() if there is any data remaining in the stream. Otherwise, it safely closes the stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class SdkFilterInputStream

Throws:

IOException

See Also:

S3ObjectInputStream#abort()}