Package software.amazon.awssdk.event

Class ProgressInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

software.amazon.awssdk.runtime.io.SdkFilterInputStream

software.amazon.awssdk.event.ProgressInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable, MetricAware

@NotThreadSafe
public abstract class ProgressInputStream
extends SdkFilterInputStream

Used for input stream progress tracking purposes.

Constructor Summary

Constructors

Constructor	Description
ProgressInputStream(InputStream is, ProgressListener listener)
ProgressInputStream(InputStream is, ProgressListener listener, int notifyThresHold)

Method Summary

Modifier and Type	Method	Description
void	close()
ProgressListener	getListener()
InputStream	getWrappedInputStream()
static InputStream	inputStreamForRequest(InputStream is, ProgressListener progressListener)	Returns a new input stream decorated with progress reporting functionality if the the progress listener is not null, otherwise it returns the same inputstream as passed in.
static InputStream	inputStreamForResponse(InputStream is, AmazonWebServiceRequest req)	Returns an input stream for response progress tracking purposes.
static InputStream	inputStreamForResponse(InputStream is, ProgressListener progressListener)	Returns an input stream for response progress tracking purposes.
int	read()
int	read(byte[] b, int off, int len)
void	reset()

Methods inherited from class java.io.FilterInputStream

read

Methods inherited from class java.io.InputStream

readAllBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.internal.io.Releasable

release

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

available, isMetricActivated, mark, markSupported, release, skip

Constructor Detail

ProgressInputStream

public ProgressInputStream(InputStream is,
                           ProgressListener listener)

ProgressInputStream

public ProgressInputStream(InputStream is,
                           ProgressListener listener,
                           int notifyThresHold)

Method Detail

inputStreamForRequest

public static InputStream inputStreamForRequest(InputStream is,
                                                ProgressListener progressListener)

Returns a new input stream decorated with progress reporting functionality if the the progress listener is not null, otherwise it returns the same inputstream as passed in.

Parameters:

is - the request content input stream

progressListener - Optional progress listener

Returns:

an input stream with request content

inputStreamForResponse

public static InputStream inputStreamForResponse(InputStream is,
                                                 AmazonWebServiceRequest req)

Returns an input stream for response progress tracking purposes. If request/response progress tracking is not enabled, this method simply return the given input stream as is.

Parameters:

is - the response content input stream

inputStreamForResponse

public static InputStream inputStreamForResponse(InputStream is,
                                                 ProgressListener progressListener)

Returns an input stream for response progress tracking purposes. If request/response progress tracking is not enabled, this method simply return the given input stream as is.

Parameters:

is - the response content input stream

progressListener - Optional progress listener

Returns:

If the progress listener is non null returns a new input stream decorated with progress reporting functionality. If progress listener is null it returns the same input stream.

read

public int read()
         throws IOException

Overrides:

read in class SdkFilterInputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class SdkFilterInputStream

Throws:

IOException

read

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

Overrides:

read in class SdkFilterInputStream

Throws:

IOException

getWrappedInputStream

public final InputStream getWrappedInputStream()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class SdkFilterInputStream

Throws:

IOException

getListener

public final ProgressListener getListener()