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