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