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 java.util.SortedSet; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022 023 024 025/** 026 * A server-side interface for querying FIFO Entry Cache settings. 027 * <p> 028 * FIFO Entry Caches use a FIFO queue to keep track of the cached 029 * entries. 030 */ 031public interface FIFOEntryCacheCfg extends EntryCacheCfg { 032 033 /** 034 * Gets the configuration class associated with this FIFO Entry Cache. 035 * 036 * @return Returns the configuration class associated with this FIFO Entry Cache. 037 */ 038 Class<? extends FIFOEntryCacheCfg> configurationClass(); 039 040 041 042 /** 043 * Register to be notified when this FIFO Entry Cache is changed. 044 * 045 * @param listener 046 * The FIFO Entry Cache configuration change listener. 047 */ 048 void addFIFOChangeListener(ConfigurationChangeListener<FIFOEntryCacheCfg> listener); 049 050 051 052 /** 053 * Deregister an existing FIFO Entry Cache configuration change listener. 054 * 055 * @param listener 056 * The FIFO Entry Cache configuration change listener. 057 */ 058 void removeFIFOChangeListener(ConfigurationChangeListener<FIFOEntryCacheCfg> listener); 059 060 061 062 /** 063 * Gets the "exclude-filter" property. 064 * <p> 065 * The set of filters that define the entries that should be 066 * excluded from the cache. 067 * 068 * @return Returns an unmodifiable set containing the values of the "exclude-filter" property. 069 */ 070 SortedSet<String> getExcludeFilter(); 071 072 073 074 /** 075 * Gets the "include-filter" property. 076 * <p> 077 * The set of filters that define the entries that should be 078 * included in the cache. 079 * 080 * @return Returns an unmodifiable set containing the values of the "include-filter" property. 081 */ 082 SortedSet<String> getIncludeFilter(); 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 FIFO Entry Cache implementation. 091 * 092 * @return Returns the value of the "java-class" property. 093 */ 094 String getJavaClass(); 095 096 097 098 /** 099 * Gets the "lock-timeout" property. 100 * <p> 101 * Specifies the length of time to wait while attempting to acquire 102 * a read or write lock. 103 * 104 * @return Returns the value of the "lock-timeout" property. 105 */ 106 long getLockTimeout(); 107 108 109 110 /** 111 * Gets the "max-entries" property. 112 * <p> 113 * Specifies the maximum number of entries that we will allow in the 114 * cache. 115 * 116 * @return Returns the value of the "max-entries" property. 117 */ 118 int getMaxEntries(); 119 120 121 122 /** 123 * Gets the "max-memory-percent" property. 124 * <p> 125 * Specifies the maximum percentage of JVM memory used by the server 126 * before the entry caches stops caching and begins purging itself. 127 * <p> 128 * Very low settings such as 10 or 20 (percent) can prevent this 129 * entry cache from having enough space to hold any of the entries to 130 * cache, making it appear that the server is ignoring or skipping 131 * the entry cache entirely. 132 * 133 * @return Returns the value of the "max-memory-percent" property. 134 */ 135 int getMaxMemoryPercent(); 136 137}