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

Class MultipleFileUploadImpl

java.lang.Object

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

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

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

All Implemented Interfaces:

MultipleFileUpload, Transfer

public class MultipleFileUploadImpl
extends MultipleFileTransfer<Upload>
implements MultipleFileUpload

Multiple file upload when uploading an entire 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
MultipleFileUploadImpl(String description, TransferProgress transferProgress, ProgressListenerChain progressListenerChain, String keyPrefix, String bucketName, Collection<? extends Upload> subTransfers)

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of the bucket to which files are uploaded.
String	getKeyPrefix() Returns the key prefix of the virtual directory being uploaded to.
Collection<? extends Upload>	getSubTransfers() Returns a collection of sub transfers associated with the multi file upload.
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

MultipleFileUploadImpl

public MultipleFileUploadImpl(String description,
                              TransferProgress transferProgress,
                              ProgressListenerChain progressListenerChain,
                              String keyPrefix,
                              String bucketName,
                              Collection<? extends Upload> subTransfers)

Method Detail

getKeyPrefix

public String getKeyPrefix()

Returns the key prefix of the virtual directory being uploaded to.

Specified by:

getKeyPrefix in interface MultipleFileUpload

getBucketName

public String getBucketName()

Returns the name of the bucket to which files are uploaded.

Specified by:

getBucketName in interface MultipleFileUpload

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.

getSubTransfers

public Collection<? extends Upload> getSubTransfers()

Description copied from interface: MultipleFileUpload

Returns a collection of sub transfers associated with the multi file upload.

Specified by:

getSubTransfers in interface MultipleFileUpload