public interface LdifBackendCfg extends LocalBackendCfg
The LDIF Backend provides a mechanism for interacting with data stored in an LDIF file.
Modifier and Type | Method and Description |
---|---|
void |
addLdifChangeListener(ConfigurationChangeListener<LdifBackendCfg> listener)
Register to be notified when this LDIF Backend is changed.
|
Class<? extends LdifBackendCfg> |
configurationClass()
Gets the configuration class associated with this LDIF Backend.
|
SortedSet<Dn> |
getBaseDn()
Gets the "base-dn" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
String |
getLdifFile()
Gets the "ldif-file" property.
|
LocalBackendCfgDefn.WritabilityMode |
getWritabilityMode()
Gets the "writability-mode" property.
|
boolean |
isIsPrivateBackend()
Gets the "is-private-backend" property.
|
void |
removeLdifChangeListener(ConfigurationChangeListener<LdifBackendCfg> listener)
Deregister an existing LDIF Backend configuration change listener.
|
addLocalChangeListener, removeLocalChangeListener
addChangeListener, getBackendId, isEnabled, removeChangeListener
dn, name
Class<? extends LdifBackendCfg> configurationClass()
configurationClass
in interface BackendCfg
configurationClass
in interface Configuration
configurationClass
in interface LocalBackendCfg
void addLdifChangeListener(ConfigurationChangeListener<LdifBackendCfg> listener)
listener
- The LDIF Backend configuration change listener.void removeLdifChangeListener(ConfigurationChangeListener<LdifBackendCfg> listener)
listener
- The LDIF Backend configuration change listener.SortedSet<Dn> getBaseDn()
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.
boolean isIsPrivateBackend()
Indicates whether the backend should be considered a private backend, which indicates that it is used for storing operational data rather than user-defined information.
String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
getJavaClass
in interface BackendCfg
String getLdifFile()
Specifies the path to the LDIF file containing the data for this backend.
LocalBackendCfgDefn.WritabilityMode getWritabilityMode()
Specifies the behavior that the backend should use when processing write operations.
getWritabilityMode
in interface LocalBackendCfg
Copyright 2010-2020 ForgeRock AS.