Package software.amazon.awssdk.core

Class ResponseInputStream<ResponseT>

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

software.amazon.awssdk.core.io.SdkFilterInputStream

software.amazon.awssdk.core.ResponseInputStream<ResponseT>

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable, Abortable

public final class ResponseInputStream<ResponseT>
extends SdkFilterInputStream
implements Abortable

Input stream that provides access to the unmarshalled POJO response returned by the service in addition to the streamed contents. This input stream should be closed to release the underlying connection back to the connection pool.

If it is not desired to read remaining data from the stream, you can explicitly abort the connection via abort(). Note that this will close the underlying connection and require establishing an HTTP connection which may outweigh the cost of reading the additional data.

Constructor Summary

Constructors

Constructor	Description
ResponseInputStream(ResponseT resp, InputStream in)
ResponseInputStream(ResponseT resp, AbortableInputStream in)

Method Summary

Modifier and Type	Method	Description
void	abort()	Aborts the execution of the task.
ResponseT	response()

Methods inherited from class software.amazon.awssdk.core.io.SdkFilterInputStream

available, close, mark, markSupported, read, read, release, reset, skip

Methods inherited from class java.io.FilterInputStream

read

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseInputStream

public ResponseInputStream(ResponseT resp,
 AbortableInputStream in)

ResponseInputStream

public ResponseInputStream(ResponseT resp,
 InputStream in)

Method Details

response

public ResponseT response()

Returns:

The unmarshalled POJO response associated with this content.

abort

public void abort()

Description copied from interface: Abortable

Aborts the execution of the task. Multiple calls to abort or calling abort an already aborted task should return without error.

Specified by:

abort in interface Abortable