You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tv...@apache.org on 2026/02/01 16:11:00 UTC
(commons-jcs) 03/06: Update documentation
This is an automated email from the ASF dual-hosted git repository.
tv pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-jcs.git
commit 72cf4f60d57b41ff8abcbde544abeefcd01787df
Author: Thomas Vandahl <tv...@apache.org>
AuthorDate: Sun Feb 1 16:59:05 2026 +0100
Update documentation
---
src/site/site.xml | 1 +
xdocs/ElementSerializers.xml | 26 +++++++++++++++++
xdocs/JDBCDiskCacheProperties.xml | 8 -----
xdocs/LateralJavaGroupsAuxCache.xml | 58 -------------------------------------
xdocs/LateralUDPDiscovery.xml | 2 +-
xdocs/UpgradingFrom2x.xml | 6 ++--
6 files changed, 31 insertions(+), 70 deletions(-)
diff --git a/src/site/site.xml b/src/site/site.xml
index f20628fa..ada2fa3c 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -33,6 +33,7 @@
<item name="Release Notes" href="/changes.html"/>
<item name="Upgrading from 1.3 to 2.0" href="/UpgradingFrom13.html"/>
<item name="Upgrading from 2.x to 3.0" href="/UpgradingFrom2x.html"/>
+ <item name="Upgrading from 3.x to 4.0.0" href="/UpgradingFrom3x.html"/>
<item name="Mailing Lists" href="/mail-lists.html"/>
<item name="Issue Tracking" href="/issue-tracking.html"/>
<item name="Source Repository" href="/scm.html"/>
diff --git a/xdocs/ElementSerializers.xml b/xdocs/ElementSerializers.xml
index bb778c6a..11c720a4 100644
--- a/xdocs/ElementSerializers.xml
+++ b/xdocs/ElementSerializers.xml
@@ -108,5 +108,31 @@ jcs.auxiliary.blockDiskCache2.serializer.attributes.aesCipherTransformation=AES/
the ones with good randomness (given that your environment generates entropy fast
enough, we saw problems with Linux).</p>
</section>
+ <section name="JSON Serializer">
+ <p> The <code>JSONSerializer</code> serializes the cache object to a UTF-8-encoded
+ JSON string. The Java class name information for de-serialization is preserved
+ in a separate <code>className</code> field. This serializer can be used to
+ exchange data between different platforms or when text representations are
+ required.</p>
+
+ <p> Note that for this to work properly, you need to open your data objects packages
+ to Jackson DataBind in your <code>module-info.java</code>:</p>
+ <source>
+ <![CDATA[
+opens your.package to com.fasterxml.jackson.databind;
+ ]]>
+ </source>
+
+ <p> The configuration for a typical application looks like this:</p>
+ <source>
+ <![CDATA[
+# Block Disk Cache
+jcs.auxiliary.blockDiskCache3=org.apache.commons.jcs4.auxiliary.disk.block.BlockDiskCacheFactory
+jcs.auxiliary.blockDiskCache3.attributes=org.apache.commons.jcs4.auxiliary.disk.block.BlockDiskCacheAttributes
+jcs.auxiliary.blockDiskCache3.attributes.DiskPath=target/test-sandbox/block-disk-cache3
+jcs.auxiliary.blockDiskCache3.serializer=org.apache.commons.jcs4.utils.serialization.JSONSerializer
+ ]]>
+ </source>
+ </section>
</body>
</document>
\ No newline at end of file
diff --git a/xdocs/JDBCDiskCacheProperties.xml b/xdocs/JDBCDiskCacheProperties.xml
index d39db32a..591f6ea2 100644
--- a/xdocs/JDBCDiskCacheProperties.xml
+++ b/xdocs/JDBCDiskCacheProperties.xml
@@ -61,13 +61,6 @@
<td></td>
</tr>
- <tr>
- <td>database</td>
- <td>This is appended to the url.</td>
- <td>N</td>
- <td></td>
- </tr>
-
<tr>
<td>driverClassName</td>
<td>
@@ -182,7 +175,6 @@ jcs.auxiliary.JDBC.attributes=org.apache.commons.jcs4.auxiliary.disk.jdbc.JDBCDi
jcs.auxiliary.JDBC.attributes.userName=sa
jcs.auxiliary.JDBC.attributes.password=
jcs.auxiliary.JDBC.attributes.url=jdbc:hsqldb:
-jcs.auxiliary.JDBC.attributes.database=target/cache_hsql_db
jcs.auxiliary.JDBC.attributes.driverClassName=org.hsqldb.jdbcDriver
jcs.auxiliary.JDBC.attributes.tableName=JCS_STORE2
jcs.auxiliary.JDBC.attributes.testBeforeInsert=false
diff --git a/xdocs/LateralJavaGroupsAuxCache.xml b/xdocs/LateralJavaGroupsAuxCache.xml
deleted file mode 100644
index 8ca86cb0..00000000
--- a/xdocs/LateralJavaGroupsAuxCache.xml
+++ /dev/null
@@ -1,58 +0,0 @@
-<?xml version="1.0"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- https://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<document>
- <properties>
- <title>Lateral JGroups Auxiliary Cache</title>
- <author email="ASmuts@apache.org">Aaron Smuts</author>
- </properties>
-
- <body>
- <section name="Lateral JGroups Auxiliary Cache">
- <p>
- The Lateral JGroups Auxiliary Cache is an optional plug in for
- JCS. It is primarily intended to broadcast puts and removals to
- other local caches, though it can also get cached objects. It uses JGroups
- for distribution.
- </p>
- <p>
- The Lateral JGroups Auxiliary Cache is far slower than
- that Lateral TCP Auxiliary Cache. Since the Lateral TCP Auxiliary
- is faster and has UDP discovery built in, the TCP auxiliary is the recommended form of lateral
- distribution. However, the JGroups Auxiliary requires fewer socket connections than
- the TCP lateral.
- </p>
- <p>
- A functional configuration example is below:
- </p>
-
- <source><![CDATA[
-# Lateral JavaGroups Distribution
-jcs.auxiliary.LJG=org.apache.commons.jcs4.auxiliary.lateral.LateralCacheFactory
-jcs.auxiliary.LJG.attributes=org.apache.commons.jcs4.auxiliary.lateral.LateralCacheAttributes
-jcs.auxiliary.LJG.attributes.TransmissionTypeName=JAVAGROUPS
-jcs.auxiliary.LJG.attributes.PutOnlyMode=true
-jcs.auxiliary.LJG.attributes.JGChannelProperties=UDP(mcast_addr=224.0.0.100;mcast_port=7501):PING:FD:STABLE:NAKACK:UNICAST:FRAG:FLUSH:GMS:QUEUE
- ]]></source>
-
-
- </section>
- </body>
-</document>
diff --git a/xdocs/LateralUDPDiscovery.xml b/xdocs/LateralUDPDiscovery.xml
index 15b6e589..63ae06d8 100644
--- a/xdocs/LateralUDPDiscovery.xml
+++ b/xdocs/LateralUDPDiscovery.xml
@@ -88,7 +88,7 @@ jcs.auxiliary.LTCP.attributes.UdpTTL=4
</p>
<p>
If the network interface is not specified, JCS tries to detect a
- suitable interface. The selected interface is logged on INFO level.
+ suitable interface. The selected interface is logged at INFO level.
Search for the message "Using network interface" in your log file.
</p>
<source><![CDATA[
diff --git a/xdocs/UpgradingFrom2x.xml b/xdocs/UpgradingFrom2x.xml
index 3c7899b2..69f4bc7a 100644
--- a/xdocs/UpgradingFrom2x.xml
+++ b/xdocs/UpgradingFrom2x.xml
@@ -45,7 +45,7 @@ import org.apache.commons.jcs.*;
]]></source>
with
<source><![CDATA[
-import org.apache.commons.jcs4.*;
+import org.apache.commons.jcs3.*;
]]></source>
The Maven coordinates change from
<source><![CDATA[
@@ -59,7 +59,7 @@ import org.apache.commons.jcs4.*;
<source><![CDATA[
<dependency>
<groupId>org.apache.commons</groupId>
- <artifactId>commons-jcs4-core</artifactId>
+ <artifactId>commons-jcs3-core</artifactId>
<version>3.0</version>
</dependency>
]]></source>
@@ -74,7 +74,7 @@ jcs.default.cacheattributes=org.apache.commons.jcs.engine.CompositeCacheAttribut
]]></source>
to
<source><![CDATA[
-jcs.default.cacheattributes=org.apache.commons.jcs4.engine.CompositeCacheAttributes
+jcs.default.cacheattributes=org.apache.commons.jcs3.engine.CompositeCacheAttributes
]]></source>
</p>
</subsection>