alluxio.master.journal

Interface DelegatingJournaled

All Superinterfaces:

Checkpointed, Journaled, JournalEntryIterable

All Known Implementing Classes:

DefaultFileSystemMaster, DefaultTableMaster, InodeTree, MasterUfsManager, MountTable, PathProperties, TransformManager

public interface DelegatingJournaled
extends Journaled

Convenient interface for classes which delegate their journaling methods to another journaled object.

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.
default CheckpointName	getCheckpointName()
Journaled	getDelegate()
default Iterator<Journal.JournalEntry>	getJournalEntryIterator()
default boolean	processJournalEntry(Journal.JournalEntry entry) Attempts to apply a journal entry.
default 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.

Method Detail

processJournalEntry

default boolean processJournalEntry(Journal.JournalEntry entry)

Description copied from interface: Journaled

Attempts to apply a journal entry.

Specified by:

processJournalEntry in interface Journaled

Parameters:

entry - the entry to apply

Returns:

whether the entry type is supported by this journaled object

resetState

default void resetState()

Description copied from interface: Journaled

Resets the object's journaled state.

Specified by:

resetState in interface Journaled

applyAndJournal

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

Description copied from interface: Journaled

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

Specified by:

applyAndJournal in interface Journaled

Parameters:

context - journal context

entry - the entry to apply and journal

getCheckpointName

default CheckpointName getCheckpointName()

Specified by:

getCheckpointName in interface Checkpointed

Returns:

a name for this checkpointed class

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

Specified by:

writeToCheckpoint in interface Journaled

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

Specified by:

restoreFromCheckpoint in interface Journaled

Parameters:

input - an input stream with checkpoint data

Throws:

IOException

getJournalEntryIterator

default Iterator<Journal.JournalEntry> getJournalEntryIterator()

Specified by:

getJournalEntryIterator in interface JournalEntryIterable

Returns:

an Iterator that iterates all the journal entries

getDelegate

Journaled getDelegate()

Returns:

the object to delegate to