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

Class DownloadImpl

java.lang.Object

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

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

All Implemented Interfaces:

AbortableTransfer, Download, Transfer

public class DownloadImpl
extends AbstractTransfer
implements Download

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
DownloadImpl(String description, TransferProgress transferProgress, ProgressListenerChain progressListenerChain, S3Object s3Object, TransferStateChangeListener listener, GetObjectRequest getObjectRequest, File file) Deprecated.
DownloadImpl(String description, TransferProgress transferProgress, ProgressListenerChain progressListenerChain, S3Object s3Object, TransferStateChangeListener listener, GetObjectRequest getObjectRequest, File file, ObjectMetadata objectMetadata, boolean isDownloadParallel)

Method Summary

Modifier and Type	Method and Description
void	abort() Cancels this download.
void	abortWithoutNotifyingStateChangeListener() Cancels this download, but skip notifying the state change listeners.
String	getBucketName() The name of the bucket where the object is being downloaded from.
String	getKey() The key under which this object was stored in Amazon S3.
Long	getLastFullyDownloadedFilePosition()
Integer	getLastFullyDownloadedPartNumber() For parallel downloads, returns the last part number that was successfully written into the download file.
ObjectMetadata	getObjectMetadata() Returns the ObjectMetadata for the object being downloaded.
PersistableDownload	pause() Pause the current download operation and returns the information that can be used to resume the download at a later time.
void	setS3Object(S3Object s3Object) Set the S3 object to download.
void	setState(Transfer.TransferState state) This method is also responsible for firing COMPLETED signal to the listeners.

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, 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

DownloadImpl

@Deprecated
public DownloadImpl(String description,
                                TransferProgress transferProgress,
                                ProgressListenerChain progressListenerChain,
                                S3Object s3Object,
                                TransferStateChangeListener listener,
                                GetObjectRequest getObjectRequest,
                                File file)

Deprecated.

DownloadImpl

public DownloadImpl(String description,
                    TransferProgress transferProgress,
                    ProgressListenerChain progressListenerChain,
                    S3Object s3Object,
                    TransferStateChangeListener listener,
                    GetObjectRequest getObjectRequest,
                    File file,
                    ObjectMetadata objectMetadata,
                    boolean isDownloadParallel)

Method Detail

getObjectMetadata

public ObjectMetadata getObjectMetadata()

Returns the ObjectMetadata for the object being downloaded.

Specified by:

getObjectMetadata in interface Download

Returns:

The ObjectMetadata for the object being downloaded.

getBucketName

public String getBucketName()

The name of the bucket where the object is being downloaded from.

Specified by:

getBucketName in interface Download

Returns:

The name of the bucket where the object is being downloaded from.

getKey

public String getKey()

The key under which this object was stored in Amazon S3.

Specified by:

getKey in interface Download

Returns:

The key under which this object was stored in Amazon S3.

getLastFullyDownloadedPartNumber

public Integer getLastFullyDownloadedPartNumber()

For parallel downloads, returns the last part number that was successfully written into the download file. Returns null for serial downloads.

getLastFullyDownloadedFilePosition

public Long getLastFullyDownloadedFilePosition()

abort

public void abort()
           throws IOException

Cancels this download.

Specified by:

abort in interface AbortableTransfer

Throws:

IOException

abortWithoutNotifyingStateChangeListener

public void abortWithoutNotifyingStateChangeListener()
                                              throws IOException

Cancels this download, but skip notifying the state change listeners.

Throws:

IOException

setS3Object

public void setS3Object(S3Object s3Object)

Set the S3 object to download.

setState

public void setState(Transfer.TransferState state)

This method is also responsible for firing COMPLETED signal to the listeners.

Overrides:

setState in class AbstractTransfer

pause

public PersistableDownload pause()
                          throws PauseException

Description copied from interface: Download

Pause the current download operation and returns the information that can be used to resume the download at a later time. Resuming a download would not perform ETag check as range get is performed for downloading the object's remaining contents. Resuming a download for an object encrypted using CryptoMode.StrictAuthenticatedEncryption would result in AmazonClientException as authenticity cannot be guaranteed for a range get operation.

Specified by:

pause in interface Download

Throws:

PauseException - If any errors were encountered while trying to pause the download.