public interface LdifBackendCfgClient extends LocalBackendCfgClient
The LDIF Backend provides a mechanism for interacting with data stored in an LDIF file.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends LdifBackendCfgClient,? extends LdifBackendCfg> |
definition()
Get the configuration definition 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 |
setBaseDn(Collection<Dn> values)
Sets the "base-dn" property.
|
void |
setIsPrivateBackend(Boolean value)
Sets the "is-private-backend" property.
|
void |
setJavaClass(String value)
Sets the "java-class" property.
|
void |
setLdifFile(String value)
Sets the "ldif-file" property.
|
void |
setWritabilityMode(LocalBackendCfgDefn.WritabilityMode value)
Sets the "writability-mode" property.
|
getBackendId, isEnabled, setBackendId, setEnabled
commit, properties
ManagedObjectDefinition<? extends LdifBackendCfgClient,? extends LdifBackendCfg> definition()
definition
in interface BackendCfgClient
definition
in interface ConfigurationClient
definition
in interface LocalBackendCfgClient
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.
void setBaseDn(Collection<Dn> values) throws PropertyException
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.
values
- The values of the "base-dn" property.PropertyException
- If one or more of the new values are invalid.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.
void setIsPrivateBackend(Boolean value) throws PropertyException
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.
value
- The value of the "is-private-backend" property.PropertyException
- If the new value is invalid.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
getJavaClass
in interface BackendCfgClient
void setJavaClass(String value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the backend implementation.
setJavaClass
in interface BackendCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.String getLdifFile()
Specifies the path to the LDIF file containing the data for this backend.
void setLdifFile(String value) throws PropertyException
Specifies the path to the LDIF file containing the data for this backend.
value
- The value of the "ldif-file" property.PropertyException
- If the new value is invalid.LocalBackendCfgDefn.WritabilityMode getWritabilityMode()
Specifies the behavior that the backend should use when processing write operations.
getWritabilityMode
in interface LocalBackendCfgClient
void setWritabilityMode(LocalBackendCfgDefn.WritabilityMode value) throws PropertyException
Specifies the behavior that the backend should use when processing write operations.
setWritabilityMode
in interface LocalBackendCfgClient
value
- The value of the "writability-mode" property.PropertyException
- If the new value is invalid.Copyright 2010-2020 ForgeRock AS.