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
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.server;
028
029
030
031 import java.util.SortedSet;
032 import org.opends.server.admin.Configuration;
033 import org.opends.server.admin.server.ConfigurationChangeListener;
034 import org.opends.server.admin.std.meta.LocalDBIndexCfgDefn.IndexType;
035 import org.opends.server.types.AttributeType;
036
037
038
039 /**
040 * A server-side interface for querying Local DB Index settings.
041 * <p>
042 * Local DB Indexes are used to store information that makes it
043 * possible to locate entries very quickly when processing search
044 * operations.
045 */
046 public interface LocalDBIndexCfg extends Configuration {
047
048 /**
049 * Gets the configuration class associated with this Local DB Index.
050 *
051 * @return Returns the configuration class associated with this Local DB Index.
052 */
053 Class<? extends LocalDBIndexCfg> configurationClass();
054
055
056
057 /**
058 * Register to be notified when this Local DB Index is changed.
059 *
060 * @param listener
061 * The Local DB Index configuration change listener.
062 */
063 void addChangeListener(ConfigurationChangeListener<LocalDBIndexCfg> listener);
064
065
066
067 /**
068 * Deregister an existing Local DB Index configuration change listener.
069 *
070 * @param listener
071 * The Local DB Index configuration change listener.
072 */
073 void removeChangeListener(ConfigurationChangeListener<LocalDBIndexCfg> listener);
074
075
076
077 /**
078 * Gets the "attribute" property.
079 * <p>
080 * Specifies the name of the attribute for which the index is to be
081 * maintained.
082 *
083 * @return Returns the value of the "attribute" property.
084 */
085 AttributeType getAttribute();
086
087
088
089 /**
090 * Gets the "index-entry-limit" property.
091 * <p>
092 * Specifies the maximum number of entries that are allowed to match
093 * a given index key before that particular index key is no longer
094 * maintained.
095 * <p>
096 * This is analogous to the ALL IDs threshold in the Sun Java System
097 * Directory Server. If this is specified, its value overrides the JE
098 * backend-wide configuration. For no limit, use 0 for the value.
099 *
100 * @return Returns the value of the "index-entry-limit" property.
101 */
102 Integer getIndexEntryLimit();
103
104
105
106 /**
107 * Gets the "index-type" property.
108 * <p>
109 * Specifies the type(s) of indexing that should be performed for
110 * the associated attribute.
111 * <p>
112 * For equality, presence, and substring index types, the associated
113 * attribute type must have a corresponding matching rule.
114 *
115 * @return Returns an unmodifiable set containing the values of the "index-type" property.
116 */
117 SortedSet<IndexType> getIndexType();
118
119
120
121 /**
122 * Gets the "substring-length" property.
123 * <p>
124 * The length of substrings in a substring index.
125 *
126 * @return Returns the value of the "substring-length" property.
127 */
128 int getSubstringLength();
129
130 }