org.opends.server.admin.std.meta
Class LocalDBIndexCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<LocalDBIndexCfgClient,LocalDBIndexCfg>
          extended by org.opends.server.admin.std.meta.LocalDBIndexCfgDefn

public final class LocalDBIndexCfgDefn
extends ManagedObjectDefinition<LocalDBIndexCfgClient,LocalDBIndexCfg>

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

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


Nested Class Summary
static class LocalDBIndexCfgDefn.IndexType
          Defines the set of permissable values for the "index-type" property.
 
Method Summary
 LocalDBIndexCfgClient createClientConfiguration(ManagedObject<? extends LocalDBIndexCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 LocalDBIndexCfg createServerConfiguration(ServerManagedObject<? extends LocalDBIndexCfg> impl)
          Creates a server configuration view of the provided server managed object.
 AttributeTypePropertyDefinition getAttributePropertyDefinition()
          Get the "attribute" property definition.
 IntegerPropertyDefinition getIndexEntryLimitPropertyDefinition()
          Get the "index-entry-limit" property definition.
 EnumPropertyDefinition<LocalDBIndexCfgDefn.IndexType> getIndexTypePropertyDefinition()
          Get the "index-type" property definition.
static LocalDBIndexCfgDefn getInstance()
          Get the Local DB Index configuration definition singleton.
 java.lang.Class<LocalDBIndexCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 IntegerPropertyDefinition getSubstringLengthPropertyDefinition()
          Get the "substring-length" property definition.
 
Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, 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 LocalDBIndexCfgDefn getInstance()
Get the Local DB Index configuration definition singleton.

Returns:
Returns the Local DB Index configuration definition singleton.

createClientConfiguration

public LocalDBIndexCfgClient createClientConfiguration(ManagedObject<? extends LocalDBIndexCfgClient> impl)
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<LocalDBIndexCfgClient,LocalDBIndexCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public LocalDBIndexCfg createServerConfiguration(ServerManagedObject<? extends LocalDBIndexCfg> impl)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<LocalDBIndexCfgClient,LocalDBIndexCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<LocalDBIndexCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<LocalDBIndexCfgClient,LocalDBIndexCfg>
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.

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.

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

getIndexTypePropertyDefinition

public EnumPropertyDefinition<LocalDBIndexCfgDefn.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.