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.server; 017 018 019 020import org.forgerock.opendj.config.Configuration; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022 023 024 025/** 026 * A server-side interface for querying Entry Cache settings. 027 * <p> 028 * Entry Caches are responsible for caching entries which are likely 029 * to be accessed by client applications in order to improve OpenDJ 030 * directory server performance. 031 */ 032public interface EntryCacheCfg extends Configuration { 033 034 /** 035 * Gets the configuration class associated with this Entry Cache. 036 * 037 * @return Returns the configuration class associated with this Entry Cache. 038 */ 039 Class<? extends EntryCacheCfg> configurationClass(); 040 041 042 043 /** 044 * Register to be notified when this Entry Cache is changed. 045 * 046 * @param listener 047 * The Entry Cache configuration change listener. 048 */ 049 void addChangeListener(ConfigurationChangeListener<EntryCacheCfg> listener); 050 051 052 053 /** 054 * Deregister an existing Entry Cache configuration change listener. 055 * 056 * @param listener 057 * The Entry Cache configuration change listener. 058 */ 059 void removeChangeListener(ConfigurationChangeListener<EntryCacheCfg> listener); 060 061 062 063 /** 064 * Gets the "cache-level" property. 065 * <p> 066 * Specifies the cache level in the cache order if more than one 067 * instance of the cache is configured. 068 * 069 * @return Returns the value of the "cache-level" property. 070 */ 071 int getCacheLevel(); 072 073 074 075 /** 076 * Gets the "enabled" property. 077 * <p> 078 * Indicates whether the Entry Cache is enabled. 079 * 080 * @return Returns the value of the "enabled" property. 081 */ 082 boolean isEnabled(); 083 084 085 086 /** 087 * Gets the "java-class" property. 088 * <p> 089 * Specifies the fully-qualified name of the Java class that 090 * provides the Entry Cache implementation. 091 * 092 * @return Returns the value of the "java-class" property. 093 */ 094 String getJavaClass(); 095 096}