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

Enum Class AccessMode

java.lang.Object

java.lang.Enum<AccessMode>

org.opends.server.backends.pluggable.spi.AccessMode

All Implemented Interfaces:

Serializable, Comparable<AccessMode>, java.lang.constant.Constable

public enum AccessMode
extends Enum<AccessMode>

Defines access modes for opening pluggable backends / storages.

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
IMPORT_LDIF	Constant used to open for an import-ldif.
READ_ONLY	Constant used to open in read-only mode; implies missing trees will be ignored.
READ_WRITE	Constant used to open in read-write mode; implies trees will be created if not already present.

Method Summary

Modifier and Type	Method	Description
boolean	createOnDemand()	Returns whether a tree/index should be created if it does not exist.
boolean	isWriteable()	Returns if the storage is being opened READ_WRITE.
boolean	logIndexMsgs()	Returns whether index status messages should be logged.
static AccessMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AccessMode[]	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

READ_ONLY

public static final AccessMode READ_ONLY

Constant used to open in read-only mode; implies missing trees will be ignored.

READ_WRITE

public static final AccessMode READ_WRITE

Constant used to open in read-write mode; implies trees will be created if not already present.

IMPORT_LDIF

public static final AccessMode IMPORT_LDIF

Constant used to open for an import-ldif. IMPORT_LDIF is also READ_WRITE.

Method Details

values

public static AccessMode[] 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 AccessMode 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

isWriteable

public boolean isWriteable()

Returns if the storage is being opened READ_WRITE.

Returns:

true if the storage is being opened READ_WRITE

createOnDemand

public boolean createOnDemand()

Returns whether a tree/index should be created if it does not exist.

Returns:

whether a tree/index should be created if it does not exist

logIndexMsgs

public boolean logIndexMsgs()

Returns whether index status messages should be logged.

Returns:

whether index status messages should be logged