001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.client;
017
018
019
020import java.util.Collection;
021import java.util.SortedSet;
022import org.forgerock.opendj.config.ManagedObjectDefinition;
023import org.forgerock.opendj.config.PropertyException;
024import org.forgerock.opendj.server.config.server.SoftReferenceEntryCacheCfg;
025
026
027
028/**
029 * A client-side interface for reading and modifying Soft Reference
030 * Entry Cache settings.
031 * <p>
032 * The Soft Reference Entry Cache is a directory server entry cache
033 * implementation that uses soft references to manage objects to allow
034 * them to be freed if the JVM is running low on memory.
035 */
036public interface SoftReferenceEntryCacheCfgClient extends EntryCacheCfgClient {
037
038  /**
039   * Get the configuration definition associated with this Soft Reference Entry Cache.
040   *
041   * @return Returns the configuration definition associated with this Soft Reference Entry Cache.
042   */
043  ManagedObjectDefinition<? extends SoftReferenceEntryCacheCfgClient, ? extends SoftReferenceEntryCacheCfg> definition();
044
045
046
047  /**
048   * Gets the "exclude-filter" property.
049   * <p>
050   * The set of filters that define the entries that should be
051   * excluded from the cache.
052   *
053   * @return Returns the values of the "exclude-filter" property.
054   */
055  SortedSet<String> getExcludeFilter();
056
057
058
059  /**
060   * Sets the "exclude-filter" property.
061   * <p>
062   * The set of filters that define the entries that should be
063   * excluded from the cache.
064   *
065   * @param values The values of the "exclude-filter" property.
066   * @throws PropertyException
067   *           If one or more of the new values are invalid.
068   */
069  void setExcludeFilter(Collection<String> values) throws PropertyException;
070
071
072
073  /**
074   * Gets the "include-filter" property.
075   * <p>
076   * The set of filters that define the entries that should be
077   * included in the cache.
078   *
079   * @return Returns the values of the "include-filter" property.
080   */
081  SortedSet<String> getIncludeFilter();
082
083
084
085  /**
086   * Sets 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   * @param values The values of the "include-filter" property.
092   * @throws PropertyException
093   *           If one or more of the new values are invalid.
094   */
095  void setIncludeFilter(Collection<String> values) throws PropertyException;
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   * Sets the "java-class" property.
113   * <p>
114   * Specifies the fully-qualified name of the Java class that
115   * provides the Soft Reference Entry Cache implementation.
116   *
117   * @param value The value of the "java-class" property.
118   * @throws PropertyException
119   *           If the new value is invalid.
120   */
121  void setJavaClass(String value) throws PropertyException;
122
123
124
125  /**
126   * Gets the "lock-timeout" property.
127   * <p>
128   * Specifies the length of time in milliseconds to wait while
129   * attempting to acquire a read or write lock.
130   *
131   * @return Returns the value of the "lock-timeout" property.
132   */
133  long getLockTimeout();
134
135
136
137  /**
138   * Sets the "lock-timeout" property.
139   * <p>
140   * Specifies the length of time in milliseconds to wait while
141   * attempting to acquire a read or write lock.
142   *
143   * @param value The value of the "lock-timeout" property.
144   * @throws PropertyException
145   *           If the new value is invalid.
146   */
147  void setLockTimeout(Long value) throws PropertyException;
148
149}