public interface BackendIndexCfgClient extends ConfigurationClient
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 |
---|---|
ManagedObjectDefinition<? extends BackendIndexCfgClient,? extends BackendIndexCfg> |
definition()
Get the configuration definition associated with this Backend Index.
|
ValueOrExpression<AttributeType> |
getAttribute()
Gets the "attribute" property.
|
ValueOrExpression<Integer> |
getIndexEntryLimit()
Gets the "index-entry-limit" property.
|
SortedSet<ValueOrExpression<String>> |
getIndexExtensibleMatchingRule()
Gets the "index-extensible-matching-rule" property.
|
SortedSet<ValueOrExpression<BackendIndexCfgDefn.IndexType>> |
getIndexType()
Gets the "index-type" property.
|
ValueOrExpression<Integer> |
getSubstringLength()
Gets the "substring-length" property.
|
ValueOrExpression<Long> |
getTtlAge()
Gets the "ttl-age" property.
|
ValueOrExpression<Boolean> |
isConfidentialityEnabled()
Gets the "confidentiality-enabled" property.
|
ValueOrExpression<Boolean> |
isTtlEnabled()
Gets the "ttl-enabled" property.
|
void |
setAttribute(ValueOrExpression<AttributeType> value)
Sets the "attribute" property.
|
void |
setConfidentialityEnabled(ValueOrExpression<Boolean> value)
Sets the "confidentiality-enabled" property.
|
void |
setIndexEntryLimit(ValueOrExpression<Integer> value)
Sets the "index-entry-limit" property.
|
void |
setIndexExtensibleMatchingRule(Collection<ValueOrExpression<String>> values)
Sets the "index-extensible-matching-rule" property.
|
void |
setIndexType(Collection<ValueOrExpression<BackendIndexCfgDefn.IndexType>> values)
Sets the "index-type" property.
|
void |
setSubstringLength(ValueOrExpression<Integer> value)
Sets the "substring-length" property.
|
void |
setTtlAge(ValueOrExpression<Long> value)
Sets the "ttl-age" property.
|
void |
setTtlEnabled(ValueOrExpression<Boolean> value)
Sets the "ttl-enabled" property.
|
commit, properties
ManagedObjectDefinition<? extends BackendIndexCfgClient,? extends BackendIndexCfg> definition()
definition
in interface ConfigurationClient
ValueOrExpression<AttributeType> getAttribute()
Specifies the name of the attribute for which the index is to be maintained.
void setAttribute(ValueOrExpression<AttributeType> value) throws PropertyException, PropertyException
Specifies the name of the attribute for which the index is to be maintained.
This property is read-only and can only be modified during creation of a Backend Index.
value
- The value of the "attribute" property.PropertyException
- If the new value is invalid.PropertyException
- If this Backend Index is not being initialized.ValueOrExpression<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.
void setConfidentialityEnabled(ValueOrExpression<Boolean> value) throws PropertyException
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.
value
- The value of the "confidentiality-enabled" property.PropertyException
- If the new value is invalid.ValueOrExpression<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.
void setIndexEntryLimit(ValueOrExpression<Integer> value) throws PropertyException
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.
value
- The value of the "index-entry-limit" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<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.
void setIndexExtensibleMatchingRule(Collection<ValueOrExpression<String>> values) throws PropertyException
The extensible matching rule in an extensible index.
An extensible matching rule must be specified using either LOCALE or OID of the matching rule.
values
- The values of the "index-extensible-matching-rule" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<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.
void setIndexType(Collection<ValueOrExpression<BackendIndexCfgDefn.IndexType>> values) throws PropertyException
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.
values
- The values of the "index-type" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Integer> getSubstringLength()
The length of substrings in a substring index.
void setSubstringLength(ValueOrExpression<Integer> value) throws PropertyException
The length of substrings in a substring index.
value
- The value of the "substring-length" property.PropertyException
- If the new value is invalid.ValueOrExpression<Long> getTtlAge()
The age when timestamps are considered to have expired.
void setTtlAge(ValueOrExpression<Long> value) throws PropertyException
The age when timestamps are considered to have expired.
value
- The value of the "ttl-age" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isTtlEnabled()
Enable TTL for this generalized time index.
void setTtlEnabled(ValueOrExpression<Boolean> value) throws PropertyException
Enable TTL for this generalized time index.
value
- The value of the "ttl-enabled" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.