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 org.forgerock.opendj.config.ConfigurationClient;
021import org.forgerock.opendj.config.ManagedObjectDefinition;
022import org.forgerock.opendj.config.PropertyException;
023import org.forgerock.opendj.server.config.server.EntryCacheCfg;
024
025
026
027/**
028 * A client-side interface for reading and modifying Entry Cache
029 * settings.
030 * <p>
031 * Entry Caches are responsible for caching entries which are likely
032 * to be accessed by client applications in order to improve OpenDJ
033 * directory server performance.
034 */
035public interface EntryCacheCfgClient extends ConfigurationClient {
036
037  /**
038   * Get the configuration definition associated with this Entry Cache.
039   *
040   * @return Returns the configuration definition associated with this Entry Cache.
041   */
042  ManagedObjectDefinition<? extends EntryCacheCfgClient, ? extends EntryCacheCfg> definition();
043
044
045
046  /**
047   * Gets the "cache-level" property.
048   * <p>
049   * Specifies the cache level in the cache order if more than one
050   * instance of the cache is configured.
051   *
052   * @return Returns the value of the "cache-level" property.
053   */
054  Integer getCacheLevel();
055
056
057
058  /**
059   * Sets the "cache-level" property.
060   * <p>
061   * Specifies the cache level in the cache order if more than one
062   * instance of the cache is configured.
063   *
064   * @param value The value of the "cache-level" property.
065   * @throws PropertyException
066   *           If the new value is invalid.
067   */
068  void setCacheLevel(int value) throws PropertyException;
069
070
071
072  /**
073   * Gets the "enabled" property.
074   * <p>
075   * Indicates whether the Entry Cache is enabled.
076   *
077   * @return Returns the value of the "enabled" property.
078   */
079  Boolean isEnabled();
080
081
082
083  /**
084   * Sets the "enabled" property.
085   * <p>
086   * Indicates whether the Entry Cache is enabled.
087   *
088   * @param value The value of the "enabled" property.
089   * @throws PropertyException
090   *           If the new value is invalid.
091   */
092  void setEnabled(boolean value) throws PropertyException;
093
094
095
096  /**
097   * Gets the "java-class" property.
098   * <p>
099   * Specifies the fully-qualified name of the Java class that
100   * provides the Entry Cache implementation.
101   *
102   * @return Returns the value of the "java-class" property.
103   */
104  String getJavaClass();
105
106
107
108  /**
109   * Sets the "java-class" property.
110   * <p>
111   * Specifies the fully-qualified name of the Java class that
112   * provides the Entry Cache implementation.
113   *
114   * @param value The value of the "java-class" property.
115   * @throws PropertyException
116   *           If the new value is invalid.
117   */
118  void setJavaClass(String value) throws PropertyException;
119
120}