com.amazonaws.services.s3.transfer.internal

Class UploadMonitor

java.lang.Object

com.amazonaws.services.s3.transfer.internal.UploadMonitor

All Implemented Interfaces:

TransferMonitor, Callable<UploadResult>

public class UploadMonitor
extends Object
implements Callable<UploadResult>, 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 future and returns null. When waiting on the result of this class via a Future object, clients must call isDone() and getFuture()

Constructor Summary

Constructors

Constructor and Description
UploadMonitor(TransferManager manager, UploadImpl transfer, ExecutorService threadPool, UploadCallable multipartUploadCallable, PutObjectRequest putObjectRequest, ProgressListenerChain progressListenerChain) Constructs a new upload watcher, which immediately submits itself to the thread pool.
UploadMonitor(TransferManager manager, UploadImpl transfer, ExecutorService threadPool, UploadCallable multipartUploadCallable, PutObjectRequest putObjectRequest, ProgressListenerChain progressListenerChain) Deprecated. Replaced by UploadMonitor(TransferManager, UploadImpl, ExecutorService, UploadCallable, PutObjectRequest, ProgressListenerChain)

Method Summary

Methods

Modifier and Type	Method and Description
UploadResult	call()
Future<UploadResult>	getFuture() Returns a Future to wait on.
boolean	isDone() Returns whether the transfer is completed.
void	setTimedThreadPool(ScheduledExecutorService timedThreadPool)

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadMonitor

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

Constructs a new upload watcher, which immediately submits itself 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

UploadMonitor

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

Deprecated. Replaced by UploadMonitor(TransferManager, UploadImpl, ExecutorService, UploadCallable, PutObjectRequest, ProgressListenerChain)

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

setTimedThreadPool

public void setTimedThreadPool(ScheduledExecutorService timedThreadPool)

call

public UploadResult call()
                  throws Exception

Specified by:

call in interface Callable<UploadResult>

Throws:

Exception