C
- the type of the BackendCfg for the current backendpublic abstract class Backend<C extends org.forgerock.opendj.config.Configuration> extends Object implements RequestHandler
Constructor and Description |
---|
Backend() |
Modifier and Type | Method and Description |
---|---|
abstract void |
configureBackend(C cfg,
ServerContext serverContext)
Configure this backend based on the information in the provided configuration.
|
void |
deregisterBackendMonitor()
Deregisters the backend monitor of this backend.
|
abstract void |
finalizeBackend()
Performs any necessary work to finalize this backend.
|
String |
getBackendID()
Retrieves the unique identifier for this backend.
|
abstract Set<org.forgerock.opendj.ldap.Dn> |
getBaseDNs()
Retrieves the set of base-level DNs that may be used within this
backend.
|
abstract Set<String> |
getSupportedControls()
Retrieves the OIDs of the controls that may be supported by this
backend.
|
abstract Set<String> |
getSupportedFeatures()
Retrieves the OIDs of the features that may be supported by this
backend.
|
boolean |
isConfigurationAcceptable(C configuration,
List<LocalizableMessage> unacceptableReasons,
ServerContext serverContext)
Indicates whether the provided configuration is acceptable for
this backend.
|
abstract boolean |
isPublicBackend()
Indicates whether the base DNs of this backend should be considered public or private.
|
abstract void |
openBackend()
Opens this backend based on the information provided when the backend was configured.
|
void |
registerBackendMonitor()
Registers a backend monitor for this backend.
|
void |
setBackendID(String backendID)
Specifies the unique identifier for this backend.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
handle
public Backend()
public abstract void configureBackend(C cfg, ServerContext serverContext) throws org.forgerock.opendj.config.server.ConfigException
cfg
- The configuration of this backend.serverContext
- The server context for this instanceorg.forgerock.opendj.config.server.ConfigException
- If there is an error in the configuration.public abstract void openBackend() throws org.forgerock.opendj.config.server.ConfigException, InitializationException
org.forgerock.opendj.config.server.ConfigException
- If an unrecoverable problem arises while opening the backend.InitializationException
- If a problem occurs during opening that is not
related to the server configuration.configureBackend(C, org.opends.server.core.ServerContext)
public abstract void finalizeBackend()
configureBackend()
has been called.
This may be called during the Directory Server shutdown process or if a backend is disabled
with the server online.
It must not return until the backend is closed.
This method may not throw any exceptions. If any problems are encountered, then they may be logged but the closure should progress as completely as possible.
public final String getBackendID()
public abstract Set<org.forgerock.opendj.ldap.Dn> getBaseDNs()
public abstract Set<String> getSupportedControls()
public abstract Set<String> getSupportedFeatures()
public boolean isConfigurationAcceptable(C configuration, List<LocalizableMessage> unacceptableReasons, ServerContext serverContext)
configuration
- The backend configuration for which
to make the determination.unacceptableReasons
- A list that may be used to hold the
reasons that the provided
configuration is not acceptable.serverContext
- this Directory Server instance's server contexttrue
if the provided configuration is acceptable
for this backend, or false
if not.public abstract boolean isPublicBackend()
This method also controls the visibility of the associated naming contexts. i.e. if any base DN of this backend is a naming context, then it will be public or private, based on the value returned by this method.
Reminder: Public naming contexts are returned when querying the root DSE entry.
true
if this backend's baseDNs could be exposed as a public naming context,
false
if they must remain private naming contexts.public final void setBackendID(String backendID)
backendID
- The unique identifier for this backend.public void registerBackendMonitor()
public void deregisterBackendMonitor()
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.