com.scaleout.client.caching

Enum GeoServerReadMode

java.lang.Object

java.lang.Enum<GeoServerReadMode>

com.scaleout.client.caching.GeoServerReadMode

All Implemented Interfaces:

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

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

The GeoServerReadMode is an enum used to control GeoServer "pull" replication during Read operations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LocalAllowStaleData Indicates that the read operation can return the object value from the proxy held in the local ScaleOut store.
LocalThrowOnStaleData Indicates that the read operation can return the object value from the proxy held in the local ScaleOut store.
None Default.
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).

Method Summary

Modifier and Type	Method and Description
static GeoServerReadMode	fromString(java.lang.String value) Retrieve a GeoServerReadMode enum from a string.
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

Default. Indicates that GeoServer replication is not used with this cache.

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).

LocalThrowOnStaleData

public static final GeoServerReadMode LocalThrowOnStaleData

Indicates that the read operation can return the object value from the proxy held in the local ScaleOut store. If the local proxy value is stale (which can occur if the remote store is unreachable) then the Read call will throw a StaleDataException.

LocalAllowStaleData

public static final GeoServerReadMode LocalAllowStaleData

Indicates that the read operation can return the object value from the proxy held in the local ScaleOut store. No exception will be thrown if the local proxy value is stale (which can occur if the remote store is unreachable).

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

fromString

public static GeoServerReadMode fromString(java.lang.String value)

Retrieve a GeoServerReadMode enum from a string. Accepted values: Constants.GEOSERVER_READ_MODE_NONE Constants.GEOSERVER_READ_MODE_REMOTE Constants.GEOSERVER_READ_MODE_LOCAL_ALLOW_STALE Constants.GEOSERVER_READ_MODE_LOCAL_THROW_STALE

Parameters:

value - Constants.GEOSERVER_READ_MODE_NONE, Constants.GEOSERVER_READ_MODE_REMOTE, Constants.GEOSERVER_READ_MODE_LOCAL_ALLOW_STALE, or Constants.GEOSERVER_READ_MODE_LOCAL_THROW_STALE.

Returns:

a GeoServerReadMode that maps from the parameter string value.