LargeFileUploader (object-client 3.1.1 API)

java.lang.Object
- com.emc.object.s3.LargeFileUploader

All Implemented Interfaces:

ProgressListener, java.lang.Runnable
```
public class LargeFileUploader
extends java.lang.Object
implements java.lang.Runnable, ProgressListener
```
Convenience class to facilitate multipart upload for large files. This class will split the file and upload it in parts, transferring several parts simultaneously to maximize efficiency.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class LargeFileUploader.PutObjectTask

Nested Classes
Modifier and Type	Class and Description
`protected class`	`LargeFileUploader.PutObjectTask`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MPU_THRESHOLD`
`static long`	`DEFAULT_PART_SIZE`
`static int`	`DEFAULT_THREADS`
`static int`	`MAX_PARTS`
`static long`	`MIN_PART_SIZE`

Constructor Summary

Constructors
Constructor and Description
`LargeFileUploader(S3Client s3Client, java.lang.String bucket, java.lang.String key, java.io.File file)` Creates a new LargeFileUpload instance using the specified `s3Client` to upload `file` to `bucket/key`.
`LargeFileUploader(S3Client s3Client, java.lang.String bucket, java.lang.String key, java.io.InputStream stream, long size)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`configure()` This method should be idempotent
`void`	`doByteRangeUpload()`
`void`	`doMultipartUpload()`
`void`	`doSinglePut()`
`AccessControlList`	`getAcl()`
`java.lang.String`	`getBucket()`
`long`	`getBytesTransferred()`
`CannedAcl`	`getCannedAcl()`
`java.lang.String`	`getETag()`
`java.util.concurrent.ExecutorService`	`getExecutorService()`
`java.io.File`	`getFile()`
`long`	`getFullSize()`
`java.lang.String`	`getKey()`
`long`	`getMpuThreshold()`
`S3ObjectMetadata`	`getObjectMetadata()`
`long`	`getPartSize()`
`ProgressListener`	`getProgressListener()`
`S3Client`	`getS3Client()`
`java.io.InputStream`	`getStream()`
`int`	`getThreads()`
`boolean`	`isCloseStream()`
`void`	`progress(long completed, long total)` Provides feedback on the number of bytes completed and the total number of bytes to transfer.
`void`	`run()`
`void`	`setAcl(AccessControlList acl)`
`void`	`setCannedAcl(CannedAcl cannedAcl)`
`void`	`setCloseStream(boolean closeStream)`
`void`	`setExecutorService(java.util.concurrent.ExecutorService executorService)` Allows for providing a custom thread executor (i.e.
`void`	`setMpuThreshold(long mpuThreshold)` Sets the threshold above which an MPU operation is used to upload, and below which a single-PUT is used.
`void`	`setObjectMetadata(S3ObjectMetadata objectMetadata)`
`void`	`setPartSize(long partSize)` Sets the size of each part to upload.
`void`	`setProgressListener(ProgressListener progressListener)`
`void`	`setThreads(int threads)` Sets the number of threads to use for transferring parts.
`void`	`transferred(long size)` Reports that some bytes have been transferred.
`void`	`upload()` This method will automatically choose between MPU and single-PUT operations based on a configured threshold.
`LargeFileUploader`	`withAcl(AccessControlList acl)`
`LargeFileUploader`	`withCannedAcl(CannedAcl cannedAcl)`
`LargeFileUploader`	`withCloseStream(boolean closeStream)`
`LargeFileUploader`	`withExecutorService(java.util.concurrent.ExecutorService executorService)`
`LargeFileUploader`	`withMpuThreshold(long mpuThreshold)`
`LargeFileUploader`	`withObjectMetadata(S3ObjectMetadata objectMetadata)`
`LargeFileUploader`	`withPartSize(java.lang.Long partSize)`
`LargeFileUploader`	`withProgressListener(ProgressListener progressListener)`
`LargeFileUploader`	`withThreads(int threads)`

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

- Field Detail
  - DEFAULT_THREADS
```
public static final int DEFAULT_THREADS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MPU_THRESHOLD
```
public static final int DEFAULT_MPU_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - MIN_PART_SIZE
```
public static final long MIN_PART_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PART_SIZE
```
public static final long DEFAULT_PART_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_PARTS
```
public static final int MAX_PARTS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LargeFileUploader
```
public LargeFileUploader(S3Client s3Client,
                         java.lang.String bucket,
                         java.lang.String key,
                         java.io.File file)
```
    Creates a new LargeFileUpload instance using the specified s3Client to upload file to bucket/key.
  - LargeFileUploader
```
public LargeFileUploader(S3Client s3Client,
                         java.lang.String bucket,
                         java.lang.String key,
                         java.io.InputStream stream,
                         long size)
```
- Method Detail
  - progress
```
public void progress(long completed,
                     long total)
```
    Description copied from interface: ProgressListener
    
    Provides feedback on the number of bytes completed and the total number of bytes to transfer.
    
    Specified by:
    
    progress in interface ProgressListener
    
    Parameters:
    
    completed - bytes completely transferred
    
    total - total number of bytes to transfer
  - transferred
```
public void transferred(long size)
```
    Description copied from interface: ProgressListener
    
    Reports that some bytes have been transferred. This is a raw method that will be called frequently and can be used for computing current transfer rate. Note that if data is retried, the sum of this method's events may be more than the total object size. For reporting on percent complete, use the progress method instead.
    
    Specified by:
    
    transferred in interface ProgressListener
    
    Parameters:
    
    size - number of bytes transferred
  - run
```
public void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
  - upload
```
public void upload()
```
    This method will automatically choose between MPU and single-PUT operations based on a configured threshold. Note the default threshold is DEFAULT_MPU_THRESHOLD. Also note that the defaults in this class are optimized for high-speed LAN connectivity. When operating over a WAN or a slower connection, you should reduce the MPU threshold and part size proportionately.
  - doSinglePut
```
public void doSinglePut()
```
  - doMultipartUpload
```
public void doMultipartUpload()
```
  - doByteRangeUpload
```
public void doByteRangeUpload()
```
  - configure
```
protected void configure()
```
    This method should be idempotent
  - getS3Client
```
public S3Client getS3Client()
```
  - getBucket
```
public java.lang.String getBucket()
```
  - getKey
```
public java.lang.String getKey()
```
  - getFile
```
public java.io.File getFile()
```
  - getStream
```
public java.io.InputStream getStream()
```
  - getFullSize
```
public long getFullSize()
```
  - getBytesTransferred
```
public long getBytesTransferred()
```
  - getETag
```
public java.lang.String getETag()
```
  - getObjectMetadata
```
public S3ObjectMetadata getObjectMetadata()
```
  - setObjectMetadata
```
public void setObjectMetadata(S3ObjectMetadata objectMetadata)
```
  - getAcl
```
public AccessControlList getAcl()
```
  - setAcl
```
public void setAcl(AccessControlList acl)
```
  - getCannedAcl
```
public CannedAcl getCannedAcl()
```
  - setCannedAcl
```
public void setCannedAcl(CannedAcl cannedAcl)
```
  - isCloseStream
```
public boolean isCloseStream()
```
  - setCloseStream
```
public void setCloseStream(boolean closeStream)
```
  - getMpuThreshold
```
public long getMpuThreshold()
```
  - setMpuThreshold
```
public void setMpuThreshold(long mpuThreshold)
```
    Sets the threshold above which an MPU operation is used to upload, and below which a single-PUT is used. This only applies when using the upload() method. Note the default threshold is DEFAULT_MPU_THRESHOLD
  - getPartSize
```
public long getPartSize()
```
  - setPartSize
```
public void setPartSize(long partSize)
```
    Sets the size of each part to upload. Note the default part size is DEFAULT_PART_SIZE and MIN_PART_SIZE is the minimum part size. Note also there is a maximum of 10,000 parts, and the part size will be increased automatically if necessary.
  - getThreads
```
public int getThreads()
```
  - setThreads
```
public void setThreads(int threads)
```
    Sets the number of threads to use for transferring parts. thread parts will be transferred in parallel. Default is 6
  - getExecutorService
```
public java.util.concurrent.ExecutorService getExecutorService()
```
  - setExecutorService
```
public void setExecutorService(java.util.concurrent.ExecutorService executorService)
```
    Allows for providing a custom thread executor (i.e. for custom thread factories). Note that if you set a custom executor service, the threads property will be ignored.
  - getProgressListener
```
public ProgressListener getProgressListener()
```
  - setProgressListener
```
public void setProgressListener(ProgressListener progressListener)
```
  - withObjectMetadata
```
public LargeFileUploader withObjectMetadata(S3ObjectMetadata objectMetadata)
```
  - withAcl
```
public LargeFileUploader withAcl(AccessControlList acl)
```
  - withCannedAcl
```
public LargeFileUploader withCannedAcl(CannedAcl cannedAcl)
```
  - withCloseStream
```
public LargeFileUploader withCloseStream(boolean closeStream)
```
  - withMpuThreshold
```
public LargeFileUploader withMpuThreshold(long mpuThreshold)
```
  - withPartSize
```
public LargeFileUploader withPartSize(java.lang.Long partSize)
```
  - withThreads
```
public LargeFileUploader withThreads(int threads)
```
  - withExecutorService
```
public LargeFileUploader withExecutorService(java.util.concurrent.ExecutorService executorService)
```
  - withProgressListener
```
public LargeFileUploader withProgressListener(ProgressListener progressListener)
```

Class LargeFileUploader

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_THREADS

DEFAULT_MPU_THRESHOLD

MIN_PART_SIZE

DEFAULT_PART_SIZE

MAX_PARTS

Constructor Detail

LargeFileUploader

LargeFileUploader

Method Detail

progress

transferred

run

upload

doSinglePut

doMultipartUpload

doByteRangeUpload

configure

getS3Client

getBucket

getKey

getFile

getStream

getFullSize

getBytesTransferred

getETag

getObjectMetadata

setObjectMetadata

getAcl

setAcl

getCannedAcl

setCannedAcl

isCloseStream

setCloseStream

getMpuThreshold

setMpuThreshold

getPartSize

setPartSize

getThreads

setThreads

getExecutorService

setExecutorService

getProgressListener

setProgressListener

withObjectMetadata

withAcl

withCannedAcl

withCloseStream

withMpuThreshold

withPartSize

withThreads

withExecutorService

withProgressListener