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.client;
028    
029    
030    
031    import java.util.Collection;
032    import java.util.SortedSet;
033    import org.opends.server.admin.IllegalPropertyValueException;
034    import org.opends.server.admin.ManagedObjectDefinition;
035    import org.opends.server.admin.std.server.SoftReferenceEntryCacheCfg;
036    
037    
038    
039    /**
040     * A client-side interface for reading and modifying Soft Reference
041     * Entry Cache settings.
042     * <p>
043     * The Soft Reference Entry Cache is a Directory Server entry cache
044     * implementation that uses soft references to manage objects to allow
045     * them to be freed if the JVM is running low on memory.
046     */
047    public interface SoftReferenceEntryCacheCfgClient extends EntryCacheCfgClient {
048    
049      /**
050       * Get the configuration definition associated with this Soft Reference Entry Cache.
051       *
052       * @return Returns the configuration definition associated with this Soft Reference Entry Cache.
053       */
054      ManagedObjectDefinition<? extends SoftReferenceEntryCacheCfgClient, ? extends SoftReferenceEntryCacheCfg> definition();
055    
056    
057    
058      /**
059       * Gets the "exclude-filter" property.
060       * <p>
061       * The set of filters that define the entries that should be
062       * excluded from the cache.
063       *
064       * @return Returns the values of the "exclude-filter" property.
065       */
066      SortedSet<String> getExcludeFilter();
067    
068    
069    
070      /**
071       * Sets the "exclude-filter" property.
072       * <p>
073       * The set of filters that define the entries that should be
074       * excluded from the cache.
075       *
076       * @param values The values of the "exclude-filter" property.
077       * @throws IllegalPropertyValueException
078       *           If one or more of the new values are invalid.
079       */
080      void setExcludeFilter(Collection<String> values) throws IllegalPropertyValueException;
081    
082    
083    
084      /**
085       * Gets the "include-filter" property.
086       * <p>
087       * The set of filters that define the entries that should be
088       * included in the cache.
089       *
090       * @return Returns the values of the "include-filter" property.
091       */
092      SortedSet<String> getIncludeFilter();
093    
094    
095    
096      /**
097       * Sets the "include-filter" property.
098       * <p>
099       * The set of filters that define the entries that should be
100       * included in the cache.
101       *
102       * @param values The values of the "include-filter" property.
103       * @throws IllegalPropertyValueException
104       *           If one or more of the new values are invalid.
105       */
106      void setIncludeFilter(Collection<String> values) throws IllegalPropertyValueException;
107    
108    
109    
110      /**
111       * Gets the "java-class" property.
112       * <p>
113       * Specifies the fully-qualified name of the Java class that
114       * provides the Soft Reference Entry Cache implementation.
115       *
116       * @return Returns the value of the "java-class" property.
117       */
118      String getJavaClass();
119    
120    
121    
122      /**
123       * Sets the "java-class" property.
124       * <p>
125       * Specifies the fully-qualified name of the Java class that
126       * provides the Soft Reference Entry Cache implementation.
127       *
128       * @param value The value of the "java-class" property.
129       * @throws IllegalPropertyValueException
130       *           If the new value is invalid.
131       */
132      void setJavaClass(String value) throws IllegalPropertyValueException;
133    
134    
135    
136      /**
137       * Gets the "lock-timeout" property.
138       * <p>
139       * Specifies the length of time in milliseconds to wait while
140       * attempting to acquire a read or write lock.
141       *
142       * @return Returns the value of the "lock-timeout" property.
143       */
144      long getLockTimeout();
145    
146    
147    
148      /**
149       * Sets the "lock-timeout" property.
150       * <p>
151       * Specifies the length of time in milliseconds to wait while
152       * attempting to acquire a read or write lock.
153       *
154       * @param value The value of the "lock-timeout" property.
155       * @throws IllegalPropertyValueException
156       *           If the new value is invalid.
157       */
158      void setLockTimeout(Long value) throws IllegalPropertyValueException;
159    
160    }