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    
034    
035    
036    /**
037     * A server-side interface for querying Entry Cache settings.
038     * <p>
039     * Entry Caches are responsible for caching entries which are likely
040     * to be accessed by client applications in order to improve Directory
041     * Server performance.
042     */
043    public interface EntryCacheCfg extends Configuration {
044    
045      /**
046       * Gets the configuration class associated with this Entry Cache.
047       *
048       * @return Returns the configuration class associated with this Entry Cache.
049       */
050      Class<? extends EntryCacheCfg> configurationClass();
051    
052    
053    
054      /**
055       * Register to be notified when this Entry Cache is changed.
056       *
057       * @param listener
058       *          The Entry Cache configuration change listener.
059       */
060      void addChangeListener(ConfigurationChangeListener<EntryCacheCfg> listener);
061    
062    
063    
064      /**
065       * Deregister an existing Entry Cache configuration change listener.
066       *
067       * @param listener
068       *          The Entry Cache configuration change listener.
069       */
070      void removeChangeListener(ConfigurationChangeListener<EntryCacheCfg> listener);
071    
072    
073    
074      /**
075       * Gets the "cache-level" property.
076       * <p>
077       * Specifies the cache level in the cache order if more than one
078       * instance of the cache is configured.
079       *
080       * @return Returns the value of the "cache-level" property.
081       */
082      int getCacheLevel();
083    
084    
085    
086      /**
087       * Gets the "enabled" property.
088       * <p>
089       * Indicates whether the Entry Cache is enabled.
090       *
091       * @return Returns the value of the "enabled" property.
092       */
093      boolean isEnabled();
094    
095    
096    
097      /**
098       * Gets the "java-class" property.
099       * <p>
100       * Specifies the fully-qualified name of the Java class that
101       * provides the Entry Cache implementation.
102       *
103       * @return Returns the value of the "java-class" property.
104       */
105      String getJavaClass();
106    
107    }