Package org.opends.server.backends.pluggable.spi

Enum Class Storage.ReadWriteHint

java.lang.Object

java.lang.Enum<Storage.ReadWriteHint>

org.opends.server.backends.pluggable.spi.Storage.ReadWriteHint

All Implemented Interfaces:

Serializable, Comparable<Storage.ReadWriteHint>, java.lang.constant.Constable

Enclosing interface:

Storage

public static enum Storage.ReadWriteHint
extends Enum<Storage.ReadWriteHint>

Options applicable to read/write transactions and operations.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NESTED_TRANSACTION	Hint that the transaction is possibly being performed within an outer transaction.
NO_CACHE	Hint that the operation should not perturb the Storage's cache, for example, when scanning over all records in a database.
READ_UNCOMMITTED	Hint that the caller can tolerate reads of uncommitted (or dirty) data.
RELAX_DURABILITY	Hint that the Storage engine can relax the Durability (from ACID) for a specific transaction in the hope of achieving better performance.
USER_TRANSACTION	Hint that the transaction is directly associated with a user request and may be throttled if desired in order to prevent excessive resource contention when subjected to a large number of concurrent user requests.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_CACHE

public static final Storage.ReadWriteHint NO_CACHE

Hint that the operation should not perturb the Storage's cache, for example, when scanning over all records in a database.

READ_UNCOMMITTED

public static final Storage.ReadWriteHint READ_UNCOMMITTED

Hint that the caller can tolerate reads of uncommitted (or dirty) data. Only use this hint when you really do not care about data being stable.

RELAX_DURABILITY

public static final Storage.ReadWriteHint RELAX_DURABILITY

Hint that the Storage engine can relax the Durability (from ACID) for a specific transaction in the hope of achieving better performance.

NESTED_TRANSACTION

public static final Storage.ReadWriteHint NESTED_TRANSACTION

Hint that the transaction is possibly being performed within an outer transaction. The underlying storage should take any steps necessary to prevent potential deadlocks. Note that callers MUST still ensure that nested transactions DO NOT access records that are accessed by the outer transaction. In other words, this hint is not intended to prevent deadlocks resulting from DB record locking.

USER_TRANSACTION

public static final Storage.ReadWriteHint USER_TRANSACTION

Hint that the transaction is directly associated with a user request and may be throttled if desired in order to prevent excessive resource contention when subjected to a large number of concurrent user requests. Specifically, this hint will not be present when performing internal requests, replaying replicated updates or when performing nested (inner) requests, such as those performed when resolving virtual and collective attributes.

Method Details

values

public static Storage.ReadWriteHint[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Storage.ReadWriteHint valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null