com.scaleoutsoftware.soss.client.da

Enum ReadOptions

java.lang.Object

java.lang.Enum<ReadOptions>

com.scaleoutsoftware.soss.client.da.ReadOptions

All Implemented Interfaces:

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

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

Specifies flags that control the operation of the Read method.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AsyncReadThrough If set, indicates that the asynchronous read-through should be initiated if object does not exist.
HServerRequest Denotes a keylist read (HServer).
LockObject If set, indicates that the Read method should attempt to acquire a StateServer lock when reading the object.
ObjectMayBeLocked If set, indicates that the situation where the underlying object is already locked by another StateServer client is anticipated by the caller, and no ObjectLockedException will be thrown if a lock cannot be acquried.
ObjectMayNotExist If set, indicates that the situation where the underlying object does not exist is anticipated by the caller, and no ObjectNotFoundException will be thrown if the object is not found on the StateServer.
ReadDigitalTwinStats Denotes a special read request which will read a local digital twin stats object.
ReadPartition Denotes a special read which is used to retrieve partition contents (hServer).
ReadRemoteObject If set, an attempt would be made to read through from remote store in case of object not found in local store.
ReadRemoteSyncOnly If this read is to a proxy object, a synchronous read must be performed (v200)
ReadThroughPoll If set, indicates that the caller is doing the read to poll the StateServer in order find out when a pending read-through operation has been completed by another client
ReturnCachedObjectIfValid If set, indicates that the caller is prepared to query IsCachedObjectValid on successful return to determine if StateServer determined that the object corresponding to the byte stream written to StateServer is unchanged.
ReturnClientCacheWithAsyncRefresh Denotes a read request that will immediately return the client cache value (if present) and continue the read request asynchronously.
SyncReadThrough If set, indicates that the read-through is initiated on the host by returning null object.

Method Summary

Modifier and Type	Method and Description
static java.util.Set<ReadOptions>	getAsyncReadThroughSet() Return a cached, read-only Set of ReadOptions containing just the AsyncReadThrough flag.
static java.util.Set<ReadOptions>	getEmptySet() Return a cached, read-only Set of ReadOptions with no ReadOptions set.
static java.util.Set<ReadOptions>	getLockObjectSet() Return a cached, read-only Set of ReadOptions containing just the LockObject flag.
static java.util.Set<ReadOptions>	getObjectMayNotExistSet() Return a cached, read-only Set of ReadOptions containing just the ObjectMayNotExist flag.
static java.util.Set<ReadOptions>	getReturnCachedObjectIfValidSet() Return a cached, read-only Set of ReadOptions containing just the ReturnCachedObjectIfValid flag.
static java.util.Set<ReadOptions>	getSyncReadThroughSet() Return a cached, read-only Set of ReadOptions containing just the SyncReadThrough flag.
static ReadOptions	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ReadOptions[]	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

LockObject

public static final ReadOptions LockObject

If set, indicates that the Read method should attempt to acquire a StateServer lock when reading the object.

ObjectMayBeLocked

public static final ReadOptions ObjectMayBeLocked

If set, indicates that the situation where the underlying object is already locked by another StateServer client is anticipated by the caller, and no ObjectLockedException will be thrown if a lock cannot be acquried. Instead the StateServerResult value ObjectAlreadyLocked will be returned.

ObjectMayNotExist

public static final ReadOptions ObjectMayNotExist

If set, indicates that the situation where the underlying object does not exist is anticipated by the caller, and no ObjectNotFoundException will be thrown if the object is not found on the StateServer. Instead the StateServerResult value ObjectNotFound will be returned from the method call.

ReturnCachedObjectIfValid

public static final ReadOptions ReturnCachedObjectIfValid

If set, indicates that the caller is prepared to query IsCachedObjectValid on successful return to determine if StateServer determined that the object corresponding to the byte stream written to StateServer is unchanged. In that case, no byte stream will be returned from the Read operation, just the original cached object. If this flag is not set (the default), a byte stream will always be returned from a StateServer Read operation.

SyncReadThrough

public static final ReadOptions SyncReadThrough

If set, indicates that the read-through is initiated on the host by returning null object. If other host tries to read the same object while RT is in progress, it will get OBJECT_READING error. Setting it means that backing store is accessible on given host.

AsyncReadThrough

public static final ReadOptions AsyncReadThrough

If set, indicates that the asynchronous read-through should be initiated if object does not exist. Calling host will get back OBJECT_READING. Setting it means that backing store is NOT accessible on given host.

ReadThroughPoll

public static final ReadOptions ReadThroughPoll

If set, indicates that the caller is doing the read to poll the StateServer in order find out when a pending read-through operation has been completed by another client

ReadRemoteObject

public static final ReadOptions ReadRemoteObject

If set, an attempt would be made to read through from remote store in case of object not found in local store.

ReadRemoteSyncOnly

public static final ReadOptions ReadRemoteSyncOnly

If this read is to a proxy object, a synchronous read must be performed (v200)

ReadPartition

public static final ReadOptions ReadPartition

Denotes a special read which is used to retrieve partition contents (hServer).

HServerRequest

public static final ReadOptions HServerRequest

Denotes a keylist read (HServer).

ReturnClientCacheWithAsyncRefresh

public static final ReadOptions ReturnClientCacheWithAsyncRefresh

Denotes a read request that will immediately return the client cache value (if present) and continue the read request asynchronously.

ReadDigitalTwinStats

public static final ReadOptions ReadDigitalTwinStats

Denotes a special read request which will read a local digital twin stats object.

Method Detail

values

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

Returns:

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

valueOf

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

getEmptySet

public static java.util.Set<ReadOptions> getEmptySet()

Return a cached, read-only Set of ReadOptions with no ReadOptions set.

Returns:

a cached, read-only Set of ReadOptions with no ReadOptions set.

getObjectMayNotExistSet

public static java.util.Set<ReadOptions> getObjectMayNotExistSet()

Return a cached, read-only Set of ReadOptions containing just the ObjectMayNotExist flag.

Returns:

a cached, read-only Set of ReadOptions containing just the ObjectMayNotExist flag.

getReturnCachedObjectIfValidSet

public static java.util.Set<ReadOptions> getReturnCachedObjectIfValidSet()

Return a cached, read-only Set of ReadOptions containing just the ReturnCachedObjectIfValid flag.

Returns:

a cached, read-only Set of ReadOptions containing just the ReturnCachedObjectIfValid flag.

getLockObjectSet

public static java.util.Set<ReadOptions> getLockObjectSet()

Return a cached, read-only Set of ReadOptions containing just the LockObject flag.

Returns:

a cached, read-only Set of ReadOptions containing just the LockObject flag.

getAsyncReadThroughSet

public static java.util.Set<ReadOptions> getAsyncReadThroughSet()

Return a cached, read-only Set of ReadOptions containing just the AsyncReadThrough flag.

Returns:

a cached, read-only Set of ReadOptions containing just the AsyncReadThrough flag.

getSyncReadThroughSet

public static java.util.Set<ReadOptions> getSyncReadThroughSet()

Return a cached, read-only Set of ReadOptions containing just the SyncReadThrough flag.

Returns:

a cached, read-only Set of ReadOptions containing just the SyncReadThrough flag.