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

Class MultipleFileDownloadImpl

java.lang.Object

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

com.ibm.cloud.objectstorage.services.s3.transfer.internal.MultipleFileTransfer<Download>

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

All Implemented Interfaces:

MultipleFileDownload, Transfer

public class MultipleFileDownloadImpl
extends MultipleFileTransfer<Download>
implements MultipleFileDownload

Multiple file download when downloading an entire virtual directory.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cloud.objectstorage.services.s3.transfer.Transfer

Transfer.TransferState

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.services.s3.transfer.internal.MultipleFileTransfer

subTransfers

Fields inherited from class com.ibm.cloud.objectstorage.services.s3.transfer.internal.AbstractTransfer

listenerChain, monitor, state, stateChangeListeners

Constructor Summary

Constructors

Constructor and Description
MultipleFileDownloadImpl(String description, TransferProgress transferProgress, ProgressListenerChain progressListenerChain, String keyPrefix, String bucketName, Collection<? extends Download> downloads)

Method Summary

Modifier and Type	Method and Description
void	abort() Aborts all outstanding downloads.
String	getBucketName() Returns the name of the bucket from which files are downloaded.
String	getKeyPrefix() Returns the key prefix of the virtual directory being downloaded.
void	waitForCompletion() Waits for this transfer to complete.

Methods inherited from class com.ibm.cloud.objectstorage.services.s3.transfer.internal.MultipleFileTransfer

collateFinalState, setState

Methods inherited from class com.ibm.cloud.objectstorage.services.s3.transfer.internal.AbstractTransfer

addProgressListener, addProgressListener, addStateChangeListener, fireProgressEvent, getDescription, getMonitor, getProgress, getState, isDone, notifyStateChangeListeners, removeProgressListener, removeProgressListener, removeStateChangeListener, rethrowExecutionException, setMonitor, unwrapExecutionException, waitForException

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.services.s3.transfer.Transfer

addProgressListener, addProgressListener, getDescription, getProgress, getState, isDone, removeProgressListener, removeProgressListener, waitForException

Constructor Detail

MultipleFileDownloadImpl

public MultipleFileDownloadImpl(String description,
                                TransferProgress transferProgress,
                                ProgressListenerChain progressListenerChain,
                                String keyPrefix,
                                String bucketName,
                                Collection<? extends Download> downloads)

Method Detail

getKeyPrefix

public String getKeyPrefix()

Returns the key prefix of the virtual directory being downloaded.

Specified by:

getKeyPrefix in interface MultipleFileDownload

getBucketName

public String getBucketName()

Returns the name of the bucket from which files are downloaded.

Specified by:

getBucketName in interface MultipleFileDownload

waitForCompletion

public void waitForCompletion()
                       throws AmazonClientException,
                              AmazonServiceException,
                              InterruptedException

Waits for this transfer to complete. This is a blocking call; the current thread is suspended until this transfer completes.

Specified by:

waitForCompletion in interface Transfer

Overrides:

waitForCompletion in class AbstractTransfer

Throws:

AmazonClientException - If any errors were encountered in the client while making the request or handling the response.

AmazonServiceException - If any errors occurred in Amazon S3 while processing the request.

InterruptedException - If this thread is interrupted while waiting for the transfer to complete.

abort

public void abort()
           throws IOException

Aborts all outstanding downloads.

Specified by:

abort in interface MultipleFileDownload

Throws:

IOException