alluxio.master.journal

Interface Journaled

All Superinterfaces:

Checkpointed, JournalEntryIterable

All Known Subinterfaces:

BlockMaster, DelegatingJournaled, FileSystemMaster, Master, MetaMaster, MetricsMaster, NoopJournaled, TableMaster

All Known Implementing Classes:

AbstractMaster, ActiveSyncManager, AlluxioCatalog, CoreMaster, Database, DefaultBlockMaster, DefaultFileSystemMaster, DefaultMetaMaster, DefaultMetaMaster.State, DefaultMetricsMaster, DefaultTableMaster, InodeDirectoryIdGenerator, InodeTree, InodeTreePersistentState, JobMaster, JournaledGroup, MasterUfsManager, MountTable, MountTable.State, NoopMaster, PathProperties, PathProperties.State, TransformManager

public interface Journaled
extends Checkpointed, JournalEntryIterable

Interface for classes with journaled state. This class provides a default checkpointing implementation which writes checkpoints based on the journal entries from JournalEntryIterable.getJournalEntryIterator().

Method Summary

Modifier and Type	Method and Description
default void	applyAndJournal(java.util.function.Supplier<JournalContext> context, Journal.JournalEntry entry) Applies and journals a journal entry.
boolean	processJournalEntry(Journal.JournalEntry entry) Attempts to apply a journal entry.
void	resetState() Resets the object's journaled state.
default void	restoreFromCheckpoint(CheckpointInputStream input) Restores state from a checkpoint.
default void	writeToCheckpoint(OutputStream output) Writes a checkpoint of all state to the given output stream.

Methods inherited from interface alluxio.master.journal.checkpoint.Checkpointed

getCheckpointName

Methods inherited from interface alluxio.master.journal.JournalEntryIterable

getJournalEntryIterator

Method Detail

processJournalEntry

boolean processJournalEntry(Journal.JournalEntry entry)

Attempts to apply a journal entry.

Parameters:

entry - the entry to apply

Returns:

whether the entry type is supported by this journaled object

resetState

void resetState()

Resets the object's journaled state.

applyAndJournal

default void applyAndJournal(java.util.function.Supplier<JournalContext> context,
                             Journal.JournalEntry entry)

Applies and journals a journal entry. All journal appends should go through this method.

Parameters:

context - journal context

entry - the entry to apply and journal

writeToCheckpoint

default void writeToCheckpoint(OutputStream output)
                        throws IOException,
                               InterruptedException

Description copied from interface: Checkpointed

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.

Specified by:

writeToCheckpoint in interface Checkpointed

Parameters:

output - the output stream to write to

Throws:

IOException

InterruptedException

restoreFromCheckpoint

default void restoreFromCheckpoint(CheckpointInputStream input)
                            throws IOException

Description copied from interface: Checkpointed

Restores state from a checkpoint.

Specified by:

restoreFromCheckpoint in interface Checkpointed

Parameters:

input - an input stream with checkpoint data

Throws:

IOException