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

Class UploadMonitor

java.lang.Object

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

All Implemented Interfaces:

TransferMonitor, Callable<Void>

public class UploadMonitor
extends Object
implements Callable<Void>, TransferMonitor

Manages an upload by periodically checking to see if the upload is done, and returning a result if so. Otherwise, schedules a copy of itself to be run in the futureReference and returns null. When waiting on the result of this class via a Future object, clients must call UploadMonitor.isDone() and UploadMonitor.getFuture()

Method Summary

Modifier and Type	Method and Description
Void	call()
static UploadMonitor	create(TransferManager manager, UploadImpl transfer, ExecutorService threadPool, UploadCallable multipartUploadCallable, PutObjectRequest putObjectRequest, ProgressListenerChain progressListenerChain) Constructs a new upload watcher and then immediately submits it to the thread pool.
Future<UploadResult>	getFuture() Returns a Future to wait on.
boolean	isDone() Returns whether the transfer is completed.

Methods inherited from class java.lang.Object

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

Method Detail

getFuture

public Future<UploadResult> getFuture()

Description copied from interface: TransferMonitor

Returns a Future to wait on. Calling get() on this future will block while the transfer progress is checked, but its return does not guarantee the transfer is complete. Call isDone() to check for completion. Repeated calls to getFuture() can return different objects.

Specified by:

getFuture in interface TransferMonitor

isDone

public boolean isDone()

Description copied from interface: TransferMonitor

Returns whether the transfer is completed. A failure or cancellation counts as completion as well; to gather any exceptions thrown, call getFuture().get()

Specified by:

isDone in interface TransferMonitor

create

public static UploadMonitor create(TransferManager manager,
                                   UploadImpl transfer,
                                   ExecutorService threadPool,
                                   UploadCallable multipartUploadCallable,
                                   PutObjectRequest putObjectRequest,
                                   ProgressListenerChain progressListenerChain)

Constructs a new upload watcher and then immediately submits it to the thread pool.

Parameters:

manager - The TransferManager that owns this upload.

transfer - The transfer being processed.

threadPool - The ExecutorService to which we should submit new tasks.

multipartUploadCallable - The callable responsible for processing the upload asynchronously

putObjectRequest - The original putObject request

progressListenerChain - A chain of listeners that wish to be notified of upload progress

call

public Void call()

Specified by:

call in interface Callable<Void>