com.scaleoutsoftware.soss.client

Enum GeoServerReadMode

java.lang.Object

java.lang.Enum<GeoServerReadMode>

com.scaleoutsoftware.soss.client.GeoServerReadMode

All Implemented Interfaces:

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

public enum GeoServerReadMode
extends java.lang.Enum<GeoServerReadMode>
implements java.io.Serializable

Enum contains type of read used when accessing a local object with its master in remote store.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LocalDoNotThrowOnStaleData Indicates that the retrieve operation can return the object value from the proxy held in the local ScaleOut store if it should exist and no exception will be thrown if the local proxy value is stale.
LocalThrowOnStaleData Indicates that the retrieve operation can return the object's value from the local proxy if it should exist.
None Indicates that GeoServer replication is not used with this cache.
Remote Indicates that the caller has configured GeoServer for "pull" replication and wants to force the local store to read the object from the remote store (rather than reading from a local proxy of the object if it should exist).

Method Summary

Modifier and Type	Method and Description
static GeoServerReadMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GeoServerReadMode[]	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

None

public static final GeoServerReadMode None

Indicates that GeoServer replication is not used with this cache. (This is the default value.) Note that the effect of this option is identical to LocalDoNotThrowOnStaleData.

Remote

public static final GeoServerReadMode Remote

Indicates that the caller has configured GeoServer for "pull" replication and wants to force the local store to read the object from the remote store (rather than reading from a local proxy of the object if it should exist). This option guarantees that the caller will always retrieve the latest value for the object even if a WAN request is required.

LocalThrowOnStaleData

public static final GeoServerReadMode LocalThrowOnStaleData

Indicates that the retrieve operation can return the object's value from the local proxy if it should exist. However, if the local proxy value is stale (which can occur if one of the remotes store has a WAN access error), the retrieve/getMetadata call will throw a StaleDataException.

LocalDoNotThrowOnStaleData

public static final GeoServerReadMode LocalDoNotThrowOnStaleData

Indicates that the retrieve operation can return the object value from the proxy held in the local ScaleOut store if it should exist and no exception will be thrown if the local proxy value is stale.

Method Detail

values

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

Returns:

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

valueOf

public static GeoServerReadMode 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