com.scaleoutsoftware.soss.client.map

Enum AvailabilityMode

java.lang.Object

java.lang.Enum<AvailabilityMode>

com.scaleoutsoftware.soss.client.map.AvailabilityMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AvailabilityMode>

public enum AvailabilityMode
extends java.lang.Enum<AvailabilityMode>

This enum controls whether the in-memory data grid should create object replicas of the named map contents on multiple hosts. Enabling object replication provides fault tolerance, i.e., it ensures that no data is lost in case of host failure at the expense of increased memory and network utilization. If replication is enabled (USE_REPLICAS), the number of replicas created is controlled by the max_replicas parameter in the ScaleOut StateServer configuration. The enum member is passed to NamedMap.setAvailabilityMode(AvailabilityMode) By default, replication is disabled (NO_REPLICAS).

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_REPLICAS Do not create replicas.
USE_REPLICAS Create replica(s) of the NamedMap contents.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USE_REPLICAS

public static final AvailabilityMode USE_REPLICAS

Create replica(s) of the NamedMap contents. The number of replicas created is controlled by the max_replicas parameter in the ScaleOut StateServer configuration.

NO_REPLICAS

public static final AvailabilityMode NO_REPLICAS

Do not create replicas. This provides best performance, but named map contents may be partially lost in case of the server failure. This is the default setting.

Method Detail

values

public static AvailabilityMode[] 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 (AvailabilityMode c : AvailabilityMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static AvailabilityMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null