Package org.opends.server.backends

Class ConfigurationBackend.ConfigurationBackendCfg

java.lang.Object
org.opends.server.backends.ConfigurationBackend.ConfigurationBackendCfg
All Implemented Interfaces:
Configuration, BackendCfg, LocalBackendCfg
Enclosing class:
ConfigurationBackend
public final class ConfigurationBackend.ConfigurationBackendCfg extends Object implements LocalBackendCfg
Dummy 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.

  • Method Details

    • dn

      public Dn dn()
      Description copied from interface: Configuration
      Gets the DN of the LDAP entry associated with this configuration.
      Specified by:
      dn in interface Configuration
      Returns:
      The DN of the LDAP entry associated with this configuration.

    • configurationClass

      public Class<? extends LocalBackendCfg> configurationClass()
      Description copied from interface: LocalBackendCfg
      Gets the configuration class associated with this Local Backend.
      Specified by:
      configurationClass in interface BackendCfg
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface LocalBackendCfg
      Returns:
      Returns the configuration class associated with this Local Backend.

    • getBackendId

      public String getBackendId()
      Description copied from interface: BackendCfg
      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.

      Specified by:
      getBackendId in interface BackendCfg
      Returns:
      Returns the value of the "backend-id" property.

    • isEnabled

      public boolean isEnabled()
      Description copied from interface: BackendCfg
      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.

      Specified by:
      isEnabled in interface BackendCfg
      Returns:
      Returns the value of the "enabled" property.

    • getJavaClass

      public String getJavaClass()
      Description copied from interface: BackendCfg
      Gets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the backend implementation.

      Specified by:
      getJavaClass in interface BackendCfg
      Returns:
      Returns the value of the "java-class" property.

    • getWritabilityMode

      public LocalBackendCfgDefn.WritabilityMode getWritabilityMode()
      Description copied from interface: LocalBackendCfg
      Gets the "writability-mode" property.

      Specifies the behavior that the backend should use when processing write operations.

      Specified by:
      getWritabilityMode in interface LocalBackendCfg
      Returns:
      Returns the value of the "writability-mode" property.

    • addChangeListener

      public void addChangeListener(ConfigurationChangeListener<BackendCfg> listener)
      Description copied from interface: BackendCfg
      Register to be notified when this Backend is changed.
      Specified by:
      addChangeListener in interface BackendCfg
      Parameters:
      listener - The Backend configuration change listener.

    • removeChangeListener

      public void removeChangeListener(ConfigurationChangeListener<BackendCfg> listener)
      Description copied from interface: BackendCfg
      Deregister an existing Backend configuration change listener.
      Specified by:
      removeChangeListener in interface BackendCfg
      Parameters:
      listener - The Backend configuration change listener.

    • addLocalChangeListener

      public void addLocalChangeListener(ConfigurationChangeListener<LocalBackendCfg> listener)
      Description copied from interface: LocalBackendCfg
      Register to be notified when this Local Backend is changed.
      Specified by:
      addLocalChangeListener in interface LocalBackendCfg
      Parameters:
      listener - The Local Backend configuration change listener.

    • removeLocalChangeListener

      public void removeLocalChangeListener(ConfigurationChangeListener<LocalBackendCfg> listener)
      Description copied from interface: LocalBackendCfg
      Deregister an existing Local Backend configuration change listener.
      Specified by:
      removeLocalChangeListener in interface LocalBackendCfg
      Parameters:
      listener - The Local Backend configuration change listener.