org.apache.hadoop.fs.s3a.commit

Class CommitOperations.CommitContext

java.lang.Object

org.apache.hadoop.fs.s3a.commit.CommitOperations.CommitContext

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

CommitOperations

public final class CommitOperations.CommitContext
extends Object
implements Closeable

Commit context. It is used to manage the final commit sequence where files become visible. It contains a BulkOperationState field, which, if there is a metastore, will be requested from the store so that it can track multiple creation operations within the same overall operation. This will be null if there is no metastore, or the store chooses not to provide one. This can only be created through CommitOperations.initiateCommitOperation(Path). Once the commit operation has completed, it must be closed. It must not be reused.

Method Summary

Modifier and Type	Method and Description
void	abortMultipartCommit(String destKey, String uploadId) See CommitOperations.abortMultipartCommit(String, String)..
void	abortSingleCommit(SinglePendingCommit commit) See CommitOperations.abortSingleCommit(SinglePendingCommit).
void	close()
CommitOperations.MaybeIOE	commit(SinglePendingCommit commit, String origin) Commit a single pending commit; exceptions are caught and converted to an outcome.
void	commitOrFail(SinglePendingCommit commit) Commit the operation, throwing an exception on any failure.
void	revertCommit(SinglePendingCommit commit) See CommitOperations.revertCommit(SinglePendingCommit, BulkOperationState).
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

commitOrFail

public void commitOrFail(SinglePendingCommit commit)
                  throws IOException

Commit the operation, throwing an exception on any failure. See CommitOperations.commitOrFail(SinglePendingCommit, BulkOperationState).

Parameters:

commit - commit to execute

Throws:

IOException - on a failure

commit

public CommitOperations.MaybeIOE commit(SinglePendingCommit commit,
                                        String origin)

Commit a single pending commit; exceptions are caught and converted to an outcome. See CommitOperations.commit(SinglePendingCommit, String, BulkOperationState).

Parameters:

commit - entry to commit

origin - origin path/string for outcome text

Returns:

the outcome

abortSingleCommit

public void abortSingleCommit(SinglePendingCommit commit)
                       throws IOException

See CommitOperations.abortSingleCommit(SinglePendingCommit).

Parameters:

commit - pending commit to abort

Throws:

FileNotFoundException - if the abort ID is unknown

IOException - on any failure

revertCommit

public void revertCommit(SinglePendingCommit commit)
                  throws IOException

See CommitOperations.revertCommit(SinglePendingCommit, BulkOperationState).

Parameters:

commit - pending commit

Throws:

IOException - failure

abortMultipartCommit

public void abortMultipartCommit(String destKey,
                                 String uploadId)
                          throws IOException

See CommitOperations.abortMultipartCommit(String, String)..

Parameters:

destKey - destination key

uploadId - upload to cancel

Throws:

FileNotFoundException - if the abort ID is unknown

IOException - on any failure

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object