Interface BackendCfg
-
- All Superinterfaces:
Configuration
- All Known Subinterfaces:
JeBackendCfg
,LdifBackendCfg
,LocalBackendCfg
,MemoryBackendCfg
,MonitorBackendCfg
,NullBackendCfg
,PluggableBackendCfg
,ProxyBackendCfg
,SchemaBackendCfg
,TaskBackendCfg
- All Known Implementing Classes:
ConfigurationBackend.ConfigurationBackendCfg
public interface BackendCfg extends Configuration
A server-side interface for querying Backend settings.Backends are responsible for providing access to the underlying data presented by the server.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.String
getBackendId()
Gets the "backend-id" property.String
getJavaClass()
Gets the "java-class" property.boolean
isEnabled()
Gets the "enabled" property.void
removeChangeListener(ConfigurationChangeListener<BackendCfg> listener)
Deregister an existing Backend configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
-
-
-
Method Detail
-
configurationClass
Class<? extends BackendCfg> configurationClass()
Gets the configuration class associated with this Backend.- Specified by:
configurationClass
in interfaceConfiguration
- Returns:
- Returns the configuration class associated with this Backend.
-
addChangeListener
void addChangeListener(ConfigurationChangeListener<BackendCfg> listener)
Register to be notified when this Backend is changed.- Parameters:
listener
- The Backend configuration change listener.
-
removeChangeListener
void removeChangeListener(ConfigurationChangeListener<BackendCfg> listener)
Deregister an existing Backend configuration change listener.- Parameters:
listener
- The Backend configuration change listener.
-
getBackendId
String getBackendId()
Gets the "backend-id" property.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.
- Returns:
- Returns the value of the "backend-id" property.
-
isEnabled
boolean isEnabled()
Gets the "enabled" property.Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
- Returns:
- Returns the value of the "enabled" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the backend implementation.
- Returns:
- Returns the value of the "java-class" property.
-
-