001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2008 Sun Microsystems, Inc. 025 */ 026package org.opends.server.admin.std.server; 027 028 029 030import org.opends.server.admin.Configuration; 031import org.opends.server.admin.server.ConfigurationChangeListener; 032import org.opends.server.admin.std.meta.BackendVLVIndexCfgDefn.Scope; 033import org.opends.server.types.DN; 034 035 036 037/** 038 * A server-side interface for querying Backend VLV Index settings. 039 * <p> 040 * Backend VLV Indexes are used to store information about a specific 041 * search request that makes it possible to efficiently process them 042 * using the VLV control. 043 */ 044public interface BackendVLVIndexCfg extends Configuration { 045 046 /** 047 * Gets the configuration class associated with this Backend VLV Index. 048 * 049 * @return Returns the configuration class associated with this Backend VLV Index. 050 */ 051 Class<? extends BackendVLVIndexCfg> configurationClass(); 052 053 054 055 /** 056 * Register to be notified when this Backend VLV Index is changed. 057 * 058 * @param listener 059 * The Backend VLV Index configuration change listener. 060 */ 061 void addChangeListener(ConfigurationChangeListener<BackendVLVIndexCfg> listener); 062 063 064 065 /** 066 * Deregister an existing Backend VLV Index configuration change listener. 067 * 068 * @param listener 069 * The Backend VLV Index configuration change listener. 070 */ 071 void removeChangeListener(ConfigurationChangeListener<BackendVLVIndexCfg> listener); 072 073 074 075 /** 076 * Gets the "base-dn" property. 077 * <p> 078 * Specifies the base DN used in the search query that is being 079 * indexed. 080 * 081 * @return Returns the value of the "base-dn" property. 082 */ 083 DN getBaseDN(); 084 085 086 087 /** 088 * Gets the "filter" property. 089 * <p> 090 * Specifies the LDAP filter used in the query that is being 091 * indexed. 092 * 093 * @return Returns the value of the "filter" property. 094 */ 095 String getFilter(); 096 097 098 099 /** 100 * Gets the "name" property. 101 * <p> 102 * Specifies a unique name for this VLV index. 103 * 104 * @return Returns the value of the "name" property. 105 */ 106 String getName(); 107 108 109 110 /** 111 * Gets the "scope" property. 112 * <p> 113 * Specifies the LDAP scope of the query that is being indexed. 114 * 115 * @return Returns the value of the "scope" property. 116 */ 117 Scope getScope(); 118 119 120 121 /** 122 * Gets the "sort-order" property. 123 * <p> 124 * Specifies the names of the attributes that are used to sort the 125 * entries for the query being indexed. 126 * <p> 127 * Multiple attributes can be used to determine the sort order by 128 * listing the attribute names from highest to lowest precedence. 129 * Optionally, + or - can be prefixed to the attribute name to sort 130 * the attribute in ascending order or descending order respectively. 131 * 132 * @return Returns the value of the "sort-order" property. 133 */ 134 String getSortOrder(); 135 136}