Added: dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/org/apache/commons/jcs/jcache/package-summary.html ============================================================================== --- dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/org/apache/commons/jcs/jcache/package-summary.html (added) +++ dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/org/apache/commons/jcs/jcache/package-summary.html Thu Aug 23 13:34:28 2018 @@ -0,0 +1,74 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> + <title>Apache Commons JCS :: JCache TCK 2.2.1 Reference Package org.apache.commons.jcs.jcache</title> + <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" /> + </head> + <body> + <div class="overview"> + <ul> + <li> + <a href="../../../../../overview-summary.html">Overview</a> + </li> + <li class="selected">Package</li> + </ul> + </div> + <div class="framenoframe"> + <ul> + <li> + <a href="../../../../../index.html" target="_top">FRAMES</a> + </li> + <li> + <a href="package-summary.html" target="_top">NO FRAMES</a> + </li> + </ul> + </div> + + <h2>Package org.apache.commons.jcs.jcache</h2> + + <table class="summary"> + <thead> + <tr> + <th>Class Summary</th> + </tr> + </thead> + <tbody> + <tr> + <td> + <a href="EnsureCDIIsTestedWhenTCKsRunTest.html" target="classFrame">EnsureCDIIsTestedWhenTCKsRunTest</a> + </td> + </tr> + <tr> + <td> + <a href="OWBBeanProvider.html" target="classFrame">OWBBeanProvider</a> + </td> + </tr> + </tbody> + </table> + + <div class="overview"> + <ul> + <li> + <a href="../../../../../overview-summary.html">Overview</a> + </li> + <li class="selected">Package</li> + </ul> + </div> + <div class="framenoframe"> + <ul> + <li> + <a href="../../../../../index.html" target="_top">FRAMES</a> + </li> + <li> + <a href="package-summary.html" target="_top">NO FRAMES</a> + </li> + </ul> + </div> + <hr /> + <div id="footer"> + Copyright © 2002–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved. + </div> + </body> +</html> \ No newline at end of file
Added: dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/overview-frame.html ============================================================================== --- dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/overview-frame.html (added) +++ dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/overview-frame.html Thu Aug 23 13:34:28 2018 @@ -0,0 +1,25 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> + <title>Apache Commons JCS :: JCache TCK 2.2.1 Reference</title> + <link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" /> + </head> + <body> + + <h3> + <a href="allclasses-frame.html" target="packageFrame">All Classes</a> + </h3> + + <h3>Packages</h3> + + <ul> + <li> + <a href="org/apache/commons/jcs/jcache/package-frame.html" target="packageFrame">org.apache.commons.jcs.jcache</a> + </li> + </ul> + + </body> +</html> + Added: dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/overview-summary.html ============================================================================== --- dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/overview-summary.html (added) +++ dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/overview-summary.html Thu Aug 23 13:34:28 2018 @@ -0,0 +1,66 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> + <title>Apache Commons JCS :: JCache TCK 2.2.1 Reference</title> + <link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" /> + </head> + <body> + <div class="overview"> + <ul> + <li class="selected">Overview</li> + <li>Package</li> + </ul> + </div> + <div class="framenoframe"> + <ul> + <li> + <a href="index.html" target="_top">FRAMES</a> + </li> + <li> + <a href="overview-summary.html" target="_top">NO FRAMES</a> + </li> + </ul> + </div> + + <h2>Apache Commons JCS :: JCache TCK 2.2.1 Reference</h2> + + <table class="summary"> + <thead> + <tr> + <th>Packages</th> + </tr> + </thead> + <tbody> + <tr> + <td> + <a href="org/apache/commons/jcs/jcache/package-summary.html">org.apache.commons.jcs.jcache</a> + </td> + </tr> + </tbody> + </table> + + <div class="overview"> + <ul> + <li class="selected">Overview</li> + <li>Package</li> + </ul> + </div> + <div class="framenoframe"> + <ul> + <li> + <a href="index.html" target="_top">FRAMES</a> + </li> + <li> + <a href="overview-summary.html" target="_top">NO FRAMES</a> + </li> + </ul> + </div> + + <hr /> + <div id="footer"> + Copyright © 2002–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved. + </div> + </body> +</html> \ No newline at end of file Added: dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/stylesheet.css ============================================================================== --- dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/stylesheet.css (added) +++ dev/commons/jcs/site-2.2.1-RC4/commons-jcs-jcache-tck/xref-test/stylesheet.css Thu Aug 23 13:34:28 2018 @@ -0,0 +1,114 @@ +/* Javadoc style sheet */ +/* Define colors, fonts and other style attributes here to override the defaults */ +body { + background-color: #fff; + font-family: Arial, Helvetica, sans-serif; +} + +a:link { + color: #00f; +} +a:visited { + color: #00a; +} + +a:active, a:hover { + color: #f30 !important; +} + +ul, li { + list-style-type:none; + margin:0; + padding:0; +} + +table td { + padding: 3px; + border: 1px solid #000; +} +table { + width:100%; + border: 1px solid #000; + border-collapse: collapse; +} + +div.overview { + background-color:#ddd; + padding: 4px 4px 4px 0; +} +div.overview li, div.framenoframe li { + display: inline; +} +div.framenoframe { + text-align: center; + font-size: x-small; +} +div.framenoframe li { + margin: 0 3px 0 3px; +} +div.overview li { + margin:3px 3px 0 3px; + padding: 4px; +} +li.selected { + background-color:#888; + color: #fff; + font-weight: bold; +} + +table.summary { + margin-bottom: 20px; +} +table.summary td, table.summary th { + font-weight: bold; + text-align: left; + padding: 3px; +} +table.summary th { + background-color:#036; + color: #fff; +} +table.summary td { + background-color:#eee; + border: 1px solid black; +} + +em { + color: #A00; +} +em.comment { + color: #390; +} +.string { + color: #009; +} + +#overview { + padding:2px; +} + +hr { + height: 1px; + color: #000; +} + +/* JXR style sheet */ +.jxr_comment +{ + color: #390; +} + +.jxr_javadoccomment +{ + color: #A00; +} + +.jxr_string +{ + color: #009; +} + +.jxr_keyword +{ + color: #000; +} Added: dev/commons/jcs/site-2.2.1-RC4/download_jcs.cgi ============================================================================== --- dev/commons/jcs/site-2.2.1-RC4/download_jcs.cgi (added) +++ dev/commons/jcs/site-2.2.1-RC4/download_jcs.cgi Thu Aug 23 13:34:28 2018 @@ -0,0 +1,21 @@ +#!/bin/sh + +# 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 +# +# http://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. + + +# Just call the standard mirrors.cgi script. It will use download.html +# as the input template. +exec /www/www.apache.org/dyn/mirrors/mirrors.cgi $* Added: dev/commons/jcs/site-2.2.1-RC4/getting_started/intro.html ============================================================================== --- dev/commons/jcs/site-2.2.1-RC4/getting_started/intro.html (added) +++ dev/commons/jcs/site-2.2.1-RC4/getting_started/intro.html Thu Aug 23 13:34:28 2018 @@ -0,0 +1,624 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 23 August 2018 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="author" content="Aaron Smuts" /> + <meta name="Date-Revision-yyyymmdd" content="20180823" /> + <meta http-equiv="Content-Language" content="en" /> + <title>JCS – Getting Started -- Introduction</title> + + <link rel="stylesheet" href="../css/bootstrap.min.css" type="text/css" /> + <link rel="stylesheet" href="../css/site.css" type="text/css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + <script type="text/javascript" src="../js/jquery.min.js"></script> + <script type="text/javascript" src="../js/bootstrap.min.js"></script> + <script type="text/javascript" src="../js/prettify.min.js"></script> + <script type="text/javascript" src="../js/site.js"></script> + + + </head> + + <body class="composite"> + <a href="http://commons.apache.org/"; id="bannerLeft" title="Apache Commons logo"> + <img class="logo-left" src="../images/commons-logo.png" alt="Apache Commons logo"/> + </a> + <a href="../index.html" id="bannerRight"> + <h2>Commons JCSâ¢</h2> + </a> + <div class="clear"></div> + + <div class="navbar"> + <div class="navbar-inner"> + <div class="container-fluid"> + <a class="brand" href="http://commons.apache.org/proper/commons-jcs/";>Apache Commons JCS ™</a> + <ul class="nav"> + + <li id="publishDate">Last Published: 23 August 2018</li> + <li class="divider">|</li> <li id="projectVersion">Version: 2.2.1</li> + </ul> + <div class="pull-right"> <ul class="nav"> + <li> + <a href="http://www.apachecon.com/"; class="externalLink" title="ApacheCon"> + ApacheCon</a> + </li> + <li> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li> + <a href="../../../" title="Commons"> + Commons</a> + </li> + </ul> +</div> + </div> + </div> + </div> + + <div class="container-fluid"> + <table class="layout-table"> + <tr> + <td class="sidebar"> + <div class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">JCS</li> + <li class="none"> + <a href="../index.html" title="Overview"> + Overview</a> + </li> + <li class="none"> + <a href="../JCSandJCACHE.html" title="JCS and JCACHE"> + JCS and JCACHE</a> + </li> + <li class="none"> + <a href="../download_jcs.cgi" title="Downloads"> + Downloads</a> + </li> + <li class="none"> + <a href="../faq.html" title="FAQ"> + FAQ</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header"><i class="icon-cog"></i>Development</li> + <li class="none"> + <a href="../changes-report.html" title="Release Notes"> + Release Notes</a> + </li> + <li class="none"> + <a href="../UpgradingFrom13.html" title="Upgrading from 1.3 to 2.0"> + Upgrading from 1.3 to 2.0</a> + </li> + <li class="none"> + <a href="../mail-lists.html" title="Mailing Lists"> + Mailing Lists</a> + </li> + <li class="none"> + <a href="../issue-tracking.html" title="Issue Tracking"> + Issue Tracking</a> + </li> + <li class="none"> + <a href="../source-repository.html" title="Source Repository"> + Source Repository</a> + </li> + <li class="none"> + <a href="../commons-jcs-core/apidocs/index.html" title="Core Javadoc (SVN latest)"> + Core Javadoc (SVN latest)</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">Getting Started</li> + <li class="none active"> + <a href="../getting_started/intro.html" title="Overview"> + Overview</a> + </li> + <li class="none"> + <a href="../BasicJCSConfiguration.html" title="Basic JCS Config"> + Basic JCS Config</a> + </li> + <li class="none"> + <a href="../JCSPlugins.html" title="Plugin Overview"> + Plugin Overview</a> + </li> + <li class="none"> + <a href="../UsingJCSBasicWeb.html" title="Basic Web Example"> + Basic Web Example</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">JCS User's Guide</li> + <li class="collapsed"> + <a href="../LocalCacheConfig.html" title="Core"> + Core</a> + </li> + <li class="collapsed"> + <a href="../JCSPlugins.html" title="Auxiliary"> + Auxiliary</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">Modules</li> + <li class="none"> + <a href="../commons-jcs-core/index.html" title="Apache Commons JCS :: Core"> + Apache Commons JCS :: Core</a> + </li> + <li class="none"> + <a href="../commons-jcs-jcache/index.html" title="Apache Commons JCS :: JCache"> + Apache Commons JCS :: JCache</a> + </li> + <li class="none"> + <a href="../commons-jcs-jcache-tck/index.html" title="Apache Commons JCS :: JCache TCK"> + Apache Commons JCS :: JCache TCK</a> + </li> + <li class="none"> + <a href="../commons-jcs-jcache-extras/index.html" title="Apache Commons JCS :: JCache Extras"> + Apache Commons JCS :: JCache Extras</a> + </li> + <li class="none"> + <a href="../commons-jcs-jcache-openjpa/index.html" title="Apache Commons JCS :: JCache OpenJPA"> + Apache Commons JCS :: JCache OpenJPA</a> + </li> + <li class="none"> + <a href="../commons-jcs-dist/index.html" title="Apache Commons JCS :: Distribution"> + Apache Commons JCS :: Distribution</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li> + <li class="collapsed"> + <a href="../project-info.html" title="Project Information"> + Project Information</a> + </li> + <li class="collapsed"> + <a href="../project-reports.html" title="Project Reports"> + Project Reports</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">Commons</li> + <li class="none"> + <a href="../../../" title="Home"> + Home</a> + </li> + <li class="none"> + <a href="http://www.apache.org/licenses/"; class="externalLink" title="License"> + License</a> + </li> + <li class="collapsed"> + <a href="../../../components.html" title="Components"> + Components</a> + </li> + <li class="collapsed"> + <a href="../../../sandbox/index.html" title="Sandbox"> + Sandbox</a> + </li> + <li class="collapsed"> + <a href="../../../dormant/index.html" title="Dormant"> + Dormant</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">General Information</li> + <li class="none"> + <a href="../../../security.html" title="Security"> + Security</a> + </li> + <li class="none"> + <a href="../../../volunteering.html" title="Volunteering"> + Volunteering</a> + </li> + <li class="none"> + <a href="../../../patches.html" title="Contributing Patches"> + Contributing Patches</a> + </li> + <li class="none"> + <a href="../../../building.html" title="Building Components"> + Building Components</a> + </li> + <li class="none"> + <a href="../../../commons-parent-pom.html" title="Commons Parent Pom"> + Commons Parent Pom</a> + </li> + <li class="none"> + <a href="../../../build-plugin/index.html" title="Commons Build Plugin"> + Commons Build Plugin</a> + </li> + <li class="none"> + <a href="../../../releases/index.html" title="Releasing Components"> + Releasing Components</a> + </li> + <li class="none"> + <a href="http://wiki.apache.org/commons/FrontPage"; class="externalLink" title="Wiki"> + Wiki</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">ASF</li> + <li class="none"> + <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How the ASF works"> + How the ASF works</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/getinvolved.html"; class="externalLink" title="Get Involved"> + Get Involved</a> + </li> + <li class="none"> + <a href="http://www.apache.org/dev/"; class="externalLink" title="Developer Resources"> + Developer Resources</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/policies/conduct.html"; class="externalLink" title="Code of Conduct"> + Code of Conduct</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"> + Sponsorship</a> + </li> + <li class="none"> + <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"> + Thanks</a> + </li> + </ul> + </div> + <div id="poweredBy"> + <a href="http://www.apache.org/events/current-event.html"; title="ApacheCon" class="builtBy"> + <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png"; /> + </a> + <a href="http://maven.apache.org/"; title="Maven" class="builtBy"> + <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png"; /> + </a> + </div> + </td> + <td class="content"> + + + + <div class="section"> +<h2><a name="Getting_Started"></a>Getting Started</h2> + +<p> + To start using JCS you need to (1) understand the core + concepts, (2) download JCS, (3) get the required + dependencies, (4) configure JCS, and (5) then start + programming to it. The purpose of the getting started + guide is to help you get up and running with JCS as + quickly as possible. In depth documentation on the + various features of JCS is provided in the User's Guide. + </p> + </div> + + +<div class="section"> +<h2><a name="STEP_1:_Understand_the_Core_Concepts"></a>STEP 1: Understand the Core Concepts</h2> + +<p> + In order to use JCS, you must understand a few core + concepts, most importantly you need to know the + difference between "elements," "regions," and + "auxiliaries". + </p> + +<p> + JCS is an object cache. You can put objects, or + "elements," into JCS and reference them via a key, much + like a hashtable. + </p> + +<p> + You can think of JCS as a collection of maps that + you reference by name. Each of these maps is + called a "region," and each region can be configured + independently of the others. For instance, I may have a + region called Cities where I cache City objects that + change infrequently. I may also define a region called + Products where I cache product data that changes more + frequently. I would configure the volatile Product + region to expire elements more quickly than the City + region. + </p> + +<p> + "Auxiliaries" are optional plugins that a region can + use. The core auxiliaries are the Indexed Disk Cache, + the TCP Lateral Cache, and the Remote Cache Server. The + Disk Cache, for example, allows you to swap items onto + disk when a memory threshold is reached. You can read + more about the available auxiliaries + <a href="../JCSPlugins.html">HERE</a> + . + </p> + </div> + + + +<div class="section"> +<h2><a name="STEP_2:_Download_JCS"></a>STEP 2: Download JCS</h2> + +<p> + Download the latest version of JCS. The latest JCS + builds are located + <a class="externalLink" href="http://www.apache.org/dist/commons/jcs/";> + HERE + </a> + </p> + +<p> + If you would like to build JCS yourself, check it out + from Subversion and build it as you would any other + project built by Maven. The location of the + repository is documented in the project info pages that + are linked via the left nav. + </p> + </div> + + +<div class="section"> +<h2><a name="STEP_3:_Get_the_Required_Dependencies"></a>STEP 3: Get the Required Dependencies</h2> + +<p> + Beginning with version 2.0 the core of JCS (the LRU memory + cache, the indexed disk cache, the TCP lateral, and the + RMI remote server) requires only commons-logging. + </p> + +<p> + Beginning with version 1.2.7.0 and up to version 1.3, the core of + JCS (the LRU memory + cache, the indexed disk cache, the TCP lateral, and the + RMI remote server) requires only two other jars. + </p> + +<p> + <a class="externalLink" href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html";> + concurrent + </a> + </p> + +<p>commons-logging</p> + +<p> + Versions 1.2.6.9 and below also require the following + two additional jars: + </p> + +<p>commons-collections</p> + +<p>commons-lang</p> + +<p> + All of the other dependencies listed on the project info + page are for optional plugins. + </p> + </div> + + +<div class="section"> +<h2><a name="STEP_4:_Configure_JCS"></a>STEP 4: Configure JCS</h2> + +<p> + JCS is configured from a properties file called + "cache.ccf". There are alternatives to using this file, + but they are beyond the scope of the getting started + guide. + </p> + +<p> + The cache configuration has three parts: default, + regions, and auxiliaries. You can think of the + auxiliaries as log4j appenders and the regions as log4j + categories. For each region (or category) you can + specify and auxiliary (or appender to use). If you don't + define a region in the cache.ccf, then the default + settings are used. The difference between JCS and log4j + is that in JCS, pre-defined regions do not inherent + auxiliaries from the default region. + </p> + +<p> + The following cache.ccf file defines one region called + "testCache1" and uses the Indexed Disk Cache, here + called "DC" by default. The LRU Memory Cache is selected + as the memory manager. + </p> + +<div class="source"> +<pre> + +# DEFAULT CACHE REGION +jcs.default=DC +jcs.default.cacheattributes=org.apache.commons.jcs.engine.CompositeCacheAttributes +jcs.default.cacheattributes.MaxObjects=1000 +jcs.default.cacheattributes.MemoryCacheName=org.apache.commons.jcs.engine.memory.lru.LRUMemoryCache +jcs.default.cacheattributes.UseMemoryShrinker=false +jcs.default.cacheattributes.MaxMemoryIdleTimeSeconds=3600 +jcs.default.cacheattributes.ShrinkerIntervalSeconds=60 +jcs.default.elementattributes=org.apache.commons.jcs.engine.ElementAttributes +jcs.default.elementattributes.IsEternal=false +jcs.default.elementattributes.MaxLife=21600 +jcs.default.elementattributes.IdleTime=1800 +jcs.default.elementattributes.IsSpool=true +jcs.default.elementattributes.IsRemote=true +jcs.default.elementattributes.IsLateral=true + +# PRE-DEFINED CACHE REGIONS +jcs.region.testCache1=DC +jcs.region.testCache1.cacheattributes=org.apache.commons.jcs.engine.CompositeCacheAttributes +jcs.region.testCache1.cacheattributes.MaxObjects=1000 +jcs.region.testCache1.cacheattributes.MemoryCacheName=org.apache.commons.jcs.engine.memory.lru.LRUMemoryCache +jcs.region.testCache1.cacheattributes.UseMemoryShrinker=false +jcs.region.testCache1.cacheattributes.MaxMemoryIdleTimeSeconds=3600 +jcs.region.testCache1.cacheattributes.ShrinkerIntervalSeconds=60 +jcs.region.testCache1.cacheattributes.MaxSpoolPerRun=500 +jcs.region.testCache1.elementattributes=org.apache.commons.jcs.engine.ElementAttributes +jcs.region.testCache1.elementattributes.IsEternal=false + +# AVAILABLE AUXILIARY CACHES +jcs.auxiliary.DC=org.apache.commons.jcs.auxiliary.disk.indexed.IndexedDiskCacheFactory +jcs.auxiliary.DC.attributes=org.apache.commons.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes +jcs.auxiliary.DC.attributes.DiskPath=${user.dir}/jcs_swap +jcs.auxiliary.DC.attributes.MaxPurgatorySize=10000000 +jcs.auxiliary.DC.attributes.MaxKeySize=1000000 +jcs.auxiliary.DC.attributes.OptimizeAtRemoveCount=300000 +jcs.auxiliary.DC.attributes.ShutdownSpoolTimeLimit=60 + + </pre></div> + +<p> + Basic JCS configuration is described in more detail + <a href="../BasicJCSConfiguration.html">HERE</a> + </p> + +<p> + Element level configuration is described in more detail + <a href="../ElementAttributes.html">HERE</a> + </p> + +<p> + For more information on advanced configuration options + and the available plugins, see the User's Guide. + </p> + </div> + + +<div class="section"> +<h2><a name="STEP_5:_Programming_to_JCS"></a>STEP 5: Programming to JCS</h2> + +<p> + JCS provides a few convenient classes that should meet all + your needs. + </p> + +<p> + To get a cache region you simply ask JCS for the region + by name. If you wanted to use JCS for City objects, you + would do something like this: + </p> + +<div class="source"> +<pre> + +import java.io.Serializable; +import org.apache.commons.jcs.JCS; +import org.apache.commons.jcs.access.CacheAccess; +import org.apache.commons.jcs.access.exception.CacheException; + +public class JcsExample +{ + public static void main( String[] args ) + { + JcsExample example = new JcsExample(); + example.testCache(); + } + + private CacheAccess<String, City> cache = null; + + public JcsExample() + { + try + { + cache = JCS.getInstance( "default" ); + } + catch ( CacheException e ) + { + System.out.println( String.format( "Problem initializing cache: %s", e.getMessage() ) ); + } + } + + public void putInCache( City city ) + { + String key = city.name; + try + { + cache.put( key, city ); + } + catch ( CacheException e ) + { + System.out.println( String.format( "Problem putting city %s in the cache, for key %s%n%s", + city.name, key, e.getMessage() ) ); + } + } + + public City retrieveFromCache( String cityKey ) + { + return cache.get( cityKey ); + } + + public void testCache() + { + City zurich = new City( "Zürich", "Switzerland", 366765 ); + putInCache( zurich ); + + City berlin = new City( "Berlin", "Germany", 3502000 ); + putInCache( berlin ); + + City johannesburg = new City( "Johannesburg", "South Africa", 12200000 ); + putInCache( johannesburg ); + + City retrievedCity1 = retrieveFromCache( "Berlin" ); + if ( retrievedCity1 != null ) + { + System.out.println( retrievedCity1.toString() ); + } + else + { + System.out.println( "No object was found in the cache for the key \"Berlin\"" ); + } + + City retrievedCity2 = retrieveFromCache( "New York" ); + if ( retrievedCity2 != null ) + { + System.out.println( retrievedCity2.toString() ); + } + else + { + System.out.println( "No object was found in the cache for the key \"New York\"" ); + } + } + + // defined as a nested inner class to reduce number of .java files in the example + public class City implements Serializable + { + private static final long serialVersionUID = 6392376146163510146L; + public String name; + public String country; + public int population; + + public City( String name, String country, int population ) + { + this.name = name; + this.country = country; + this.population = population; + } + + @Override + public String toString() + { + return String.format( "%s is a city in the country %s with a population of %d", name, country, population ); + } + } +} + +</pre></div> + </div> + + + + </td> + </tr> + </table> + </div> + + <div class="footer"> + <p>Copyright © 2002-2018 + <a href="https://www.apache.org/";>The Apache Software Foundation</a>. + All Rights Reserved.</p> + </div> + </body> + +</html>
![http://www.apache.org/events/current-event-125x125.png"](http://www.apache.org/events/current-event-125x125.png"){kind=link}
![http://maven.apache.org/images/logos/maven-feather.png"](http://maven.apache.org/images/logos/maven-feather.png"){kind=link}