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