org.opends.server.admin.std.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 Summary

Methods

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends BackendIndexCfgClient,? extends BackendIndexCfg>	definition() Get the configuration definition 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.
void	setAttribute(AttributeType value) Sets the "attribute" property.
void	setIndexEntryLimit(Integer value) Sets the "index-entry-limit" property.
void	setIndexExtensibleMatchingRule(Collection<String> values) Sets the "index-extensible-matching-rule" property.
void	setIndexType(Collection<BackendIndexCfgDefn.IndexType> values) Sets the "index-type" property.
void	setSubstringLength(Integer value) Sets the "substring-length" property.

Methods inherited from interface org.opends.server.admin.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends BackendIndexCfgClient,? extends BackendIndexCfg> definition()

Get the configuration definition associated with this Backend Index.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Backend Index.

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.

setAttribute

void setAttribute(AttributeType value)
                  throws PropertyException,
                         PropertyException

Sets the "attribute" property.

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.

Parameters:

value - The value of the "attribute" property.

Throws:

PropertyException - If the new value is invalid.

PropertyException - If this Backend Index is not being initialized.

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.

Returns:

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

setIndexEntryLimit

void setIndexEntryLimit(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.

Parameters:

value - The value of the "index-entry-limit" property.

Throws:

PropertyException - If the new value is invalid.

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

setIndexExtensibleMatchingRule

void setIndexExtensibleMatchingRule(Collection<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

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

setIndexType

void setIndexType(Collection<BackendIndexCfgDefn.IndexType> values)
                  throws PropertyException

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

Parameters:

values - The values of the "index-type" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getSubstringLength

int getSubstringLength()

Gets the "substring-length" property.

The length of substrings in a substring index.

Returns:

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

setSubstringLength

void setSubstringLength(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.