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

Class UploadImpl

java.lang.Object

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

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

All Implemented Interfaces:

Transfer, Upload

public class UploadImpl
extends AbstractTransfer
implements Upload

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.AbstractTransfer

listenerChain, monitor, state, stateChangeListeners

Constructor Summary

Constructors

Constructor and Description
UploadImpl(String description, TransferProgress transferProgressInternalState, ProgressListenerChain progressListenerChain, TransferStateChangeListener listener)

Method Summary

Modifier and Type	Method and Description
void	abort() Abort the current upload operation.
PersistableUpload	pause() Pause the current upload operation and returns the information that can be used to resume the upload.
PauseResult<PersistableUpload>	tryPause(boolean forceCancelTransfers) Tries to pause the current upload operation and returns the information that can be used to resume the upload.
UploadResult	waitForUploadResult() Waits for this upload to complete and returns the result of this upload.

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, setState, unwrapExecutionException, waitForCompletion, 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, waitForCompletion, waitForException

Constructor Detail

UploadImpl

public UploadImpl(String description,
                  TransferProgress transferProgressInternalState,
                  ProgressListenerChain progressListenerChain,
                  TransferStateChangeListener listener)

Method Detail

waitForUploadResult

public UploadResult waitForUploadResult()
                                 throws AmazonClientException,
                                        AmazonServiceException,
                                        InterruptedException

Waits for this upload to complete and returns the result of this upload. This is a blocking call. Be prepared to handle errors when calling this method. Any errors that occurred during the asynchronous transfer will be re-thrown through this method.

Specified by:

waitForUploadResult in interface Upload

Returns:

The result of this transfer.

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 upload to complete.

pause

public PersistableUpload pause()
                        throws PauseException

Description copied from interface: Upload

Pause the current upload operation and returns the information that can be used to resume the upload. Upload cannot be paused in the following cases.

• The data source is an input stream.
• Client side encryption is used.
• Server Side Encryption with customer provided key is used.
• Size of the file being uploaded is less than the TransferManagerConfiguration.getMultipartUploadThreshold().

In such cases, aborts the uploads and a PauseFailure exception is thrown

Specified by:

pause in interface Upload

Returns:

An opaque token that holds some private state and can be used to resume a paused download operation.

Throws:

PauseException - If failed to pause the operation.

tryPause

public PauseResult<PersistableUpload> tryPause(boolean forceCancelTransfers)

Description copied from interface: Upload

Tries to pause the current upload operation and returns the information that can be used to resume the upload. Upload cannot be paused in the following cases.

• The data source is an input stream.
• Client side encryption is used.
• Server Side Encryption with customer provided key is used.
• Size of the file being uploaded is less than the TransferManagerConfiguration.getMultipartUploadThreshold().

In such cases, aborts the uploads if forceCancelTransfers is set else No action is taken.

Specified by:

tryPause in interface Upload

Parameters:

forceCancelTransfers - a boolean to forcefully abort the existing uploads if pause cannot be done.

Returns:

a result of pause operation.

abort

public void abort()

Description copied from interface: Upload

Abort the current upload operation.

Specified by:

abort in interface Upload