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