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

Interface BackendIndexCfg

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

Backend Indexes are used to store information that makes it possible to locate entries very quickly when processing search operations.

  • Method Details

    • configurationClass

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

    • addChangeListener

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

    • removeChangeListener

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

    • getAttribute

      AttributeType getAttribute()
      Gets the "attribute" property.

      Specifies the name of the attribute for which the index is to be maintained.

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

    • getBigIndexExtensibleMatchingRule

      SortedSet<String> getBigIndexExtensibleMatchingRule()
      Gets the "big-index-extensible-matching-rule" property.

      The extensible matching rule in a big index.

      An extensible matching rule must be specified using either LOCALE or OID of the matching rule.

      Returns:
      Returns an unmodifiable set containing the values of the "big-index-extensible-matching-rule" property.

    • getBigIndexIncludedAttributeValue

      SortedSet<String> getBigIndexIncludedAttributeValue()
      Gets the "big-index-included-attribute-value" property.

      An attribute value which should be indexed in any big indexes.

      Restricts the set of attribute values indexed by big indexes. All attribute values will be indexed by default.

      Returns:
      Returns an unmodifiable set containing the values of the "big-index-included-attribute-value" property.

    • isConfidentialityEnabled

      boolean isConfidentialityEnabled()
      Gets the "confidentiality-enabled" property.

      Specifies whether contents of the index should be confidential.

      Setting the flag to true will hash keys for equality type indexes using SHA-1 and encrypt the list of entries matching a substring key for substring indexes.

      Default value: false

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

    • getIndexEntryLimit

      Integer getIndexEntryLimit()
      Gets the "index-entry-limit" property.

      Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained.

      This is analogous to the ALL IDs threshold in the Sun Java System Directory Server. If this is specified, its value overrides the JE backend-wide configuration. For no limit, use 0 for the value. Changing the index entry limit significantly can result in serious performance degradation. Please read the documentation before changing this setting.

      Default value is inherited from another property

      Returns:
      Returns the value of the "index-entry-limit" property.

    • getIndexExtensibleMatchingRule

      SortedSet<String> getIndexExtensibleMatchingRule()
      Gets the "index-extensible-matching-rule" property.

      The extensible matching rule in an extensible index.

      An extensible matching rule must be specified using either LOCALE or OID of the matching rule.

      Returns:
      Returns an unmodifiable set containing the values of the "index-extensible-matching-rule" property.

    • getIndexType

      SortedSet<BackendIndexCfgDefn.IndexType> getIndexType()
      Gets the "index-type" property.

      Specifies the type(s) of indexing that should be performed for the associated attribute.

      For equality, presence, and substring index types, the associated attribute type must have a corresponding matching rule.

      Returns:
      Returns an unmodifiable set containing the values of the "index-type" property.

    • getSubstringLength

      int getSubstringLength()
      Gets the "substring-length" property.

      The length of substrings in a substring index.

      Default value: 6

      Returns:
      Returns the value of the "substring-length" property.

    • getTtlAge

      Duration getTtlAge()
      Gets the "ttl-age" property.

      After reaching the time of the indexed attribute plus this age, PingDS considers the entry expired and ready for deletion. Use a low setting to quickly delete entries with expiration timestamps, for example, with coreTokenExpirationDate. Use a high setting to delay deleting entries with "last use" timestamps, for example, with lastLoginTime.

      Default value: 0s

      Returns:
      Returns the value of the "ttl-age" property.

    • isTtlEnabled

      boolean isTtlEnabled()
      Gets the "ttl-enabled" property.

      Enable TTL for this generalized time index.

      Default value: false

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