Package org.opends.server.tools

Class BackendToolUtils

java.lang.Object

org.opends.server.tools.BackendToolUtils

public final class BackendToolUtils
extends Object

This class provides utility functions for all backend client tools.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BackendToolUtils.BackendInfo	Contains backend infos: LocalBackend, baseDNs and BackendCfg.

Method Summary

Modifier and Type	Method	Description
static SortedSet<Dn>	getBaseDn(BackendCfgClient backendCfgClient)	Gets the base DNs from the provided backend configuration.
static Set<Dn>	getBaseDn(BackendCfg backendCfg)	Gets the base DNs from the provided backend configuration.
static Collection<LocalBackend<?>>	getEnabledLocalBackends(ServerContext serverContext)	Returns a collection of the enabled local backends found in the Directory Server configuration.
static List<BackendToolUtils.BackendInfo>	getLocalBackends(ServerContext serverContext)	Returns information about the local backends defined in the Directory Server configuration.

Methods inherited from class java.lang.Object

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

Method Details

getEnabledLocalBackends

public static Collection<LocalBackend<?>> getEnabledLocalBackends(ServerContext serverContext)

Returns a collection of the enabled local backends found in the Directory Server configuration.

Parameters:

serverContext - the server context.

Returns:

the enabled local backends.

getLocalBackends

public static List<BackendToolUtils.BackendInfo> getLocalBackends(ServerContext serverContext)

Returns information about the local backends defined in the Directory Server configuration.

Parameters:

serverContext - the server context

Returns:

the local backends

getBaseDn

public static SortedSet<Dn> getBaseDn(BackendCfgClient backendCfgClient)
                               throws ExpressionException

Gets the base DNs from the provided backend configuration.

Parameters:

backendCfgClient - the backend configuration

Returns:

the configured based DNs

Throws:

ExpressionException - if the backend configuration contains some unvalued expression

getBaseDn

public static Set<Dn> getBaseDn(BackendCfg backendCfg)

Gets the base DNs from the provided backend configuration.

Parameters:

backendCfg - the backend configuration

Returns:

the configured based DNs