alluxio.master.journal.checkpoint

Interface Checkpointed

All Known Subinterfaces:

BlockMaster, DelegatingJournaled, FileSystemMaster, InodeStore, Journaled, JournalMaster, Master, MetaMaster, MetricsMaster, NoopJournaled, RocksCheckpointed

All Known Implementing Classes:

AbstractMaster, CachingInodeStore, CheckpointedIdHashSet, CoreMaster, DefaultBlockMaster, DefaultBlockMasterContainerIdJournaled, DefaultFileSystemMaster, DefaultJournalMaster, DefaultMetaMaster, DefaultMetaMaster.State, DefaultMetricsMaster, HeapInodeStore, InodeCounter, InodeDirectoryIdGenerator, InodeTree, InodeTreePersistentState, JobMaster, JournaledGroup, JournaledJobMetaStore, MasterUfsManager, MountTable, MountTable.State, NoopMaster, PathProperties, PathProperties.State, PinnedInodeFileIds, ReplicationLimitedFileIds, RocksBlockMetaStore, RocksInodeStore, SingleEntryJournaled, SnapshotIdJournaled, ToBePersistedFileIds, TtlBucketList

public interface Checkpointed

Base class for Alluxio classes which can be written to and read from metadata checkpoints.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method and Description
CheckpointName	getCheckpointName()
void	restoreFromCheckpoint(CheckpointInputStream input) Restores state from a checkpoint.
default CompletableFuture<Void>	restoreFromCheckpoint(File directory, ExecutorService executorService) Restores state from a checkpoint asynchronously.
default CompletableFuture<Void>	writeToCheckpoint(File directory, ExecutorService executorService) Writes a checkpoint to the specified directory asynchronously using the provided executor.
void	writeToCheckpoint(OutputStream output) Writes a checkpoint of all state to the given output stream.

Field Detail

LOG

static final org.slf4j.Logger LOG

Method Detail

getCheckpointName

CheckpointName getCheckpointName()

Returns:

a name for this checkpointed class

writeToCheckpoint

default CompletableFuture<Void> writeToCheckpoint(File directory,
                                                  ExecutorService executorService)

Writes a checkpoint to the specified directory asynchronously using the provided executor.

Parameters:

directory - where the checkpoint will be written

executorService - to use when running tasks asynchronously

Returns:

a future that processes the computation

writeToCheckpoint

void writeToCheckpoint(OutputStream output)
                throws IOException,
                       InterruptedException

Writes a checkpoint of all state to the given output stream. Implementations should make an effort to throw InterruptedException if they get interrupted while running.

Parameters:

output - the output stream to write to

Throws:

IOException

InterruptedException

restoreFromCheckpoint

default CompletableFuture<Void> restoreFromCheckpoint(File directory,
                                                      ExecutorService executorService)

Restores state from a checkpoint asynchronously.

Parameters:

directory - where the checkpoint will be located

executorService - to use when running asynchronous tasks

Returns:

a future to track the progress

restoreFromCheckpoint

void restoreFromCheckpoint(CheckpointInputStream input)
                    throws IOException

Restores state from a checkpoint.

Parameters:

input - an input stream with checkpoint data

Throws:

IOException