io.atomix.copycat.server.storage.compaction

Enum Compaction.Mode

java.lang.Object

java.lang.Enum<Compaction.Mode>

io.atomix.copycat.server.storage.compaction.Compaction.Mode

All Implemented Interfaces:

Serializable, Comparable<Compaction.Mode>

Enclosing class:

Compaction

public static enum Compaction.Mode
extends Enum<Compaction.Mode>

Constants for specifying entry compaction modes.

Author:

Jordan Halterman

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT The DEFAULT compaction mode is a special compaction mode which indicates that the configured default compaction mode should be applied to the command.
EXPIRING The EXPIRING compaction mode is an alias of the SEQUENTIAL mode.
FULL The FULL compaction mode retains the command in the log until it has been stored and applied on all servers in the cluster.
QUORUM The QUORUM compaction mode retains the command in the log until it has been stored and applied on a majority of servers in the cluster.
RELEASE The RELEASE compaction mode retains the command in the log until it has been stored and applied on a majority of servers in the cluster and is released.
SEQUENTIAL The SEQUENTIAL compaction mode retains the command in the log until it has been stored and applied on all servers in the cluster.
SNAPSHOT The SNAPSHOT compaction mode indicates commands for which resulting state is stored in state machine snapshots.
TOMBSTONE The TOMBSTONE compaction mode is an alias of the SEQUENTIAL mode.
UNKNOWN The UNKNOWN compaction mode is a special compaction mode which retains entries beyond the snapshot index, requires that entries be stored on all servers, and removes entries from the log sequentially.

Method Summary

Modifier and Type	Method and Description
static Compaction.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Compaction.Mode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final Compaction.Mode DEFAULT

The DEFAULT compaction mode is a special compaction mode which indicates that the configured default compaction mode should be applied to the command.

UNKNOWN

public static final Compaction.Mode UNKNOWN

The UNKNOWN compaction mode is a special compaction mode which retains entries beyond the snapshot index, requires that entries be stored on all servers, and removes entries from the log sequentially.

SNAPSHOT

public static final Compaction.Mode SNAPSHOT

The SNAPSHOT compaction mode indicates commands for which resulting state is stored in state machine snapshots. Snapshot commands will be stored in the Raft log only until a snapshot of the state machine state has been written to disk, at which time they'll be removed from the log. Note that snapshot commands can still safely trigger state machine events. Commands that result in the publishing of events will be persisted in the log until related events have been received by all clients even if a snapshot of the state machine has since been stored.

RELEASE

public static final Compaction.Mode RELEASE

The RELEASE compaction mode retains the command in the log until it has been stored and applied on a majority of servers in the cluster and is released.

QUORUM

public static final Compaction.Mode QUORUM

The QUORUM compaction mode retains the command in the log until it has been stored and applied on a majority of servers in the cluster. Once the commit has been applied to the state machine and released, it may be removed during minor or major compaction.

FULL

public static final Compaction.Mode FULL

The FULL compaction mode retains the command in the log until it has been stored and applied on all servers in the cluster. Once the commit has been applied to a state machine and closed it may be removed from the log during minor or major compaction.

SEQUENTIAL

public static final Compaction.Mode SEQUENTIAL

The SEQUENTIAL compaction mode retains the command in the log until it has been stored and applied on all servers in the cluster. Once the commit has been applied to a state machine and closed, it may be removed from the log only during major compaction to ensure that all prior completed commits are removed first.

EXPIRING

public static final Compaction.Mode EXPIRING

The EXPIRING compaction mode is an alias of the SEQUENTIAL mode. Expiring entries are retained in the log until stored and applied on all servers. Once the commit has been applied to a state machine and closed, it may be removed from the log only during major compaction to ensure that all prior completed commits are removed first.

TOMBSTONE

public static final Compaction.Mode TOMBSTONE

The TOMBSTONE compaction mode is an alias of the SEQUENTIAL mode. Tombstone entries are retained in the log until stored and applied on all servers. Once the commit has been applied to a state machine and closed, it may be removed from the log only during major compaction to ensure that all prior completed commits are removed first.

Method Detail

values

public static Compaction.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Compaction.Mode c : Compaction.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Compaction.Mode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null