com.ibm.cloud.objectstorage.services.s3.model

Class S3ObjectInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.ibm.cloud.objectstorage.internal.SdkFilterInputStream

com.ibm.cloud.objectstorage.services.s3.model.S3ObjectInputStream

All Implemented Interfaces:

MetricAware, Releasable, Closeable, AutoCloseable

public class S3ObjectInputStream
extends SdkFilterInputStream

Input stream representing the content of an S3Object. In addition to the methods supplied by the InputStream class, S3ObjectInputStream supplies the abort() method, which will terminate an HTTP connection to the S3 object.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
S3ObjectInputStream(InputStream in, org.apache.http.client.methods.HttpRequestBase httpRequest)
S3ObjectInputStream(InputStream in, org.apache.http.client.methods.HttpRequestBase httpRequest, boolean collectMetrics)

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() If the stream still contains unread data, the underlying HTTP request will aborted.
org.apache.http.client.methods.HttpRequestBase	getHttpRequest() Returns the http request from which this input stream is derived.

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

abortIfNeeded, getDelegateStream, isAborted, isMetricActivated, mark, markSupported, read, read, release, reset, skip

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

S3ObjectInputStream

public S3ObjectInputStream(InputStream in,
                           org.apache.http.client.methods.HttpRequestBase httpRequest)

S3ObjectInputStream

public S3ObjectInputStream(InputStream in,
                           org.apache.http.client.methods.HttpRequestBase httpRequest,
                           boolean collectMetrics)

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

getHttpRequest

public org.apache.http.client.methods.HttpRequestBase getHttpRequest()

Returns the http request from which this input stream is derived.

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

close

public void close()
           throws IOException

If the stream still contains unread data, the underlying HTTP request will aborted.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class SdkFilterInputStream

Throws:

IOException

See Also:

S3ObjectInputStream.abort(), S3AbortableInputStream