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 org.opends.server.admin.Configuration;
032    import org.opends.server.admin.server.ConfigurationChangeListener;
033    import org.opends.server.admin.std.meta.LocalDBVLVIndexCfgDefn.Scope;
034    import org.opends.server.types.DN;
035    
036    
037    
038    /**
039     * A server-side interface for querying Local DB VLV Index settings.
040     * <p>
041     * Local DB VLV Indexes are used to store information about a specific
042     * search request that makes it possible to efficiently process them
043     * using the VLV control.
044     */
045    public interface LocalDBVLVIndexCfg extends Configuration {
046    
047      /**
048       * Gets the configuration class associated with this Local DB VLV Index.
049       *
050       * @return Returns the configuration class associated with this Local DB VLV Index.
051       */
052      Class<? extends LocalDBVLVIndexCfg> configurationClass();
053    
054    
055    
056      /**
057       * Register to be notified when this Local DB VLV Index is changed.
058       *
059       * @param listener
060       *          The Local DB VLV Index configuration change listener.
061       */
062      void addChangeListener(ConfigurationChangeListener<LocalDBVLVIndexCfg> listener);
063    
064    
065    
066      /**
067       * Deregister an existing Local DB VLV Index configuration change listener.
068       *
069       * @param listener
070       *          The Local DB VLV Index configuration change listener.
071       */
072      void removeChangeListener(ConfigurationChangeListener<LocalDBVLVIndexCfg> listener);
073    
074    
075    
076      /**
077       * Gets the "base-dn" property.
078       * <p>
079       * Specifies the base DN used in the search query that is being
080       * indexed.
081       *
082       * @return Returns the value of the "base-dn" property.
083       */
084      DN getBaseDN();
085    
086    
087    
088      /**
089       * Gets the "filter" property.
090       * <p>
091       * Specifies the LDAP filter used in the query that is being
092       * indexed.
093       *
094       * @return Returns the value of the "filter" property.
095       */
096      String getFilter();
097    
098    
099    
100      /**
101       * Gets the "max-block-size" property.
102       * <p>
103       * Specifies the number of entry IDs to store in a single sorted set
104       * before it must be split.
105       *
106       * @return Returns the value of the "max-block-size" property.
107       */
108      int getMaxBlockSize();
109    
110    
111    
112      /**
113       * Gets the "name" property.
114       * <p>
115       * Specifies a unique name for this VLV index.
116       *
117       * @return Returns the value of the "name" property.
118       */
119      String getName();
120    
121    
122    
123      /**
124       * Gets the "scope" property.
125       * <p>
126       * Specifies the LDAP scope of the query that is being indexed.
127       *
128       * @return Returns the value of the "scope" property.
129       */
130      Scope getScope();
131    
132    
133    
134      /**
135       * Gets the "sort-order" property.
136       * <p>
137       * Specifies the names of the attributes that are used to sort the
138       * entries for the query being indexed.
139       * <p>
140       * Multiple attributes can be used to determine the sort order by
141       * listing the attribute names from highest to lowest precedence.
142       * Optionally, + or - can be prefixed to the attribute name to sort
143       * the attribute in ascending order or descending order respectively.
144       *
145       * @return Returns the value of the "sort-order" property.
146       */
147      String getSortOrder();
148    
149    }