alluxio.master.journal

Class JournalUtils

java.lang.Object

alluxio.master.journal.JournalUtils

public final class JournalUtils
extends Object

Utility methods for working with the Alluxio journal.

Method Summary

Modifier and Type	Method and Description
static URI	getJournalLocation() Returns a URI for the configured location for the specified journal.
static void	handleJournalReplayFailure(org.slf4j.Logger logger, Throwable t, String format, Object... args) Logs a fatal error and exits the system if required.
static void	restoreFromCheckpoint(CheckpointInputStream input, List<? extends Checkpointed> components) Restores the given checkpointed components from a composite checkpoint.
static void	restoreJournalEntryCheckpoint(CheckpointInputStream input, Journaled journaled) Restores the given journaled object from the journal entries in the input stream.
static void	sinkAppend(java.util.function.Supplier<Set<JournalSink>> journalSinks, Journal.JournalEntry entry) Appends a journal entry to all the supplied journal sinks.
static void	sinkFlush(java.util.function.Supplier<Set<JournalSink>> journalSinks) Appends a flush to all the supplied journal sinks.
static void	writeJournalEntryCheckpoint(OutputStream output, JournalEntryIterable iterable) Writes a checkpoint of the entries in the given iterable.
static void	writeToCheckpoint(OutputStream output, List<? extends Checkpointed> components) Writes a composite checkpoint for the given checkpointed components.

Methods inherited from class java.lang.Object

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

Method Detail

getJournalLocation

public static URI getJournalLocation()

Returns a URI for the configured location for the specified journal.

Returns:

the journal location

writeJournalEntryCheckpoint

public static void writeJournalEntryCheckpoint(OutputStream output,
                                               JournalEntryIterable iterable)
                                        throws IOException,
                                               InterruptedException

Writes a checkpoint of the entries in the given iterable. This is the complement of restoreJournalEntryCheckpoint(CheckpointInputStream, Journaled).

Parameters:

output - the stream to write to

iterable - the iterable for fetching journal entries

Throws:

IOException

InterruptedException

restoreJournalEntryCheckpoint

public static void restoreJournalEntryCheckpoint(CheckpointInputStream input,
                                                 Journaled journaled)
                                          throws IOException

Restores the given journaled object from the journal entries in the input stream. This is the complement of writeJournalEntryCheckpoint(OutputStream, JournalEntryIterable).

Parameters:

input - the stream to read from

journaled - the object to restore

Throws:

IOException

writeToCheckpoint

public static void writeToCheckpoint(OutputStream output,
                                     List<? extends Checkpointed> components)
                              throws IOException,
                                     InterruptedException

Writes a composite checkpoint for the given checkpointed components. This is the complement of restoreFromCheckpoint(CheckpointInputStream, List).

Parameters:

output - the stream to write to

components - the components to checkpoint

Throws:

IOException

InterruptedException

restoreFromCheckpoint

public static void restoreFromCheckpoint(CheckpointInputStream input,
                                         List<? extends Checkpointed> components)
                                  throws IOException

Restores the given checkpointed components from a composite checkpoint. This is the complement of writeToCheckpoint(OutputStream, List).

Parameters:

input - the stream to read from

components - the components to restore

Throws:

IOException

handleJournalReplayFailure

public static void handleJournalReplayFailure(org.slf4j.Logger logger,
                                              Throwable t,
                                              String format,
                                              Object... args)
                                       throws RuntimeException

Logs a fatal error and exits the system if required.

Parameters:

logger - the logger to log to

t - the throwable causing the fatal error

format - the error message format string

args - args for the format string

Throws:

RuntimeException

sinkAppend

public static void sinkAppend(java.util.function.Supplier<Set<JournalSink>> journalSinks,
                              Journal.JournalEntry entry)

Appends a journal entry to all the supplied journal sinks.

Parameters:

journalSinks - a supplier of journal sinks

entry - the journal entry

sinkFlush

public static void sinkFlush(java.util.function.Supplier<Set<JournalSink>> journalSinks)

Appends a flush to all the supplied journal sinks.

Parameters:

journalSinks - a supplier of journal sinks