org.opends.server.api

Enum LocalBackend.BackendOperation

java.lang.Object

java.lang.Enum<LocalBackend.BackendOperation>

org.opends.server.api.LocalBackend.BackendOperation

All Implemented Interfaces:

Serializable, Comparable<LocalBackend.BackendOperation>

Enclosing class:

LocalBackend<C extends Configuration>

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

Enumeration of optional backend operations.

Enum Constant Summary

Enum Constants

Enum Constant and 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_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 and Description
static LocalBackend.BackendOperation	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocalBackend.BackendOperation[]	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

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.

Method Detail

values

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

Returns:

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

valueOf

public static LocalBackend.BackendOperation valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null