Package org.apache.hadoop.fs

Interface MultipartUploader

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, IOStatisticsSource

All Known Implementing Classes:

AbstractMultipartUploader, FileSystemMultipartUploader

@Public
@Unstable
public interface MultipartUploader
extends java.io.Closeable, IOStatisticsSource

MultipartUploader is an interface for copying files multipart and across multiple nodes.

The interface extends IOStatisticsSource so that there is no need to cast an instance to see if is a source of statistics. However, implementations MAY return null for their actual statistics.

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<java.lang.Void>	abort(UploadHandle uploadId, Path filePath)	Aborts a multipart upload.
java.util.concurrent.CompletableFuture<java.lang.Integer>	abortUploadsUnderPath(Path path)	Best effort attempt to aborts multipart uploads under a path.
java.util.concurrent.CompletableFuture<PathHandle>	complete(UploadHandle uploadId, Path filePath, java.util.Map<java.lang.Integer,PartHandle> handles)	Complete a multipart upload.
java.util.concurrent.CompletableFuture<PartHandle>	putPart(UploadHandle uploadId, int partNumber, Path filePath, java.io.InputStream inputStream, long lengthInBytes)	Put part as part of a multipart upload.
java.util.concurrent.CompletableFuture<UploadHandle>	startUpload(Path filePath)	Initialize a multipart upload.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.apache.hadoop.fs.statistics.IOStatisticsSource

getIOStatistics

Method Detail

startUpload

java.util.concurrent.CompletableFuture<UploadHandle> startUpload(Path filePath)
                                                          throws java.io.IOException

Initialize a multipart upload.

Parameters:

filePath - Target path for upload.

Returns:

unique identifier associating part uploads.

Throws:

java.io.IOException - IO failure

putPart

java.util.concurrent.CompletableFuture<PartHandle> putPart(UploadHandle uploadId,
                                                           int partNumber,
                                                           Path filePath,
                                                           java.io.InputStream inputStream,
                                                           long lengthInBytes)
                                                    throws java.io.IOException

Put part as part of a multipart upload. It is possible to have parts uploaded in any order (or in parallel).

Parameters:

uploadId - Identifier from startUpload(Path).

partNumber - Index of the part relative to others.

filePath - Target path for upload (as startUpload(Path)).

inputStream - Data for this part. Implementations MUST close this stream after reading in the data.

lengthInBytes - Target length to read from the stream.

Returns:

unique PartHandle identifier for the uploaded part.

Throws:

java.io.IOException - IO failure

complete

java.util.concurrent.CompletableFuture<PathHandle> complete(UploadHandle uploadId,
                                                            Path filePath,
                                                            java.util.Map<java.lang.Integer,PartHandle> handles)
                                                     throws java.io.IOException

Complete a multipart upload.

Parameters:

uploadId - Identifier from startUpload(Path).

filePath - Target path for upload (as startUpload(Path).

handles - non-empty map of part number to part handle. from putPart(UploadHandle, int, Path, InputStream, long).

Returns:

unique PathHandle identifier for the uploaded file.

Throws:

java.io.IOException - IO failure

abort

java.util.concurrent.CompletableFuture<java.lang.Void> abort(UploadHandle uploadId,
                                                             Path filePath)
                                                      throws java.io.IOException

Aborts a multipart upload.

Parameters:

uploadId - Identifier from startUpload(Path).

filePath - Target path for upload (same as startUpload(Path).

Returns:

a future; the operation will have completed

Throws:

java.io.IOException - IO failure

abortUploadsUnderPath

java.util.concurrent.CompletableFuture<java.lang.Integer> abortUploadsUnderPath(Path path)
                                                                         throws java.io.IOException

Best effort attempt to aborts multipart uploads under a path. Not all implementations support this, and those which do may be vulnerable to eventually consistent listings of current uploads -some may be missed.

Parameters:

path - path to abort uploads under.

Returns:

a future to the number of entries aborted; -1 if aborting is unsupported

Throws:

java.io.IOException - IO failure