public final class ConfigurationBackend.ConfigurationBackendCfg extends Object implements BackendCfg
BackendCfg
implementation for the ConfigurationBackend
. No config is
needed for this specific backend, but this class is required to behave like other backends
during initialization.Modifier and Type | Method and Description |
---|---|
void |
addChangeListener(ConfigurationChangeListener<BackendCfg> listener)
Register to be notified when this Backend is changed.
|
Class<? extends BackendCfg> |
configurationClass()
Gets the configuration class associated with this Backend.
|
DN |
dn()
Gets the DN of the LDAP entry associated with this configuration.
|
String |
getBackendId()
Gets the "backend-id" property.
|
SortedSet<DN> |
getBaseDN()
Gets the "base-dn" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
BackendCfgDefn.WritabilityMode |
getWritabilityMode()
Gets the "writability-mode" property.
|
boolean |
isEnabled()
Gets the "enabled" property.
|
void |
removeChangeListener(ConfigurationChangeListener<BackendCfg> listener)
Deregister an existing Backend configuration change listener.
|
public DN dn()
Configuration
dn
in interface Configuration
public Class<? extends BackendCfg> configurationClass()
BackendCfg
configurationClass
in interface Configuration
configurationClass
in interface BackendCfg
public String getBackendId()
BackendCfg
Specifies a name to identify the associated backend.
The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.
getBackendId
in interface BackendCfg
public SortedSet<DN> getBaseDN()
BackendCfg
Specifies the base DN(s) for the data that the backend handles.
A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend (similar to the use of sub-suffixes in the Sun Java System Directory Server). If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN.
getBaseDN
in interface BackendCfg
public boolean isEnabled()
BackendCfg
Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
isEnabled
in interface BackendCfg
public String getJavaClass()
BackendCfg
Specifies the fully-qualified name of the Java class that provides the backend implementation.
getJavaClass
in interface BackendCfg
public BackendCfgDefn.WritabilityMode getWritabilityMode()
BackendCfg
Specifies the behavior that the backend should use when processing write operations.
getWritabilityMode
in interface BackendCfg
public void addChangeListener(ConfigurationChangeListener<BackendCfg> listener)
BackendCfg
addChangeListener
in interface BackendCfg
listener
- The Backend configuration change listener.public void removeChangeListener(ConfigurationChangeListener<BackendCfg> listener)
BackendCfg
removeChangeListener
in interface BackendCfg
listener
- The Backend configuration change listener.Copyright 2010-2017 ForgeRock AS.