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

Interface BackendIndexCfgClient

  • All Superinterfaces:
    ConfigurationClient
    public interface BackendIndexCfgClient
extends ConfigurationClient
    A client-side interface for reading and modifying Backend Index settings.

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

    • Method Detail

      • getAttribute

        @MandatoryProperty
ValueOrExpression<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.

      • getBigIndexIncludedAttributeValue

        SortedSet<ValueOrExpression<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 the values of the "big-index-included-attribute-value" property.

      • setBigIndexIncludedAttributeValue

        void setBigIndexIncludedAttributeValue​(Collection<ValueOrExpression<String>> values)
                                throws PropertyException
        Sets 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.

        Parameters:
        values - The values of the "big-index-included-attribute-value" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getBigIndexMatchingRule

        SortedSet<ValueOrExpression<String>> getBigIndexMatchingRule()
        Gets the "big-index-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 the values of the "big-index-matching-rule" property.

      • setBigIndexMatchingRule

        void setBigIndexMatchingRule​(Collection<ValueOrExpression<String>> values)
                      throws PropertyException
        Sets the "big-index-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.

        Parameters:
        values - The values of the "big-index-matching-rule" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • isConfidentialityEnabled

        ValueOrExpression<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.

      • setConfidentialityEnabled

        void setConfidentialityEnabled​(ValueOrExpression<Boolean> value)
                        throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "confidentiality-enabled" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getIndexEntryLimit

        ValueOrExpression<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.

      • setIndexEntryLimit

        void setIndexEntryLimit​(ValueOrExpression<Integer> value)
                 throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "index-entry-limit" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getIndexExtensibleMatchingRule

        SortedSet<ValueOrExpression<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 the values of the "index-extensible-matching-rule" property.

      • setIndexExtensibleMatchingRule

        void setIndexExtensibleMatchingRule​(Collection<ValueOrExpression<String>> values)
                             throws PropertyException
        Sets 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.

        Parameters:
        values - The values of the "index-extensible-matching-rule" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getIndexType

        @MandatoryProperty
SortedSet<ValueOrExpression<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 the values of the "index-type" property.

      • getSubstringLength

        ValueOrExpression<Integer> 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.

      • setSubstringLength

        void setSubstringLength​(ValueOrExpression<Integer> value)
                 throws PropertyException
        Sets the "substring-length" property.

        The length of substrings in a substring index.

        Parameters:
        value - The value of the "substring-length" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getTtlAge

        ValueOrExpression<Long> getTtlAge()
        Gets the "ttl-age" property.

        The age when timestamps are considered to have expired.

        Default value: 0s

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

      • setTtlAge

        void setTtlAge​(ValueOrExpression<Long> value)
        throws PropertyException
        Sets the "ttl-age" property.

        The age when timestamps are considered to have expired.

        Parameters:
        value - The value of the "ttl-age" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isTtlEnabled

        ValueOrExpression<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.

      • setTtlEnabled

        void setTtlEnabled​(ValueOrExpression<Boolean> value)
            throws PropertyException
        Sets the "ttl-enabled" property.

        Enable TTL for this generalized time index.

        Parameters:
        value - The value of the "ttl-enabled" property.
        Throws:
        PropertyException - If the new value is invalid.