[exo-jcr-commits] exo-jcr SVN: r2038 - jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/kernel.
do-not-reply at jboss.org
do-not-reply at jboss.org
Mon Mar 8 06:16:15 EST 2010
Author: nfilotto
Date: 2010-03-08 06:16:14 -0500 (Mon, 08 Mar 2010)
New Revision: 2038
Modified:
jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/kernel/cache.xml
Log:
EXOJCR-576
Modified: jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/kernel/cache.xml
===================================================================
--- jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/kernel/cache.xml 2010-03-05 16:17:20 UTC (rev 2037)
+++ jcr/trunk/docs/reference/en/src/main/docbook/en-US/modules/kernel/cache.xml 2010-03-08 11:16:14 UTC (rev 2038)
@@ -137,7 +137,7 @@
</tgroup>
</table>
- <para> </para>
+ <para></para>
</section>
<section>
@@ -377,8 +377,8 @@
<name>LRU</name>
<description>The lru cache creator</description>
<object type="org.exoplatform.services.cache.impl.jboss.lru.LRUExoCacheCreator">
- <field name="defaultTimeToLive"><long>${my-value}</long></field>
- <field name="defaultMaxAge"><long>${my-value}</long></field>
+ <field name="defaultTimeToLive"><long>${my-value}</long></field>
+ <field name="defaultMaxAge"><long>${my-value}</long></field>
</object>
</object-param>
...</programlisting>
@@ -394,8 +394,8 @@
<entry>This is the default value of the field
<emphasis>timeToLive</emphasis> described in the section
dedicated to this cache type. This value is only use when we
- defined a cache of this type with the super type
- <envar>ExoCacheConfig</envar>.</entry>
+ define a cache of this type with the old
+ configuration.</entry>
</row>
<row>
@@ -404,8 +404,8 @@
<entry>his is the default value of the field
<emphasis>maxAge</emphasis> described in the section
dedicated to this cache type. This value is only use when we
- defined a cache of this type with the super type
- <envar>ExoCacheConfig</envar>.</entry>
+ define a cache of this type with the old
+ configuration.</entry>
</row>
</tbody>
</tgroup>
@@ -444,7 +444,7 @@
<name>LFU</name>
<description>The lfu cache creator</description>
<object type="org.exoplatform.services.cache.impl.jboss.lfu.LFUExoCacheCreator">
- <field name="defaultMinNodes"><int>${my-value}</int></field>
+ <field name="defaultMinNodes"><int>${my-value}</int></field>
</object>
</object-param>
...</programlisting>
@@ -460,13 +460,45 @@
<entry>This is the default value of the field
<emphasis>minNodes</emphasis> described in the section
dedicated to this cache type. This value is only use when we
- defined a cache of this type with the super type
- <envar>ExoCacheConfig</envar>.</entry>
+ define a cache of this type with the old
+ configuration.</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
+
+ <section>
+ <title>EA Cache Creator - Expiration Algorithm</title>
+
+ <programlisting>...
+<object-param>
+ <name>EA</name>
+ <description>The ea cache creator</description>
+ <object type="org.exoplatform.services.cache.impl.jboss.ea.EAExoCacheCreator">
+ <field name="defaultExpirationTimeout"><long>2000</long></field>
+ </object>
+</object-param>
+...</programlisting>
+
+ <table>
+ <title>Fields description</title>
+
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>defaultExpirationTimeout</entry>
+
+ <entry>This is the default value of the field
+ <emphasis>minNodes</emphasis> described in the section
+ dedicated to this cache type. This value is only use when we
+ define a cache of this type with the old
+ configuration.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
</section>
</section>
@@ -476,7 +508,7 @@
<section>
<title>How to define a cache?</title>
- <para>You have 2 ways to define a cache which are: </para>
+ <para>You have 2 ways to define a cache which are:</para>
<itemizedlist>
<listitem>
@@ -952,6 +984,105 @@
</listitem>
</itemizedlist>
</section>
+
+ <section>
+ <title>EA Cache - Expiration Algorithm</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>New configuration<programlisting>...
+ <object-param>
+ <name>ea</name>
+ <description>The ea cache configuration</description>
+ <object type="org.exoplatform.services.cache.impl.jboss.ea.EAExoCacheConfig">
+ <field name="name"><string>ea</string></field>
+ <field name="maxNodes"><int>${my-value}</int></field>
+ <field name="minTimeToLive"><long>${my-value}</long></field>
+ <field name="expirationTimeout"><long>${my-value}</long></field>
+ </object>
+ </object-param>
+...</programlisting></para>
+
+ <table>
+ <title>Fields description</title>
+
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>maxNodes</entry>
+
+ <entry>This is the maximum number of nodes allowed in this
+ region. 0 denotes immediate expiry, -1 denotes no
+ limit.</entry>
+ </row>
+
+ <row>
+ <entry>minTimeToLive</entry>
+
+ <entry>The minimum amount of time (in milliseconds) a node
+ must be allowed to live after being accessed before it is
+ allowed to be considered for eviction. 0 denotes that this
+ feature is disabled, which is the default value.</entry>
+ </row>
+
+ <row>
+ <entry>expirationTimeout</entry>
+
+ <entry>This is the timeout after which the cache entry
+ must be evicted.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Old configuration<programlisting>...
+ <object-param>
+ <name>ea-with-old-config</name>
+ <description>The ea cache configuration</description>
+ <object type="org.exoplatform.services.cache.ExoCacheConfig">
+ <field name="name"><string>lfu-with-old-config</string></field>
+ <field name="maxSize"><int>${my-value}</int></field>
+ <field name="liveTime"><long>${my-value}</long></field>
+ <field name="implementation"><string>EA</string></field>
+ </object>
+ </object-param>
+...</programlisting></para>
+
+ <table>
+ <title>Fields description</title>
+
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>maxSize</entry>
+
+ <entry>This is the maximum number of nodes allowed in this
+ region. 0 denotes immediate expiry, -1 denotes no
+ limit.</entry>
+ </row>
+
+ <row>
+ <entry>liveTime</entry>
+
+ <entry>The minimum amount of time (in milliseconds) a node
+ must be allowed to live after being accessed before it is
+ allowed to be considered for eviction. 0 denotes that this
+ feature is disabled, which is the default value.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para><note>
+ <para>For the fields <emphasis>expirationTimeout</emphasis>
+ needed by JBoss cache, we will use the default values provided
+ by the creator.</para>
+ </note></para>
+ </listitem>
+ </itemizedlist>
+ </section>
</section>
</section>
</chapter>
More information about the exo-jcr-commits
mailing list