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

Interface BackendVlvIndexCfg

  • All Superinterfaces:
    Configuration
    public interface BackendVlvIndexCfg
extends Configuration
    A server-side interface for querying Backend VLV Index settings.

    Backend VLV Indexes are used to store information about a specific search request that makes it possible to efficiently process them using the VLV control.

    • Method Detail

      • configurationClass

        Class<? extends BackendVlvIndexCfg> configurationClass()
        Gets the configuration class associated with this Backend VLV Index.
        Specified by:
        configurationClass in interface Configuration
        Returns:
        Returns the configuration class associated with this Backend VLV Index.

      • addChangeListener

        void addChangeListener​(ConfigurationChangeListener<BackendVlvIndexCfg> listener)
        Register to be notified when this Backend VLV Index is changed.
        Parameters:
        listener - The Backend VLV Index configuration change listener.

      • removeChangeListener

        void removeChangeListener​(ConfigurationChangeListener<BackendVlvIndexCfg> listener)
        Deregister an existing Backend VLV Index configuration change listener.
        Parameters:
        listener - The Backend VLV Index configuration change listener.

      • getBaseDn

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

        Specifies the base DN used in the search query that is being indexed.

        Returns:
        Returns the value of the "base-dn" property.

      • getFilter

        String getFilter()
        Gets the "filter" property.

        Specifies the LDAP filter used in the query that is being indexed.

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

      • getName

        String getName()
        Gets the "name" property.

        Specifies a unique name for this VLV index.

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

      • getScope

        BackendVlvIndexCfgDefn.Scope getScope()
        Gets the "scope" property.

        Specifies the LDAP scope of the query that is being indexed.

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

      • getSortOrder

        String getSortOrder()
        Gets the "sort-order" property.

        Specifies the names of the attributes that are used to sort the entries for the query being indexed.

        Multiple attributes can be used to determine the sort order by listing the attribute names from highest to lowest precedence. Optionally, + or - can be prefixed to the attribute name to sort the attribute in ascending order or descending order respectively.

        Returns:
        Returns the value of the "sort-order" property.