public interface BackendIndexCfg extends Configuration
Backend Indexes are used to store information that makes it possible to locate entries very quickly when processing search operations.
Modifier and Type | Method and Description |
---|---|
void |
addChangeListener(ConfigurationChangeListener<BackendIndexCfg> listener)
Register to be notified when this Backend Index is changed.
|
Class<? extends BackendIndexCfg> |
configurationClass()
Gets the configuration class associated with this Backend Index.
|
AttributeType |
getAttribute()
Gets the "attribute" property.
|
Integer |
getIndexEntryLimit()
Gets the "index-entry-limit" property.
|
SortedSet<String> |
getIndexExtensibleMatchingRule()
Gets the "index-extensible-matching-rule" property.
|
SortedSet<BackendIndexCfgDefn.IndexType> |
getIndexType()
Gets the "index-type" property.
|
int |
getSubstringLength()
Gets the "substring-length" property.
|
long |
getTtlAge()
Gets the "ttl-age" property.
|
boolean |
isConfidentialityEnabled()
Gets the "confidentiality-enabled" property.
|
boolean |
isTtlEnabled()
Gets the "ttl-enabled" property.
|
void |
removeChangeListener(ConfigurationChangeListener<BackendIndexCfg> listener)
Deregister an existing Backend Index configuration change listener.
|
dn, name
Class<? extends BackendIndexCfg> configurationClass()
configurationClass
in interface Configuration
void addChangeListener(ConfigurationChangeListener<BackendIndexCfg> listener)
listener
- The Backend Index configuration change listener.void removeChangeListener(ConfigurationChangeListener<BackendIndexCfg> listener)
listener
- The Backend Index configuration change listener.AttributeType getAttribute()
Specifies the name of the attribute for which the index is to be maintained.
boolean isConfidentialityEnabled()
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.
Integer getIndexEntryLimit()
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.
SortedSet<String> getIndexExtensibleMatchingRule()
The extensible matching rule in an extensible index.
An extensible matching rule must be specified using either LOCALE or OID of the matching rule.
SortedSet<BackendIndexCfgDefn.IndexType> getIndexType()
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.
int getSubstringLength()
The length of substrings in a substring index.
long getTtlAge()
The age when timestamps are considered to have expired.
boolean isTtlEnabled()
Enable TTL for this generalized time index.
Copyright 2010-2018 ForgeRock AS.