Did this page help you? Yes No Tell us about it...

Track Multipart Upload Progress

The high-level multipart upload API provides a listen interface, ProgressListener, to track the upload progress when uploading data using the TransferManager class. To use the event in your code, you must import the com.amazonaws.services.s3.model.ProgressEvent and com.amazonaws.services.s3.model.ProgressListener types.

Progress events occurs periodically and notify the listener that bytes have been transferred.

The following Java code sample demonstrates how you can subscribe to the ProgressEvent event and write a handler.

AWSCredentials myCredentials = new BasicAWSCredentials(myAccessKeyID, mySecretKey);

TransferManager tm = new TransferManager(myCredentials);        

PutObjectRequest request = new PutObjectRequest(
  		existingBucketName, keyName, new File(filePath));

// Subscribe to the event and provide event handler.        
request.setProgressListener(new ProgressListener() {
			public void progressChanged(ProgressEvent event) {
				System.out.println("Transferred bytes: " + 
						event.getBytesTransfered());
             }
});

Example

The following Java code uploads a file and uses the ProgressListener to track the upload progress. For instructions on how to create and test a working sample, see Testing the Java Code Examples

import java.io.File;

import com.amazonaws.AmazonClientException;
import com.amazonaws.auth.PropertiesCredentials;
import com.amazonaws.services.s3.model.ProgressEvent;
import com.amazonaws.services.s3.model.ProgressListener;
import com.amazonaws.services.s3.model.PutObjectRequest;
import com.amazonaws.services.s3.transfer.TransferManager;
import com.amazonaws.services.s3.transfer.Upload;

public class HighLevel_Java_UploadFile {

    public static void main(String[] args) throws Exception {
        String existingBucketName = "*** Provide bucket name ***";
        String keyName            = "*** Provide object key ***";
        String filePath           = "** Provide file to upload ***";  
        
        TransferManager tm = new TransferManager(new PropertiesCredentials(
        	HighLevel_Java_UploadFile.class.getResourceAsStream(
        			                      "AwsCredentials.properties")));        

        // For more advanced uploads, you can create a request object 
        // and supply additional request parameters (ex: progress listeners,
        // canned ACLs, etc)
        PutObjectRequest request = new PutObjectRequest(
        		existingBucketName, keyName, new File(filePath));
        
        // You can ask the upload for its progress, or you can 
        // add a ProgressListener to your request to receive notifications 
        // when bytes are transfered.
        request.setProgressListener(new ProgressListener() {
			public void progressChanged(ProgressEvent event) {
				System.out.println("Transferred bytes: " + 
						event.getBytesTransfered());
			}
		});

        // TransferManager processes all transfers asynchronously, 
        // so this call will return immediately.
        Upload upload = tm.upload(request);
        
        try {
        	// You can block and wait for the upload to finish
        	upload.waitForCompletion();
        } catch (AmazonClientException amazonClientException) {
        	System.out.println("Unable to upload file, upload aborted.");
        	amazonClientException.printStackTrace();
        }
    }
}

Document Conventions
Terms of Use

Did this page help you? Yes No Tell us about it...