public final class BackendVLVIndexCfgDefn extends ManagedObjectDefinition<BackendVLVIndexCfgClient,BackendVLVIndexCfg>
Backend VLV Indexes are used to store information about a specific search request that makes it possible to efficiently process them using the VLV control.
Modifier and Type | Class and Description |
---|---|
static class |
BackendVLVIndexCfgDefn.Scope
Defines the set of permissable values for the "scope" property.
|
Modifier and Type | Method and Description |
---|---|
BackendVLVIndexCfgClient |
createClientConfiguration(ManagedObject<? extends BackendVLVIndexCfgClient> impl)
Creates a client configuration view of the provided managed
object.
|
BackendVLVIndexCfg |
createServerConfiguration(ServerManagedObject<? extends BackendVLVIndexCfg> 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 BackendVLVIndexCfgDefn |
getInstance()
Get the Backend VLV Index configuration definition singleton.
|
StringPropertyDefinition |
getNamePropertyDefinition()
Get the "name" property definition.
|
EnumPropertyDefinition<BackendVLVIndexCfgDefn.Scope> |
getScopePropertyDefinition()
Get the "scope" property definition.
|
Class<BackendVLVIndexCfg> |
getServerConfigurationClass()
Gets the server configuration class instance associated with this
managed object definition.
|
StringPropertyDefinition |
getSortOrderPropertyDefinition()
Get the "sort-order" property definition.
|
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
public static BackendVLVIndexCfgDefn getInstance()
public BackendVLVIndexCfgClient createClientConfiguration(ManagedObject<? extends BackendVLVIndexCfgClient> impl)
createClientConfiguration
in class ManagedObjectDefinition<BackendVLVIndexCfgClient,BackendVLVIndexCfg>
impl
- The managed object.public BackendVLVIndexCfg createServerConfiguration(ServerManagedObject<? extends BackendVLVIndexCfg> impl)
createServerConfiguration
in class ManagedObjectDefinition<BackendVLVIndexCfgClient,BackendVLVIndexCfg>
impl
- The server managed object.public Class<BackendVLVIndexCfg> getServerConfigurationClass()
getServerConfigurationClass
in class ManagedObjectDefinition<BackendVLVIndexCfgClient,BackendVLVIndexCfg>
public DNPropertyDefinition getBaseDNPropertyDefinition()
Specifies the base DN used in the search query that is being indexed.
public StringPropertyDefinition getFilterPropertyDefinition()
Specifies the LDAP filter used in the query that is being indexed.
public StringPropertyDefinition getNamePropertyDefinition()
Specifies a unique name for this VLV index.
public EnumPropertyDefinition<BackendVLVIndexCfgDefn.Scope> getScopePropertyDefinition()
Specifies the LDAP scope of the query that is being indexed.
public StringPropertyDefinition getSortOrderPropertyDefinition()
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.
Copyright © 2010-2016 ForgeRock AS. All Rights Reserved.