Package org.forgerock.opendj.server.config.server

Interface NullBackendCfg

  • All Superinterfaces:
    BackendCfg, Configuration, LocalBackendCfg
    public interface NullBackendCfg
extends LocalBackendCfg
    A server-side interface for querying Null Backend settings.

    The Null Backend provides a directory server backend that implements a /dev/null like behavior for development and testing.

    • Method Detail

      • addNullChangeListener

        void addNullChangeListener​(ConfigurationChangeListener<NullBackendCfg> listener)
        Register to be notified when this Null Backend is changed.
        Parameters:
        listener - The Null Backend configuration change listener.

      • removeNullChangeListener

        void removeNullChangeListener​(ConfigurationChangeListener<NullBackendCfg> listener)
        Deregister an existing Null Backend configuration change listener.
        Parameters:
        listener - The Null Backend configuration change listener.

      • getBaseDn

        SortedSet<Dn> getBaseDn()
        Gets the "base-dn" property.

        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.

        Returns:
        Returns an unmodifiable set containing the values of the "base-dn" property.

      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

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

        Default value: org.opends.server.backends.NullBackend

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

      • getWritabilityMode

        LocalBackendCfgDefn.WritabilityMode getWritabilityMode()
        Gets the "writability-mode" property.

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

        Default value: enabled

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