TransferUtility (AWS SDK for Android

java.lang.Object
- com.amazonaws.mobileconnectors.s3.transferutility.TransferUtility

public class TransferUtility
extends Object

The transfer utility is a high-level class for applications to upload and download files. It inserts upload and download records into the database and starts a Service to execute the tasks in the background. Here is the usage:

 // Initializes TransferUtility
 TransferUtility transferUtility = new TransferUtility(s3, getApplicationContext());
 // Starts a download
 TransferObserver observer = transferUtility.download("bucket_name", "key", file);
 observer.setTransferListener(new TransferListener() {
     public void onStateChanged(int id, String newState) {
         // Do something in the callback.
     }

     public void onProgressChanged(int id, long bytesCurrent, long bytesTotal) {
         // Do something in the callback.
     }

     public void onError(int id, Exception e) {
         // Do something in the callback.
     }
 });

For pausing and resuming tasks:

 // Gets id of the transfer.
 int id = observer.getId();

 // Pauses the transfer.
 transferUtility.pause(id);

 // Resumes the transfer.
 transferUtility.resume(id);

For cancelling and deleting tasks:

 // Cancels the transfer.
 transferUtility.cancel(id);

 // Deletes the transfer.
 transferUtility.delete(id);

Constructor Summary

Constructors
Constructor and Description
`TransferUtility(AmazonS3 s3, android.content.Context context)` Constructs a new TransferUtility specifying the client to use and initializes configuration of TransferUtility and a key for S3 client weak reference.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cancel(int id)` Sets a transfer to be canceled.
`void`	`cancelAllWithType(TransferType type)` Sets all transfers which have the given type to be canceled.
`boolean`	`deleteTransferRecord(int id)` Deletes a transfer record with the given id.
`TransferObserver`	`download(String bucket, String key, File file)` Starts downloading the S3 object specified by the bucket and the key to the given file.
`TransferObserver`	`getTransferById(int id)` Gets a TransferObserver instance to track the record with the given id.
`List<TransferObserver>`	`getTransfersWithType(TransferType type)` Gets a list of TransferObserver instances which are observing records with the given type.
`List<TransferObserver>`	`getTransfersWithTypeAndState(TransferType type, TransferState state)` Gets a list of TransferObserver instances which are observing records with the given type.
`boolean`	`pause(int id)` Pauses a transfer task with the given id.
`void`	`pauseAllWithType(TransferType type)` Pauses all transfers which have the given type.
`TransferObserver`	`resume(int id)` Resumes the transfer task with the given id.
`TransferObserver`	`upload(String bucket, String key, File file)` Starts uploading the file to the given bucket, using the given key.
`TransferObserver`	`upload(String bucket, String key, File file, ObjectMetadata metadata)` Starts uploading the file to the given bucket, using the given key.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TransferUtility
```
public TransferUtility(AmazonS3 s3,
                       android.content.Context context)
```
    Constructs a new TransferUtility specifying the client to use and initializes configuration of TransferUtility and a key for S3 client weak reference.
    
    Parameters:
    
    s3 - The client to use when making requests to Amazon S3
    
    context - The current context
    
    configuration - Configuration parameters for this TransferUtility
- Method Detail
  - download
```
public TransferObserver download(String bucket,
                                 String key,
                                 File file)
```
    Starts downloading the S3 object specified by the bucket and the key to the given file. The file must be a valid file. Directory isn't supported. Note that if the given file exists, it'll be overwritten.
    
    Parameters:
    
    bucket - The name of the bucket containing the object to download.
    
    key - The key under which the object to download is stored.
    
    file - The file to download the object's data to.
    
    Returns:
    
    A TransferObserver used to track download progress and state
  - upload
```
public TransferObserver upload(String bucket,
                               String key,
                               File file)
```
    Starts uploading the file to the given bucket, using the given key. The file must be a valid file. Directory isn't supported.
    
    Parameters:
    
    bucket - The name of the bucket to upload the new object to.
    
    key - The key in the specified bucket by which to store the new object.
    
    file - The file to upload.
    
    Returns:
    
    A TransferObserver used to track upload progress and state
  - upload
```
public TransferObserver upload(String bucket,
                               String key,
                               File file,
                               ObjectMetadata metadata)
```
    Starts uploading the file to the given bucket, using the given key. The file must be a valid file. Directory isn't supported.
    
    Parameters:
    
    bucket - The name of the bucket to upload the new object to.
    
    key - The key in the specified bucket by which to store the new object.
    
    file - The file to upload.
    
    metadata - The S3 metadata to associate with this object
    
    Returns:
    
    A TransferObserver used to track upload progress and state
  - getTransferById
```
public TransferObserver getTransferById(int id)
```
    Gets a TransferObserver instance to track the record with the given id.
    
    Parameters:
    
    id - A transfer id.
    
    Returns:
    
    The TransferObserver instance which is observing the record.
  - getTransfersWithType
```
public List<TransferObserver> getTransfersWithType(TransferType type)
```
    Gets a list of TransferObserver instances which are observing records with the given type.
    
    Parameters:
    
    type - The type of the transfer "any".
    
    Returns:
    
    A list of TransferObserver instances.
  - getTransfersWithTypeAndState
```
public List<TransferObserver> getTransfersWithTypeAndState(TransferType type,
                                                           TransferState state)
```
    Gets a list of TransferObserver instances which are observing records with the given type.
    
    Parameters:
    
    type - The type of the transfer.
    
    state - The state of the transfer.
    
    Returns:
    
    A list of TransferObserver of transfer records with the given type and state.
  - pause
```
public boolean pause(int id)
```
    Pauses a transfer task with the given id.
    
    Parameters:
    
    id - A transfer id specifying the transfer to be paused
    
    Returns:
    
    Whether successfully paused
  - pauseAllWithType
```
public void pauseAllWithType(TransferType type)
```
    Pauses all transfers which have the given type.
    
    Parameters:
    
    type - The type of transfers
  - resume
```
public TransferObserver resume(int id)
```
    Resumes the transfer task with the given id. You can resume a transfer in paused, canceled or failed state. If a transfer is in waiting or in progress state but it isn't actually running, this operation will force it to run.
    
    Parameters:
    
    id - A transfer id specifying the transfer to be resumed
    
    Returns:
    
    A TransferObserver of the resumed upload/download or null if the ID does not represent a paused transfer
  - cancel
```
public boolean cancel(int id)
```
    Sets a transfer to be canceled. Note the TransferState must be TransferState.CANCELED before the transfer is guaranteed to have stopped, and can be safely deleted
    
    Parameters:
    
    id - A transfer id specifying the transfer to be canceled
    
    Returns:
    
    Whether the transfer was set to be canceled.
  - cancelAllWithType
```
public void cancelAllWithType(TransferType type)
```
    Sets all transfers which have the given type to be canceled. Note the TransferState must be TransferState.CANCELED before the transfer is guaranteed to have stopped, and can be safely deleted
    
    Parameters:
    
    type - The type of transfers
  - deleteTransferRecord
```
public boolean deleteTransferRecord(int id)
```
    Deletes a transfer record with the given id. It just deletes the record but does not stop the running thread, so you must cancel the task before deleting the record.
    
    Parameters:
    
    id - A transfer id specifying the transfer to be deleted.
    
    Returns:
    
    true if at least one record was deleted

Class TransferUtility

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransferUtility

Method Detail

download

upload

upload

getTransferById

getTransfersWithType

getTransfersWithTypeAndState

pause

pauseAllWithType

resume

cancel

cancelAllWithType

deleteTransferRecord