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

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<LocalDBVLVIndexCfgClient,LocalDBVLVIndexCfg>
          extended by org.opends.server.admin.std.meta.LocalDBVLVIndexCfgDefn

public final class LocalDBVLVIndexCfgDefn
extends ManagedObjectDefinition<LocalDBVLVIndexCfgClient,LocalDBVLVIndexCfg>

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

Local DB VLV Indexes are used to store information about a specific search request that makes it possible to efficiently process them using the VLV control.


Nested Class Summary
static class LocalDBVLVIndexCfgDefn.Scope
          Defines the set of permissable values for the "scope" property.
 
Method Summary
 LocalDBVLVIndexCfgClient createClientConfiguration(ManagedObject<? extends LocalDBVLVIndexCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 LocalDBVLVIndexCfg createServerConfiguration(ServerManagedObject<? extends LocalDBVLVIndexCfg> impl)
          Creates a server configuration view of the provided server managed object.
 DNPropertyDefinition getBaseDNPropertyDefinition()
          Get the "base-dn" property definition.
 StringPropertyDefinition getFilterPropertyDefinition()
          Get the "filter" property definition.
static LocalDBVLVIndexCfgDefn getInstance()
          Get the Local DB VLV Index configuration definition singleton.
 IntegerPropertyDefinition getMaxBlockSizePropertyDefinition()
          Get the "max-block-size" property definition.
 StringPropertyDefinition getNamePropertyDefinition()
          Get the "name" property definition.
 EnumPropertyDefinition<LocalDBVLVIndexCfgDefn.Scope> getScopePropertyDefinition()
          Get the "scope" property definition.
 java.lang.Class<LocalDBVLVIndexCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 StringPropertyDefinition getSortOrderPropertyDefinition()
          Get the "sort-order" 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 LocalDBVLVIndexCfgDefn getInstance()
Get the Local DB VLV Index configuration definition singleton.

Returns:
Returns the Local DB VLV Index configuration definition singleton.

createClientConfiguration

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

createServerConfiguration

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

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

getServerConfigurationClass

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

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<LocalDBVLVIndexCfgClient,LocalDBVLVIndexCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getBaseDNPropertyDefinition

public DNPropertyDefinition getBaseDNPropertyDefinition()
Get the "base-dn" property definition.

Specifies the base DN used in the search query that is being indexed.

Returns:
Returns the "base-dn" property definition.

getFilterPropertyDefinition

public StringPropertyDefinition getFilterPropertyDefinition()
Get the "filter" property definition.

Specifies the LDAP filter used in the query that is being indexed.

Returns:
Returns the "filter" property definition.

getMaxBlockSizePropertyDefinition

public IntegerPropertyDefinition getMaxBlockSizePropertyDefinition()
Get the "max-block-size" property definition.

Specifies the number of entry IDs to store in a single sorted set before it must be split.

Returns:
Returns the "max-block-size" property definition.

getNamePropertyDefinition

public StringPropertyDefinition getNamePropertyDefinition()
Get the "name" property definition.

Specifies a unique name for this VLV index.

Returns:
Returns the "name" property definition.

getScopePropertyDefinition

public EnumPropertyDefinition<LocalDBVLVIndexCfgDefn.Scope> getScopePropertyDefinition()
Get the "scope" property definition.

Specifies the LDAP scope of the query that is being indexed.

Returns:
Returns the "scope" property definition.

getSortOrderPropertyDefinition

public StringPropertyDefinition getSortOrderPropertyDefinition()
Get the "sort-order" property definition.

Specifies the names of the attributes that are used to sort the entries for the query being indexed.

Multiple attributes can be used to determine the sort order by listing the attribute names from highest to lowest precedence. Optionally, + or - can be prefixed to the attribute name to sort the attribute in ascending order or descending order respectively.

Returns:
Returns the "sort-order" property definition.