Package org.apache.hadoop.fs.impl

Class AbstractMultipartUploader

java.lang.Object

org.apache.hadoop.fs.impl.AbstractMultipartUploader

All Implemented Interfaces:

Closeable, AutoCloseable, MultipartUploader, IOStatisticsSource

Direct Known Subclasses:

FileSystemMultipartUploader

public abstract class AbstractMultipartUploader
extends Object
implements MultipartUploader

Standard base class for Multipart Uploaders.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMultipartUploader(Path basePath)	Instantiate.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Integer>	abortUploadsUnderPath(Path path)	Best effort attempt to aborts multipart uploads under a path.
protected void	checkPartHandles(Map<Integer,PartHandle> partHandles)	Utility method to validate partHandles.
protected void	checkPath(Path path)	Validate a path.
protected void	checkPutArguments(Path filePath, InputStream inputStream, int partNumber, UploadHandle uploadId, long lengthInBytes)	Check all the arguments to the MultipartUploader.putPart(UploadHandle, int, boolean, Path, InputStream, long) operation.
protected void	checkUploadId(byte[] uploadId)	Utility method to validate uploadIDs.
void	close()	Perform any cleanup.
protected Path	getBasePath()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getIOStatistics

Methods inherited from interface org.apache.hadoop.fs.MultipartUploader

abort, complete, putPart, startUpload

Constructor Details

AbstractMultipartUploader

protected AbstractMultipartUploader(Path basePath)

Instantiate.

Parameters:

basePath - base path

Method Details

close

public void close()
           throws IOException

Perform any cleanup. The upload is not required to support any operations after this.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - problems on close.

getBasePath

protected Path getBasePath()

checkPath

protected void checkPath(Path path)

Validate a path.

Parameters:

path - path to check.

checkUploadId

protected void checkUploadId(byte[] uploadId)
                      throws IllegalArgumentException

Utility method to validate uploadIDs.

Parameters:

uploadId - Upload ID

Throws:

IllegalArgumentException - invalid ID

checkPartHandles

protected void checkPartHandles(Map<Integer,PartHandle> partHandles)

Utility method to validate partHandles.

Parameters:

partHandles - handles

Throws:

IllegalArgumentException - if the parts are invalid

checkPutArguments

protected void checkPutArguments(Path filePath,
 InputStream inputStream,
 int partNumber,
 UploadHandle uploadId,
 long lengthInBytes)
                          throws IllegalArgumentException

Check all the arguments to the MultipartUploader.putPart(UploadHandle, int, boolean, Path, InputStream, long) operation.

Parameters:

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

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

partNumber - Index of the part relative to others.

uploadId - Identifier from MultipartUploader.startUpload(Path).

lengthInBytes - Target length to read from the stream.

Throws:

IllegalArgumentException - invalid argument

abortUploadsUnderPath

public CompletableFuture<Integer> abortUploadsUnderPath(Path path)
                                                 throws 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..

Specified by:

abortUploadsUnderPath in interface MultipartUploader

Parameters:

path - path to abort uploads under.

Returns:

a future to -1.

Throws:

IOException - raised on errors performing I/O.