org.opends.server.tools

Class BackendCreationHelper

java.lang.Object

org.opends.server.tools.BackendCreationHelper

public class BackendCreationHelper
extends Object

Utility class which can be used by tools to create a new backend with default indexes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackendCreationHelper.DefaultIndex Describes an attribute index which should be created during installation.

Field Summary

Fields

Modifier and Type	Field and Description
static BackendCreationHelper.DefaultIndex[]	DEFAULT_INDEXES Default indexes to add in a new backend.

Constructor Summary

Constructors

Constructor and Description
BackendCreationHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static void	createBackend(org.forgerock.opendj.server.config.client.RootCfgClient rootConfiguration, String backendName, Collection<org.forgerock.opendj.ldap.DN> baseDNs, org.forgerock.opendj.config.ManagedObjectDefinition<? extends org.forgerock.opendj.server.config.client.BackendCfgClient,? extends org.forgerock.opendj.server.config.server.BackendCfg> backendType) Create a backend with the provided name using the provided RootCfgClient.
static void	createBackendOffline(String backendName, Collection<org.forgerock.opendj.ldap.DN> baseDNs, org.forgerock.opendj.config.ManagedObjectDefinition<? extends org.forgerock.opendj.server.config.client.BackendCfgClient,? extends org.forgerock.opendj.server.config.server.BackendCfg> backendType) Add a new backend with the provided name in the config.ldif file.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDEXES

public static final BackendCreationHelper.DefaultIndex[] DEFAULT_INDEXES

Default indexes to add in a new backend.

Constructor Detail

BackendCreationHelper

public BackendCreationHelper()

Method Detail

createBackendOffline

public static void createBackendOffline(String backendName,
                        Collection<org.forgerock.opendj.ldap.DN> baseDNs,
                        org.forgerock.opendj.config.ManagedObjectDefinition<? extends org.forgerock.opendj.server.config.client.BackendCfgClient,? extends org.forgerock.opendj.server.config.server.BackendCfg> backendType)
                                 throws Exception

Add a new backend with the provided name in the config.ldif file.

Parameters:

backendName - The new backend name

baseDNs - The base dns to add in the new backend.

backendType - The backend type

Throws:

Exception - If any problems occurred

createBackend

public static void createBackend(org.forgerock.opendj.server.config.client.RootCfgClient rootConfiguration,
                 String backendName,
                 Collection<org.forgerock.opendj.ldap.DN> baseDNs,
                 org.forgerock.opendj.config.ManagedObjectDefinition<? extends org.forgerock.opendj.server.config.client.BackendCfgClient,? extends org.forgerock.opendj.server.config.server.BackendCfg> backendType)
                          throws Exception

Create a backend with the provided name using the provided RootCfgClient.

Parameters:

rootConfiguration - The root configuration to use to create the new backend

backendName - The new backend name

baseDNs - The base dns to add in the new backend.

backendType - The backend type

Throws:

Exception - If any problems occurred