public interface BackendVLVIndexCfg extends Configuration
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 | Method and Description |
---|---|
void |
addChangeListener(ConfigurationChangeListener<BackendVLVIndexCfg> listener)
Register to be notified when this Backend VLV Index is changed.
|
Class<? extends BackendVLVIndexCfg> |
configurationClass()
Gets the configuration class associated with this Backend VLV Index.
|
DN |
getBaseDN()
Gets the "base-dn" property.
|
String |
getFilter()
Gets the "filter" property.
|
String |
getName()
Gets the "name" property.
|
BackendVLVIndexCfgDefn.Scope |
getScope()
Gets the "scope" property.
|
String |
getSortOrder()
Gets the "sort-order" property.
|
void |
removeChangeListener(ConfigurationChangeListener<BackendVLVIndexCfg> listener)
Deregister an existing Backend VLV Index configuration change listener.
|
dn
Class<? extends BackendVLVIndexCfg> configurationClass()
configurationClass
in interface Configuration
void addChangeListener(ConfigurationChangeListener<BackendVLVIndexCfg> listener)
listener
- The Backend VLV Index configuration change listener.void removeChangeListener(ConfigurationChangeListener<BackendVLVIndexCfg> listener)
listener
- The Backend VLV Index configuration change listener.DN getBaseDN()
Specifies the base DN used in the search query that is being indexed.
String getFilter()
Specifies the LDAP filter used in the query that is being indexed.
String getName()
Specifies a unique name for this VLV index.
BackendVLVIndexCfgDefn.Scope getScope()
Specifies the LDAP scope of the query that is being indexed.
String getSortOrder()
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-2017 ForgeRock AS.