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

Class S3ProgressListenerChain

java.lang.Object

com.ibm.cloud.objectstorage.event.ProgressListenerChain

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

All Implemented Interfaces:

DeliveryMode, ProgressListener, S3ProgressListener

public class S3ProgressListenerChain
extends ProgressListenerChain
implements S3ProgressListener

S3 specific progress listener chain.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cloud.objectstorage.event.ProgressListener

ProgressListener.ExceptionReporter, ProgressListener.NoOpProgressListener

Nested classes/interfaces inherited from interface com.ibm.cloud.objectstorage.event.DeliveryMode

DeliveryMode.Check

Field Summary

Fields inherited from interface com.ibm.cloud.objectstorage.event.ProgressListener

NOOP

Constructor Summary

Constructors

Constructor and Description
S3ProgressListenerChain(ProgressListener... listeners) Create a listener chain that directly passes all the progress events to the specified listeners.

Method Summary

Modifier and Type	Method and Description
void	onPersistableTransfer(PersistableTransfer persistableTransfer) Called when the information to resume an upload/download operation is available, The execution of the callback of this listener is managed by S3ProgressPublisher.

Methods inherited from class com.ibm.cloud.objectstorage.event.ProgressListenerChain

addProgressListener, getListeners, isSyncCallSafe, progressChanged, removeProgressListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cloud.objectstorage.event.ProgressListener

progressChanged

Constructor Detail

S3ProgressListenerChain

public S3ProgressListenerChain(ProgressListener... listeners)

Create a listener chain that directly passes all the progress events to the specified listeners.

Parameters:

listeners - only listeners of type S3ProgressListener will be notified with the S3 transfer events.

Method Detail

onPersistableTransfer

public void onPersistableTransfer(PersistableTransfer persistableTransfer)

Description copied from interface: S3ProgressListener

Called when the information to resume an upload/download operation is available, The execution of the callback of this listener is managed by S3ProgressPublisher. Implementation of this interface should never block.

If the implementation follows the best practice and doesn't block, it should then extends from S3SyncProgressListener.

Note any exception thrown by the listener will get ignored. Should there be need to capture any such exception, you may consider wrapping the listener with ProgressListener.ExceptionReporter.wrap(ProgressListener).

Specified by:

onPersistableTransfer in interface S3ProgressListener

Parameters:

persistableTransfer - A non null opaque token used to resume an upload or download.

See Also:

S3ProgressPublisher, ProgressListener.ExceptionReporter