com.unboundid.ldap.sdk.unboundidds.controls

Enum TransactionSettingsCommitDurability

java.lang.Object

java.lang.Enum<TransactionSettingsCommitDurability>

com.unboundid.ldap.sdk.unboundidds.controls.TransactionSettingsCommitDurability

All Implemented Interfaces:

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

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum TransactionSettingsCommitDurability
extends java.lang.Enum<TransactionSettingsCommitDurability>

This enum defines the options that may be specified for the transaction commit durability when using the transaction settings request control.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

See Also:

TransactionSettingsRequestControl

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULLY_SYNCHRONOUS Indicates that the commit should be fully synchronous.
NON_SYNCHRONOUS Indicates that the commit should be non-synchronous.
PARTIALLY_SYNCHRONOUS Indicates that the commit should be partially synchronous.

Method Summary

Modifier and Type	Method and Description
static TransactionSettingsCommitDurability	forName(java.lang.String name) Retrieves the transaction settings commit durability with the specified name.
int	intValue() Retrieves the integer value for this transaction settings commit durability value.
static TransactionSettingsCommitDurability	valueOf(int intValue) Retrieves the commit durability value with the specified integer value.
static TransactionSettingsCommitDurability	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TransactionSettingsCommitDurability[]	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

NON_SYNCHRONOUS

public static final TransactionSettingsCommitDurability NON_SYNCHRONOUS

Indicates that the commit should be non-synchronous. Atomicity, consistency, and isolation will be maintained for the transaction, but there is no guarantee that the record of the transaction will be written to disk by the time operation processing is complete and the response has been returned to the client. In the event of a JVM, operating system, or hardware failure before the transaction record is actually flushed to disk, then changes that are part of that transaction could be rolled back when the server is started back up.

PARTIALLY_SYNCHRONOUS

public static final TransactionSettingsCommitDurability PARTIALLY_SYNCHRONOUS

Indicates that the commit should be partially synchronous. Atomicity, consistency, and isolation will be maintained for the transaction, and a record of the transaction will be written to disk during the commit, but that transaction record will not be synchronously flushed. In the event of an operating system or hardware failure before the transaction record is actually flushed to disk, then changes that are part of that transaction could be rolled back when the server is started back up.

FULLY_SYNCHRONOUS

public static final TransactionSettingsCommitDurability FULLY_SYNCHRONOUS

Indicates that the commit should be fully synchronous. Atomicity, consistency, isolation, and durability will be maintained for the transaction, and a record of the transaction will be flushed to disk before the commit is completed. In the event of a JVM, operating system, or hardware failure, then any changes that are part of that transaction will still be reflected in the database when the server is started back up (as long as the database files are still intact).

Method Detail

values

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

Returns:

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

valueOf

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

intValue

public int intValue()

Retrieves the integer value for this transaction settings commit durability value.

Returns:

The integer value for this transaction settings commit durability value.

valueOf

@Nullable
public static TransactionSettingsCommitDurability valueOf(int intValue)

Retrieves the commit durability value with the specified integer value.

Parameters:

intValue - The integer value for the commit durability to retrieve.

Returns:

The commit durability value with the specified integer value, or null if there is no such commit durability value.

forName

@Nullable
public static TransactionSettingsCommitDurability forName(@NotNull
                                                                    java.lang.String name)

Retrieves the transaction settings commit durability with the specified name.

Parameters:

name - The name of the transaction settings commit durability to retrieve. It must not be null.

Returns:

The requested transaction settings commit durability, or null if no such durability is defined.