org.apache.hadoop.fs.s3a.commit.files

Class PersistentCommitData

java.lang.Object

org.apache.hadoop.fs.s3a.commit.files.PersistentCommitData

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PendingSet, SinglePendingCommit, SuccessData

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public abstract class PersistentCommitData
extends Object
implements Serializable

Class for single/multiple commit data structures.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION Supported version value: 2.

Constructor Summary

Constructors

Constructor and Description
PersistentCommitData()

Method Summary

Modifier and Type	Method and Description
abstract void	save(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, boolean overwrite) Save to a hadoop filesystem.
abstract byte[]	toBytes() Serialize to JSON and then to a byte array, after performing a preflight validation of the data to be saved.
abstract void	validate() Validate the data: those fields which must be non empty, must be set.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final int VERSION

Supported version value: 2. If this is changed the value of serialVersionUID will change, to avoid deserialization problems.

See Also:

Constant Field Values

Constructor Detail

PersistentCommitData

public PersistentCommitData()

Method Detail

validate

public abstract void validate()
                       throws ValidationFailure

Validate the data: those fields which must be non empty, must be set.

Throws:

ValidationFailure - if the data is invalid

toBytes

public abstract byte[] toBytes()
                        throws IOException

Serialize to JSON and then to a byte array, after performing a preflight validation of the data to be saved.

Returns:

the data in a persistable form.

Throws:

IOException - serialization problem or validation failure.

save

public abstract void save(org.apache.hadoop.fs.FileSystem fs,
                          org.apache.hadoop.fs.Path path,
                          boolean overwrite)
                   throws IOException

Save to a hadoop filesystem.

Parameters:

fs - filesystem

path - path

overwrite - should any existing file be overwritten

Throws:

IOException - IO exception