|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BackendCfg
A server-side interface for querying Backend settings.
Backends are responsible for providing access to the underlying data presented by the server.
Method Summary | |
---|---|
void |
addChangeListener(ConfigurationChangeListener<BackendCfg> listener)
Register to be notified when this Backend is changed. |
java.lang.Class<? extends BackendCfg> |
configurationClass()
Gets the configuration class associated with this Backend. |
java.lang.String |
getBackendId()
Gets the "backend-id" property. |
java.util.SortedSet<DN> |
getBaseDN()
Gets the "base-dn" property. |
java.lang.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. |
Methods inherited from interface org.opends.server.admin.Configuration |
---|
dn |
Method Detail |
---|
java.lang.Class<? extends BackendCfg> configurationClass()
configurationClass
in interface Configuration
void addChangeListener(ConfigurationChangeListener<BackendCfg> listener)
listener
- The Backend configuration change listener.void removeChangeListener(ConfigurationChangeListener<BackendCfg> listener)
listener
- The Backend configuration change listener.java.lang.String getBackendId()
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.
java.util.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 isEnabled()
Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
BackendCfgDefn.WritabilityMode getWritabilityMode()
Specifies the behavior that the backend should use when processing write operations.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |