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 Soft Reference Entry Cache 027 * settings. 028 * <p> 029 * The Soft Reference Entry Cache is a directory server entry cache 030 * implementation that uses soft references to manage objects to allow 031 * them to be freed if the JVM is running low on memory. 032 */ 033public interface SoftReferenceEntryCacheCfg extends EntryCacheCfg { 034 035 /** 036 * Gets the configuration class associated with this Soft Reference Entry Cache. 037 * 038 * @return Returns the configuration class associated with this Soft Reference Entry Cache. 039 */ 040 Class<? extends SoftReferenceEntryCacheCfg> configurationClass(); 041 042 043 044 /** 045 * Register to be notified when this Soft Reference Entry Cache is changed. 046 * 047 * @param listener 048 * The Soft Reference Entry Cache configuration change listener. 049 */ 050 void addSoftReferenceChangeListener(ConfigurationChangeListener<SoftReferenceEntryCacheCfg> listener); 051 052 053 054 /** 055 * Deregister an existing Soft Reference Entry Cache configuration change listener. 056 * 057 * @param listener 058 * The Soft Reference Entry Cache configuration change listener. 059 */ 060 void removeSoftReferenceChangeListener(ConfigurationChangeListener<SoftReferenceEntryCacheCfg> listener); 061 062 063 064 /** 065 * Gets the "exclude-filter" property. 066 * <p> 067 * The set of filters that define the entries that should be 068 * excluded from the cache. 069 * 070 * @return Returns an unmodifiable set containing the values of the "exclude-filter" property. 071 */ 072 SortedSet<String> getExcludeFilter(); 073 074 075 076 /** 077 * Gets the "include-filter" property. 078 * <p> 079 * The set of filters that define the entries that should be 080 * included in the cache. 081 * 082 * @return Returns an unmodifiable set containing the values of the "include-filter" property. 083 */ 084 SortedSet<String> getIncludeFilter(); 085 086 087 088 /** 089 * Gets the "java-class" property. 090 * <p> 091 * Specifies the fully-qualified name of the Java class that 092 * provides the Soft Reference Entry Cache implementation. 093 * 094 * @return Returns the value of the "java-class" property. 095 */ 096 String getJavaClass(); 097 098 099 100 /** 101 * Gets the "lock-timeout" property. 102 * <p> 103 * Specifies the length of time in milliseconds to wait while 104 * attempting to acquire a read or write lock. 105 * 106 * @return Returns the value of the "lock-timeout" property. 107 */ 108 long getLockTimeout(); 109 110}