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 FIFO Entry Cache settings.
038     * <p>
039     * FIFO Entry Caches use a FIFO queue to keep track of the cached
040     * entries.
041     */
042    public interface FIFOEntryCacheCfg extends EntryCacheCfg {
043    
044      /**
045       * Gets the configuration class associated with this FIFO Entry Cache.
046       *
047       * @return Returns the configuration class associated with this FIFO Entry Cache.
048       */
049      Class<? extends FIFOEntryCacheCfg> configurationClass();
050    
051    
052    
053      /**
054       * Register to be notified when this FIFO Entry Cache is changed.
055       *
056       * @param listener
057       *          The FIFO Entry Cache configuration change listener.
058       */
059      void addFIFOChangeListener(ConfigurationChangeListener<FIFOEntryCacheCfg> listener);
060    
061    
062    
063      /**
064       * Deregister an existing FIFO Entry Cache configuration change listener.
065       *
066       * @param listener
067       *          The FIFO Entry Cache configuration change listener.
068       */
069      void removeFIFOChangeListener(ConfigurationChangeListener<FIFOEntryCacheCfg> listener);
070    
071    
072    
073      /**
074       * Gets the "exclude-filter" property.
075       * <p>
076       * The set of filters that define the entries that should be
077       * excluded from the cache.
078       *
079       * @return Returns an unmodifiable set containing the values of the "exclude-filter" property.
080       */
081      SortedSet<String> getExcludeFilter();
082    
083    
084    
085      /**
086       * Gets the "include-filter" property.
087       * <p>
088       * The set of filters that define the entries that should be
089       * included in the cache.
090       *
091       * @return Returns an unmodifiable set containing the values of the "include-filter" property.
092       */
093      SortedSet<String> getIncludeFilter();
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 FIFO Entry Cache implementation.
102       *
103       * @return Returns the value of the "java-class" property.
104       */
105      String getJavaClass();
106    
107    
108    
109      /**
110       * Gets the "lock-timeout" property.
111       * <p>
112       * Specifies the length of time to wait while attempting to acquire
113       * a read or write lock.
114       *
115       * @return Returns the value of the "lock-timeout" property.
116       */
117      long getLockTimeout();
118    
119    
120    
121      /**
122       * Gets the "max-entries" property.
123       * <p>
124       * Specifies the maximum number of entries that we will allow in the
125       * cache.
126       *
127       * @return Returns the value of the "max-entries" property.
128       */
129      int getMaxEntries();
130    
131    
132    
133      /**
134       * Gets the "max-memory-percent" property.
135       * <p>
136       * Specifies the maximum memory usage for the entry cache as a
137       * percentage of the total JVM memory.
138       *
139       * @return Returns the value of the "max-memory-percent" property.
140       */
141      int getMaxMemoryPercent();
142    
143    }