org.apache.hadoop.fs.s3a.commit

Class PutTracker

java.lang.Object

org.apache.hadoop.fs.s3a.commit.PutTracker

Direct Known Subclasses:

MagicCommitTracker

@InterfaceAudience.Private
public class PutTracker
extends Object

Multipart put tracker. Base class does nothing except declare that any MPU must complete in the close() operation.

Constructor Summary

Constructors

Constructor and Description
PutTracker(String destKey) Instantiate.

Method Summary

Modifier and Type	Method and Description
boolean	aboutToComplete(String uploadId, List<com.amazonaws.services.s3.model.PartETag> parts, long bytesWritten) Callback when the upload is is about to complete.
String	getDestKey() get the destination key.
boolean	initialize() Startup event.
boolean	outputImmediatelyVisible() Flag to indicate that output is not immediately visible after the stream is closed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PutTracker

public PutTracker(String destKey)

Instantiate.

Parameters:

destKey - destination key

Method Detail

initialize

public boolean initialize()
                   throws IOException

Startup event.

Returns:

true if the multipart should start immediately.

Throws:

IOException - any IO problem.

outputImmediatelyVisible

public boolean outputImmediatelyVisible()

Flag to indicate that output is not immediately visible after the stream is closed. Default: false.

Returns:

true if the output's visibility will be delayed.

aboutToComplete

public boolean aboutToComplete(String uploadId,
                               List<com.amazonaws.services.s3.model.PartETag> parts,
                               long bytesWritten)
                        throws IOException

Callback when the upload is is about to complete.

Parameters:

uploadId - Upload ID

parts - list of parts

bytesWritten - bytes written

Returns:

true if the commit is to be initiated immediately. False implies the output stream does not need to worry about what happens.

Throws:

IOException - I/O problem or validation failure.

getDestKey

public String getDestKey()

get the destination key. The default implementation returns the key passed in: there is no adjustment of the destination.

Returns:

the destination to use in PUT requests.

toString

public String toString()

Overrides:

toString in class Object