com.ibm.cloud.objectstorage.event

Class ProgressInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.ibm.cloud.objectstorage.internal.SdkFilterInputStream

com.ibm.cloud.objectstorage.event.ProgressInputStream

All Implemented Interfaces:

MetricAware, Releasable, Closeable, AutoCloseable

@NotThreadSafe
public abstract class ProgressInputStream
extends SdkFilterInputStream

Used for input stream progress tracking purposes.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
ProgressListener	getListener()
protected long	getNotifiedByteCount()
protected int	getUnnotifiedByteCount()
InputStream	getWrappedInputStream()
static InputStream	inputStreamForRequest(InputStream is, AmazonWebServiceRequest req) Deprecated.
static InputStream	inputStreamForRequest(InputStream is, ProgressListener progressListener)
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.
protected void	onClose() Defaults to behave the same as ProgressInputStream.onEOF().
protected void	onEOF() An end-of-file event is to be notified.
protected void	onFirstRead() The read method is called for the very first time.
protected void	onNotifyBytesRead() Upon notification of the number of bytes transferred since last notification.
protected void	onReset() A reset event is to be notified.
int	read()
int	read(byte[] b, int off, int len)
void	reset()

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

abort, abortIfNeeded, available, getDelegateStream, isAborted, isMetricActivated, mark, markSupported, release, 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

ProgressInputStream

public ProgressInputStream(InputStream is,
                           ProgressListener listener)

ProgressInputStream

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

Method Detail

inputStreamForRequest

@Deprecated
public static InputStream inputStreamForRequest(InputStream is,
                                                            AmazonWebServiceRequest req)

Deprecated.

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

Parameters:

is - the request content input stream

inputStreamForRequest

public static InputStream inputStreamForRequest(InputStream is,
                                                ProgressListener progressListener)

Parameters:

is - the request 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.

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.

onFirstRead

protected void onFirstRead()

The read method is called for the very first time. Defaults to do nothing.

onEOF

protected void onEOF()

An end-of-file event is to be notified. Defaults to do nothing.

onClose

protected void onClose()

Defaults to behave the same as ProgressInputStream.onEOF().

onReset

protected void onReset()

A reset event is to be notified. Default to do nothing.

onNotifyBytesRead

protected void onNotifyBytesRead()

Upon notification of the number of bytes transferred since last notification. Default to do nothing.

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()

getUnnotifiedByteCount

protected final int getUnnotifiedByteCount()

getNotifiedByteCount

protected final long getNotifiedByteCount()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class SdkFilterInputStream

Throws:

IOException

getListener

public final ProgressListener getListener()