<?xml version="1.0" encoding="utf-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at
! trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
! add the following below this CDDL HEADER, with the fields enclosed
! by brackets "[]" replaced with your own identifying information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
!
! Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="fifo-entry-cache"
xmlns:ldap="http://www.opends.org/admin-ldap">
<adm:synopsis>
<adm:user-friendly-plural-name />
use a FIFO queue to keep track of the cached entries.
</adm:synopsis>
<adm:description>
Entries that have been in the cache the longest are the most likely
candidates for purging if space is needed. In contrast to other
cache structures, the selection of entries to purge is not based on
how frequently or recently the entries have been accessed. This
requires significantly less locking (it will only be required when
an entry is added or removed from the cache, rather than each time
an entry is accessed). Cache sizing is based on the percentage of
free memory within the JVM, such that if enough memory is free, then
adding an entry to the cache will not require purging, but if more
than a specified percentage of the available memory within the JVM
is already consumed, then one or more entries will need to be
removed in order to make room for a new entry. It is also possible
to configure a maximum number of entries for the cache. If this is
specified, then the number of entries will not be allowed to exceed
this value, but it may not be possible to hold this many entries if
the available memory fills up first. Other configurable parameters
for this cache include the maximum length of time to block while
waiting to acquire a lock, and a set of filters that may be used to
define criteria for determining which entries are stored in the
cache. If a filter list is provided, then only entries matching at
least one of the given filters will be stored in the cache.
</adm:description>
<adm:profile name="ldap">
<ldap:object-class>
<ldap:name>ds-cfg-fifo-entry-cache</ldap:name>
<ldap:superior>ds-cfg-entry-cache</ldap:superior>
</ldap:object-class>
</adm:profile>
<adm:property-override name="java-class" advanced="true">
<adm:default-behavior>
<adm:defined>
<adm:value>
</adm:value>
</adm:defined>
</adm:default-behavior>
</adm:property-override>
<adm:property name="lock-timeout" advanced="true">
<adm:synopsis>
Specifies the length of time to wait while attempting to acquire a read or
write lock.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
<adm:value>2000.0ms</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
<adm:duration base-unit="ms" lower-limit="0"
allow-unlimited="true" />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-lock-timeout</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="max-memory-percent">
<adm:synopsis>
Specifies the maximum memory usage for the entry cache as a percentage of
the total JVM memory.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
<adm:value>90</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
<adm:integer lower-limit="1" upper-limit="100" />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-max-memory-percent</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="max-entries">
<adm:synopsis>
Specifies the maximum number of entries that we will allow in the cache.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
<adm:value>2147483647</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
<adm:integer lower-limit="0" />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-max-entries</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property-reference name="include-filter" />
<adm:property-reference name="exclude-filter" />
</adm:managed-object>