org.opends.server.tasks

Class TaskUtils

java.lang.Object

org.opends.server.tasks.TaskUtils

public final class TaskUtils
extends Object

This class defines a number of static utility methods for server tasks.

Method Summary

Modifier and Type	Method and Description
static void	activateBackend(String backendID) Activates a backend.
static void	deactivateBackend(String backendID) Deactivates a backend using an internal modify operation on the backend configuration entry.
static Map<String,Entry>	getBackendConfigEntries() Get all the backend configuration entries defined in the server mapped by their backend ID.
static String	getBackendID(Entry configEntry) Get the backend ID of a backend configuration entry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBackendID

public static String getBackendID(Entry configEntry)

Get the backend ID of a backend configuration entry.

Parameters:

configEntry - A backend configuration entry.

Returns:

The backend ID.

getBackendConfigEntries

public static Map<String,Entry> getBackendConfigEntries()

Get all the backend configuration entries defined in the server mapped by their backend ID.

Returns:

A map of backend IDs to their corresponding configuration entries.

activateBackend

public static void activateBackend(String backendID)
                            throws LdapException

Activates a backend.

Load the backend's implementation class, configures, opens and registers it.

Parameters:

backendID - Identifies the backend to be activated.

Throws:

LdapException - If the backend cannot be activated (e.g: backendID does note exists).

deactivateBackend

public static void deactivateBackend(String backendID)
                              throws LdapException

Deactivates a backend using an internal modify operation on the backend configuration entry.

Parameters:

backendID - Identifies the backend to be disabled.

Throws:

LdapException - If the internal modify operation failed.