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

Class BackendIndexCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<BackendIndexCfgClient,BackendIndexCfg>

org.forgerock.opendj.server.config.meta.BackendIndexCfgDefn

public final class BackendIndexCfgDefn
extends ManagedObjectDefinition<BackendIndexCfgClient,BackendIndexCfg>

An interface for querying the Backend Index managed object definition meta information.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BackendIndexCfgDefn.IndexType	Defines the set of permissible values for the "index-type" property.

Method Summary

Modifier and Type	Method	Description
BackendIndexCfgClient	createClientConfiguration(ManagedObject<? extends BackendIndexCfgClient> impl)	Creates a client configuration view of the provided managed object.
BackendIndexCfg	createServerConfiguration(ServerManagedObject<? extends BackendIndexCfg> impl)	Creates a server configuration view of the provided server managed object.
AttributeTypePropertyDefinition	getAttributePropertyDefinition()	Get the "attribute" property definition.
StringPropertyDefinition	getBigIndexExtensibleMatchingRulePropertyDefinition()	Get the "big-index-extensible-matching-rule" property definition.
StringPropertyDefinition	getBigIndexIncludedAttributeValuePropertyDefinition()	Get the "big-index-included-attribute-value" property definition.
BooleanPropertyDefinition	getConfidentialityEnabledPropertyDefinition()	Get the "confidentiality-enabled" property definition.
IntegerPropertyDefinition	getIndexEntryLimitPropertyDefinition()	Get the "index-entry-limit" property definition.
StringPropertyDefinition	getIndexExtensibleMatchingRulePropertyDefinition()	Get the "index-extensible-matching-rule" property definition.
EnumPropertyDefinition<BackendIndexCfgDefn.IndexType>	getIndexTypePropertyDefinition()	Get the "index-type" property definition.
static BackendIndexCfgDefn	getInstance()	Get the Backend Index configuration definition singleton.
Class<BackendIndexCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
IntegerPropertyDefinition	getSubstringLengthPropertyDefinition()	Get the "substring-length" property definition.
DurationPropertyDefinition	getTtlAgePropertyDefinition()	Get the "ttl-age" property definition.
BooleanPropertyDefinition	getTtlEnabledPropertyDefinition()	Get the "ttl-enabled" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static BackendIndexCfgDefn getInstance()

Get the Backend Index configuration definition singleton.

Returns:

Returns the Backend Index configuration definition singleton.

createClientConfiguration

public BackendIndexCfgClient createClientConfiguration(ManagedObject<? extends BackendIndexCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<BackendIndexCfgClient,BackendIndexCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public BackendIndexCfg createServerConfiguration(ServerManagedObject<? extends BackendIndexCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<BackendIndexCfgClient,BackendIndexCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<BackendIndexCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<BackendIndexCfgClient,BackendIndexCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getAttributePropertyDefinition

public AttributeTypePropertyDefinition getAttributePropertyDefinition()

Get the "attribute" property definition.

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

Returns:

Returns the "attribute" property definition.

getBigIndexExtensibleMatchingRulePropertyDefinition

public StringPropertyDefinition getBigIndexExtensibleMatchingRulePropertyDefinition()

Get the "big-index-extensible-matching-rule" property definition.

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 "big-index-extensible-matching-rule" property definition.

getBigIndexIncludedAttributeValuePropertyDefinition

public StringPropertyDefinition getBigIndexIncludedAttributeValuePropertyDefinition()

Get the "big-index-included-attribute-value" property definition.

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 "big-index-included-attribute-value" property definition.

getConfidentialityEnabledPropertyDefinition

public BooleanPropertyDefinition getConfidentialityEnabledPropertyDefinition()

Get the "confidentiality-enabled" property definition.

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.

Returns:

Returns the "confidentiality-enabled" property definition.

getIndexEntryLimitPropertyDefinition

public IntegerPropertyDefinition getIndexEntryLimitPropertyDefinition()

Get the "index-entry-limit" property definition.

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.

Returns:

Returns the "index-entry-limit" property definition.

getIndexExtensibleMatchingRulePropertyDefinition

public StringPropertyDefinition getIndexExtensibleMatchingRulePropertyDefinition()

Get the "index-extensible-matching-rule" property definition.

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 "index-extensible-matching-rule" property definition.

getIndexTypePropertyDefinition

public EnumPropertyDefinition<BackendIndexCfgDefn.IndexType> getIndexTypePropertyDefinition()

Get the "index-type" property definition.

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 "index-type" property definition.

getSubstringLengthPropertyDefinition

public IntegerPropertyDefinition getSubstringLengthPropertyDefinition()

Get the "substring-length" property definition.

The length of substrings in a substring index.

Returns:

Returns the "substring-length" property definition.

getTtlAgePropertyDefinition

public DurationPropertyDefinition getTtlAgePropertyDefinition()

Get the "ttl-age" property definition.

The age when timestamps are considered to have expired.

Returns:

Returns the "ttl-age" property definition.

getTtlEnabledPropertyDefinition

public BooleanPropertyDefinition getTtlEnabledPropertyDefinition()

Get the "ttl-enabled" property definition.

Enable TTL for this generalized time index.

Returns:

Returns the "ttl-enabled" property definition.