com.amazonaws.mobileconnectors.s3.transferutility

Class TransferObserver

java.lang.Object

com.amazonaws.mobileconnectors.s3.transferutility.TransferObserver

public class TransferObserver
extends java.lang.Object

TransferObserver is used to track state and progress of a transfer. Applications can set a listener and will get notified when progress or state changes.

For example, you can track the progress of an upload as the following:

 TransferObserver transfer = transferUtility.upload(bucket, key, file);
 transfer.setListener(new TransferListener() {
     public onProgressChanged(int id, long bytesCurrent, long bytesTotal) {
         // update progress bar
         progressBar.setProgress(bytesCurrent);
     }

     public void onStateChanged(int id, TransferState state) {
     }

     public void onError(int id, Exception ex) {
     }
 });
 

Note that callbacks of a listener will be invoked on the main thread.

Method Summary

Modifier and Type	Method and Description
void	cleanTransferListener() Cleans the transfer listener.
java.lang.String	getAbsoluteFilePath() Gets the absolute path of file to transfer.
java.lang.String	getBucket() Gets the bucket name of the record.
long	getBytesTotal() Gets the total bytes to transfer.
long	getBytesTransferred() Gets the bytes transferred currently.
int	getId() Gets the transfer id of the record.
java.lang.String	getKey() Gets the key of the record.
TransferState	getState() Gets the state of the transfer task.
void	refresh() Refresh fields in the TransferObserver from the running transfer task.
void	setTransferListener(TransferListener listener) Sets a listener used to receive notification when state or progress changes.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

refresh

public void refresh()

Refresh fields in the TransferObserver from the running transfer task. If TransferListener is set, then there's no need to call this method.

setTransferListener

public void setTransferListener(TransferListener listener)

Sets a listener used to receive notification when state or progress changes.

Note that callbacks of the listener will be invoked on the main thread.

Parameters:

listener - A TransferListener used to receive notification.

getId

public int getId()

Gets the transfer id of the record.

Returns:

The transfer id.

getBucket

public java.lang.String getBucket()

Gets the bucket name of the record.

Returns:

The bucket name of the record.

getKey

public java.lang.String getKey()

Gets the key of the record.

Returns:

The key of the record.

getBytesTotal

public long getBytesTotal()

Gets the total bytes to transfer.

Returns:

The total bytes of the transfer.

getAbsoluteFilePath

public java.lang.String getAbsoluteFilePath()

Gets the absolute path of file to transfer.

Returns:

The absolute path of the file transferred.

getBytesTransferred

public long getBytesTransferred()

Gets the bytes transferred currently.

Returns:

The bytes currently transferred.

getState

public TransferState getState()

Gets the state of the transfer task.

Returns:

The current state of the transfer.

cleanTransferListener

public void cleanTransferListener()

Cleans the transfer listener.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object