Package org.opends.server.api

Enum Class LocalBackend.BackendOperation

java.lang.Object

java.lang.Enum<LocalBackend.BackendOperation>

org.opends.server.api.LocalBackend.BackendOperation

All Implemented Interfaces:

Serializable, Comparable<LocalBackend.BackendOperation>, java.lang.constant.Constable

Enclosing class:

LocalBackend<C extends Configuration>

public static enum LocalBackend.BackendOperation
extends Enum<LocalBackend.BackendOperation>

Enumeration of optional backend 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
BACKUP	Indicates whether this backend provides a backup mechanism of any kind.
INDEXING	Indicates whether this backend supports indexing attributes to speed up searches.
LDIF_EXPORT	Indicates whether this backend supports exporting the data it contains to an LDIF file.
LDIF_IMPORT	Indicates whether this backend supports importing its data from an LDIF file.
OFFLINE_CHANGES	Indicates whether this backend's content may be modified while the server is offline.
OFFLINE_RESTORE	Indicates whether this backend can restore a backup when the server is offline.
ONLINE_RESTORE	Indicates whether this backend can restore a backup when the server is online.

Method Summary

Modifier and Type	Method	Description
static LocalBackend.BackendOperation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LocalBackend.BackendOperation[]	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

INDEXING

public static final LocalBackend.BackendOperation INDEXING

Indicates whether this backend supports indexing attributes to speed up searches.

LDIF_EXPORT

public static final LocalBackend.BackendOperation LDIF_EXPORT

Indicates whether this backend supports exporting the data it contains to an LDIF file.

LDIF_IMPORT

public static final LocalBackend.BackendOperation LDIF_IMPORT

Indicates whether this backend supports importing its data from an LDIF file.

BACKUP

public static final LocalBackend.BackendOperation BACKUP

Indicates whether this backend provides a backup mechanism of any kind. This method is used by the backup process when backing up all backends to determine whether this backend is one that should be skipped. It should only return true for backends that it is not possible to archive directly (e.g., those that don't store their data locally, but rather pass through requests to some other repository).

OFFLINE_RESTORE

public static final LocalBackend.BackendOperation OFFLINE_RESTORE

Indicates whether this backend can restore a backup when the server is offline.

ONLINE_RESTORE

public static final LocalBackend.BackendOperation ONLINE_RESTORE

Indicates whether this backend can restore a backup when the server is online.

OFFLINE_CHANGES

public static final LocalBackend.BackendOperation OFFLINE_CHANGES

Indicates whether this backend's content may be modified while the server is offline.

Method Details

values

public static LocalBackend.BackendOperation[] 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 LocalBackend.BackendOperation 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