public class BackendConfigManager extends Object implements ConfigurationChangeListener<BackendCfg>, ConfigurationAddListener<BackendCfg>, ConfigurationDeleteListener<BackendCfg>
Constructor and Description |
---|
BackendConfigManager(ServerContext serverContext)
Creates a new instance of this backend config manager.
|
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationAdd(BackendCfg cfg)
Adds a new configuration to this add listener.
|
ConfigChangeResult |
applyConfigurationChange(BackendCfg cfg)
Applies the configuration changes to this change listener.
|
ConfigChangeResult |
applyConfigurationDelete(BackendCfg configEntry)
Deletes an existing configuration from this delete listener.
|
void |
initializeBackendConfig(Collection<String> backendIDsToStart)
Initializes the configuration associated with the Directory Server
backends.
|
void |
initializeBackends(Collection<String> backendIDsToStart,
RootCfg root)
Initializes specified backends.
|
boolean |
isConfigurationAddAcceptable(BackendCfg configEntry,
List<LocalizableMessage> unacceptableReason)
Indicates whether the proposed addition of a new configuration is
acceptable to this add listener.
|
boolean |
isConfigurationChangeAcceptable(BackendCfg configEntry,
List<LocalizableMessage> unacceptableReason)
Indicates whether the proposed change to the configuration is acceptable
to this change listener.
|
boolean |
isConfigurationDeleteAcceptable(BackendCfg configEntry,
List<LocalizableMessage> unacceptableReason)
Indicates whether the proposed deletion of an existing configuration is
acceptable to this delete listener.
|
public BackendConfigManager(ServerContext serverContext)
serverContext
- The server context.public void initializeBackendConfig(Collection<String> backendIDsToStart) throws ConfigException, InitializationException
backendIDsToStart
- The list of backendID to start. Everything will be started if empty.ConfigException
- If a critical configuration problem prevents the backend
initialization from succeeding.InitializationException
- If a problem occurs while initializing the backends that is not
related to the server configuration.public void initializeBackends(Collection<String> backendIDsToStart, RootCfg root) throws ConfigException
backendIDsToStart
- The list of backendID to start. Everything will be started if empty.root
- The configuration of the server's Root backendConfigException
- If a critical configuration problem prevents the backend
initialization from succeeding.public boolean isConfigurationChangeAcceptable(BackendCfg configEntry, List<LocalizableMessage> unacceptableReason)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<BackendCfg>
configEntry
- The new configuration containing the changes.unacceptableReason
- A list that can be used to hold messages about why the
provided configuration is not acceptable.true
if the proposed change is acceptable,
or false
if it is not.public ConfigChangeResult applyConfigurationChange(BackendCfg cfg)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<BackendCfg>
cfg
- The new configuration containing the changes.public boolean isConfigurationAddAcceptable(BackendCfg configEntry, List<LocalizableMessage> unacceptableReason)
ConfigurationAddListener
isConfigurationAddAcceptable
in interface ConfigurationAddListener<BackendCfg>
configEntry
- The configuration that will be added.unacceptableReason
- A list that can be used to hold messages about why the
provided configuration is not acceptable.true
if the proposed addition is acceptable,
or false
if it is not.public ConfigChangeResult applyConfigurationAdd(BackendCfg cfg)
ConfigurationAddListener
applyConfigurationAdd
in interface ConfigurationAddListener<BackendCfg>
cfg
- The configuration that will be added.public boolean isConfigurationDeleteAcceptable(BackendCfg configEntry, List<LocalizableMessage> unacceptableReason)
ConfigurationDeleteListener
isConfigurationDeleteAcceptable
in interface ConfigurationDeleteListener<BackendCfg>
configEntry
- The configuration that will be deleted.unacceptableReason
- A list that can be used to hold messages about why the
provided configuration is not acceptable.true
if the proposed deletion is acceptable,
or false
if it is not.public ConfigChangeResult applyConfigurationDelete(BackendCfg configEntry)
ConfigurationDeleteListener
applyConfigurationDelete
in interface ConfigurationDeleteListener<BackendCfg>
configEntry
- The existing configuration that will be deleted.Copyright 2010-2017 ForgeRock AS.