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

Interface ExternalChangelogDomainCfg

  • All Superinterfaces:
    Configuration
    public interface ExternalChangelogDomainCfg
extends Configuration
    A server-side interface for querying External Changelog Domain settings.

    The External Changelog Domain provides configuration of the external changelog for the replication domain.

    • Method Detail

      • configurationClass

        Class<? extends ExternalChangelogDomainCfg> configurationClass()
        Gets the configuration class associated with this External Changelog Domain.
        Specified by:
        configurationClass in interface Configuration
        Returns:
        Returns the configuration class associated with this External Changelog Domain.

      • addChangeListener

        void addChangeListener​(ConfigurationChangeListener<ExternalChangelogDomainCfg> listener)
        Register to be notified when this External Changelog Domain is changed.
        Parameters:
        listener - The External Changelog Domain configuration change listener.

      • removeChangeListener

        void removeChangeListener​(ConfigurationChangeListener<ExternalChangelogDomainCfg> listener)
        Deregister an existing External Changelog Domain configuration change listener.
        Parameters:
        listener - The External Changelog Domain configuration change listener.

      • getECLInclude

        SortedSet<String> getECLInclude()
        Gets the "ecl-include" property.

        Specifies a list of attributes which should be published with every change log entry, regardless of whether the attribute itself has changed.

        The list of attributes may include wild cards such as "*" and "+" as well as object class references prefixed with an ampersand, for example "@person". The included attributes will be published using the "includedAttributes" operational attribute as a single LDIF value rather like the "changes" attribute. For modify and modifyDN operations the included attributes will be taken from the entry before any changes were applied.

        Returns:
        Returns an unmodifiable set containing the values of the "ecl-include" property.

      • getECLIncludeForDeletes

        SortedSet<String> getECLIncludeForDeletes()
        Gets the "ecl-include-for-deletes" property.

        Specifies a list of attributes which should be published with every delete operation change log entry, in addition to those specified by the "ecl-include" property.

        This property provides a means for applications to archive entries after they have been deleted. See the description of the "ecl-include" property for further information about how the included attributes are published.

        Returns:
        Returns an unmodifiable set containing the values of the "ecl-include-for-deletes" property.

      • isEnabled

        boolean isEnabled()
        Gets the "enabled" property.

        Indicates whether the External Changelog Domain is enabled. To enable computing the change numbers, set the Replication Server's "ds-cfg-compute-change-number" property to true.

        Returns:
        Returns the value of the "enabled" property.