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 java.util.SortedSet;
031import org.opends.server.admin.server.ConfigurationChangeListener;
032
033
034
035/**
036 * A server-side interface for querying Soft Reference Entry Cache
037 * settings.
038 * <p>
039 * The Soft Reference Entry Cache is a directory server entry cache
040 * implementation that uses soft references to manage objects to allow
041 * them to be freed if the JVM is running low on memory.
042 */
043public interface SoftReferenceEntryCacheCfg extends EntryCacheCfg {
044
045  /**
046   * Gets the configuration class associated with this Soft Reference Entry Cache.
047   *
048   * @return Returns the configuration class associated with this Soft Reference Entry Cache.
049   */
050  Class<? extends SoftReferenceEntryCacheCfg> configurationClass();
051
052
053
054  /**
055   * Register to be notified when this Soft Reference Entry Cache is changed.
056   *
057   * @param listener
058   *          The Soft Reference Entry Cache configuration change listener.
059   */
060  void addSoftReferenceChangeListener(ConfigurationChangeListener<SoftReferenceEntryCacheCfg> listener);
061
062
063
064  /**
065   * Deregister an existing Soft Reference Entry Cache configuration change listener.
066   *
067   * @param listener
068   *          The Soft Reference Entry Cache configuration change listener.
069   */
070  void removeSoftReferenceChangeListener(ConfigurationChangeListener<SoftReferenceEntryCacheCfg> listener);
071
072
073
074  /**
075   * Gets the "exclude-filter" property.
076   * <p>
077   * The set of filters that define the entries that should be
078   * excluded from the cache.
079   *
080   * @return Returns an unmodifiable set containing the values of the "exclude-filter" property.
081   */
082  SortedSet<String> getExcludeFilter();
083
084
085
086  /**
087   * Gets the "include-filter" property.
088   * <p>
089   * The set of filters that define the entries that should be
090   * included in the cache.
091   *
092   * @return Returns an unmodifiable set containing the values of the "include-filter" property.
093   */
094  SortedSet<String> getIncludeFilter();
095
096
097
098  /**
099   * Gets the "java-class" property.
100   * <p>
101   * Specifies the fully-qualified name of the Java class that
102   * provides the Soft Reference Entry Cache implementation.
103   *
104   * @return Returns the value of the "java-class" property.
105   */
106  String getJavaClass();
107
108
109
110  /**
111   * Gets the "lock-timeout" property.
112   * <p>
113   * Specifies the length of time in milliseconds to wait while
114   * attempting to acquire a read or write lock.
115   *
116   * @return Returns the value of the "lock-timeout" property.
117   */
118  long getLockTimeout();
119
120}