org.opends.server.admin.std.server
Interface LocalDBVLVIndexCfg

All Superinterfaces:
Configuration

public interface LocalDBVLVIndexCfg
extends Configuration

A server-side interface for querying Local DB VLV Index settings.

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.


Method Summary
 void addChangeListener(ConfigurationChangeListener<LocalDBVLVIndexCfg> listener)
          Register to be notified when this Local DB VLV Index is changed.
 java.lang.Class<? extends LocalDBVLVIndexCfg> configurationClass()
          Gets the configuration class associated with this Local DB VLV Index.
 DN getBaseDN()
          Gets the "base-dn" property.
 java.lang.String getFilter()
          Gets the "filter" property.
 int getMaxBlockSize()
          Gets the "max-block-size" property.
 java.lang.String getName()
          Gets the "name" property.
 LocalDBVLVIndexCfgDefn.Scope getScope()
          Gets the "scope" property.
 java.lang.String getSortOrder()
          Gets the "sort-order" property.
 void removeChangeListener(ConfigurationChangeListener<LocalDBVLVIndexCfg> listener)
          Deregister an existing Local DB VLV Index configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends LocalDBVLVIndexCfg> configurationClass()
Gets the configuration class associated with this Local DB VLV Index.

Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Local DB VLV Index.

addChangeListener

void addChangeListener(ConfigurationChangeListener<LocalDBVLVIndexCfg> listener)
Register to be notified when this Local DB VLV Index is changed.

Parameters:
listener - The Local DB VLV Index configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<LocalDBVLVIndexCfg> listener)
Deregister an existing Local DB VLV Index configuration change listener.

Parameters:
listener - The Local DB VLV Index configuration change listener.

getBaseDN

DN getBaseDN()
Gets the "base-dn" property.

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

Returns:
Returns the value of the "base-dn" property.

getFilter

java.lang.String getFilter()
Gets the "filter" property.

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

Returns:
Returns the value of the "filter" property.

getMaxBlockSize

int getMaxBlockSize()
Gets the "max-block-size" property.

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

Returns:
Returns the value of the "max-block-size" property.

getName

java.lang.String getName()
Gets the "name" property.

Specifies a unique name for this VLV index.

Returns:
Returns the value of the "name" property.

getScope

LocalDBVLVIndexCfgDefn.Scope getScope()
Gets the "scope" property.

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

Returns:
Returns the value of the "scope" property.

getSortOrder

java.lang.String getSortOrder()
Gets the "sort-order" property.

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 value of the "sort-order" property.