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

Class AbstractDownloadCallable

java.lang.Object

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

All Implemented Interfaces:

Callable<File>

Direct Known Subclasses:

PresignUrlDownloadCallable

public abstract class AbstractDownloadCallable
extends Object
implements Callable<File>

Abstract callable used for downloading objects using TransferManager.

See Also:

PresignUrlDownloadCallable

Field Summary

Fields

Modifier and Type	Field and Description
protected File	dstfile
protected ExecutorService	executor The thread pool in which partial objects are downloaded.
protected List<Future<Long>>	futures

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDownloadCallable(com.ibm.cloud.objectstorage.services.s3.transfer.internal.AbstractDownloadCallableConfig options)

Method Summary

Modifier and Type	Method and Description
File	call() This method must return a non-null object, or else the existing implementation in AbstractTransfer.waitForCompletion() would block forever.
protected static com.ibm.cloud.objectstorage.services.s3.transfer.internal.AbstractDownloadCallableConfig	constructCallableConfig(ExecutorService executor, File dstfile, CountDownLatch latch, AbortableTransfer download, boolean isDownloadParallel, ScheduledExecutorService timedExecutor, long timeout)
protected abstract void	downloadAsSingleObject() Download the object from S3 in a single request
protected abstract void	downloadInParallel() Download the object from S3 in multiple requests
protected abstract void	setState(Transfer.TransferState transferState) Set the current Transfer.TransferState

Methods inherited from class java.lang.Object

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

Field Detail

executor

protected final ExecutorService executor

The thread pool in which partial objects are downloaded.

futures

protected final List<Future<Long>> futures

dstfile

protected final File dstfile

Constructor Detail

AbstractDownloadCallable

protected AbstractDownloadCallable(com.ibm.cloud.objectstorage.services.s3.transfer.internal.AbstractDownloadCallableConfig options)

Method Detail

call

public File call()
          throws Exception

This method must return a non-null object, or else the existing implementation in AbstractTransfer.waitForCompletion() would block forever.

Specified by:

call in interface Callable<File>

Returns:

the downloaded file

Throws:

Exception

setState

protected abstract void setState(Transfer.TransferState transferState)

Set the current Transfer.TransferState

downloadAsSingleObject

protected abstract void downloadAsSingleObject()

Download the object from S3 in a single request

downloadInParallel

protected abstract void downloadInParallel()
                                    throws Exception

Download the object from S3 in multiple requests

Throws:

Exception

constructCallableConfig

protected static com.ibm.cloud.objectstorage.services.s3.transfer.internal.AbstractDownloadCallableConfig constructCallableConfig(ExecutorService executor,
                                                                                                                                  File dstfile,
                                                                                                                                  CountDownLatch latch,
                                                                                                                                  AbortableTransfer download,
                                                                                                                                  boolean isDownloadParallel,
                                                                                                                                  ScheduledExecutorService timedExecutor,
                                                                                                                                  long timeout)