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

Class CopyMonitor

java.lang.Object

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

All Implemented Interfaces:

TransferMonitor, Callable<CopyResult>

public class CopyMonitor
extends Object
implements Callable<CopyResult>, TransferMonitor

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

Method Summary

Modifier and Type	Method and Description
CopyResult	call()
static CopyMonitor	create(TransferManager manager, CopyImpl transfer, ExecutorService threadPool, CopyCallable multipartCopyCallable, CopyObjectRequest copyObjectRequest, ProgressListenerChain progressListenerChain) Constructs a new watcher for copy operation, and then immediately submits it to the thread pool.
Future<CopyResult>	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<CopyResult> 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 CopyMonitor create(TransferManager manager,
                                 CopyImpl transfer,
                                 ExecutorService threadPool,
                                 CopyCallable multipartCopyCallable,
                                 CopyObjectRequest copyObjectRequest,
                                 ProgressListenerChain progressListenerChain)

Constructs a new watcher for copy operation, and then immediately submits it to the thread pool.

Parameters:

manager - The TransferManager that owns this copy request.

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

multipartCopyCallable - The callable responsible for processing the copy asynchronously

copyObjectRequest - The original CopyObject request

call

public CopyResult call()
                throws Exception

Specified by:

call in interface Callable<CopyResult>

Throws:

Exception