You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@turbine.apache.org by gk...@apache.org on 2021/08/04 05:57:40 UTC
svn commit: r1076287 [32/35] - in
/websites/production/turbine/content/fulcrum/fulcrum-cache: ./
announcements/ apidocs/ apidocs/org/apache/fulcrum/cache/
apidocs/org/apache/fulcrum/cache/class-use/
apidocs/org/apache/fulcrum/cache/impl/ apidocs/org/ap...
Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.html
==============================================================================
--- websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.html (original)
+++ websites/production/turbine/content/fulcrum/fulcrum-cache/xref/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.html Wed Aug 4 05:57:38 2021
@@ -1,438 +1,421 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
-<title>DefaultGlobalCacheService xref</title>
-<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
-</head>
-<body>
-<div id="overview"><a href="../../../../../../apidocs/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.html">View Javadoc</a></div><pre>
-
-<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.fulcrum.cache.impl;
-<a name="2" href="#2">2</a>
-<a name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
-<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
-<a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
-<a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
-<a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
-<a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
-<a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
-<a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
-<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
-<a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
-<a name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
-<a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
-<a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
-<a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
-<a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
-<a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
-<a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
-<a name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
-<a name="21" href="#21">21</a>
-<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.ByteArrayOutputStream;
-<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
-<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.ObjectOutputStream;
-<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
-<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Enumeration;
-<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Hashtable;
-<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
-<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.List;
-<a name="30" href="#30">30</a>
-<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.activity.Disposable;
-<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.activity.Initializable;
-<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.configuration.Configurable;
-<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.configuration.Configuration;
-<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.configuration.ConfigurationException;
-<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.logger.AbstractLogEnabled;
-<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.thread.ThreadSafe;
-<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.fulcrum.cache.CachedObject;
-<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.apache.fulcrum.cache.GlobalCacheService;
-<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.apache.fulcrum.cache.ObjectExpiredException;
-<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.apache.fulcrum.cache.RefreshableCachedObject;
-<a name="42" href="#42">42</a>
-<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
-<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * This Service functions as a Global Cache. A global cache is a good place to</em>
-<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * store items that you may need to access often but don't necessarily need (or</em>
-<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * want) to fetch from the database everytime. A good example would be a look up</em>
-<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * table of States that you store in a database and use throughout your</em>
-<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * application. Since information about States doesn't change very often, you</em>
-<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * could store this information in the Global Cache and decrease the overhead of</em>
-<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * hitting the database everytime you need State information.</em>
-<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * </em>
-<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:mbryson@mont.mindspring.com" target="alexandria_uri">mailto:mbryson@mont.mindspring.com</a>">Dave Bryson</a></em>
-<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:jon@clearink.com" target="alexandria_uri">mailto:jon@clearink.com</a>">Jon S. Stevens</a></em>
-<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:john@zenplex.com" target="alexandria_uri">mailto:john@zenplex.com</a>">John Thorhauer</a></em>
-<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:hps@intermeta.de" target="alexandria_uri">mailto:hps@intermeta.de</a>">Henning P. Schmiedehausen</a></em>
-<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:epugh@upstate.com" target="alexandria_uri">mailto:epugh@upstate.com</a>">Eric Pugh</a></em>
-<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:peter@courcoux.biz" target="alexandria_uri">mailto:peter@courcoux.biz</a>">Peter Courcoux</a></em>
-<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @version $Id: DefaultGlobalCacheService.java 927153 2010-03-24 18:55:08Z tv $</em>
-<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> */</em>
-<a name="60" href="#60">60</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.html">DefaultGlobalCacheService</a> <strong class="jxr_keyword">extends</strong> AbstractLogEnabled implements
-<a name="61" href="#61">61</a> GlobalCacheService, Runnable, Configurable, Initializable, Disposable,
-<a name="62" href="#62">62</a> ThreadSafe
-<a name="63" href="#63">63</a> {
-<a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em>
-<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Initial size of hash table Value must be > 0. Default = 20</em>
-<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
-<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_INITIAL_CACHE_SIZE = 20;
-<a name="68" href="#68">68</a>
-<a name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em>
-<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * The property for the InitalCacheSize</em>
-<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em>
-<a name="72" href="#72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INITIAL_CACHE_SIZE = <span class="jxr_string">"cacheInitialSize"</span>;
-<a name="73" href="#73">73</a>
-<a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em>
-<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * The property for the Cache check frequency</em>
-<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em>
-<a name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CACHE_CHECK_FREQUENCY = <span class="jxr_string">"cacheCheckFrequency"</span>;
-<a name="78" href="#78">78</a>
-<a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em>
-<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Cache check frequency in Millis (1000 Millis = 1 second). Value must be ></em>
-<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * 0. Default = 5 seconds</em>
-<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em>
-<a name="83" href="#83">83</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> DEFAULT_CACHE_CHECK_FREQUENCY = 5000; <em class="jxr_comment">// 5 seconds</em>
-<a name="84" href="#84">84</a>
-<a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The cache. * */</em>
-<a name="86" href="#86">86</a> <strong class="jxr_keyword">protected</strong> Hashtable cache = <strong class="jxr_keyword">null</strong>;
-<a name="87" href="#87">87</a>
-<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em>
-<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * cacheCheckFrequency (default - 5 seconds)</em>
-<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
-<a name="91" href="#91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> cacheCheckFrequency;
-<a name="92" href="#92">92</a>
-<a name="93" href="#93">93</a> <em class="jxr_javadoccomment">/**</em>
-<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * cacheInitialSize (default - 20)</em>
-<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> */</em>
-<a name="96" href="#96">96</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> cacheInitialSize;
-<a name="97" href="#97">97</a>
-<a name="98" href="#98">98</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> thread for removing stale items from the cache */</em>
-<a name="99" href="#99">99</a> <strong class="jxr_keyword">private</strong> Thread housekeeping;
-<a name="100" href="#100">100</a>
-<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> flag to stop the housekeeping thread when the component is disposed. */</em>
-<a name="102" href="#102">102</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> continueThread;
-<a name="103" href="#103">103</a>
-<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">/**</em>
-<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * Get the Cache Check Frequency in milliseconds</em>
-<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * </em>
-<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * @return the time between two cache check runs in milliseconds</em>
-<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> */</em>
-<a name="109" href="#109">109</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getCacheCheckFrequency()
-<a name="110" href="#110">110</a> {
-<a name="111" href="#111">111</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.cacheCheckFrequency;
-<a name="112" href="#112">112</a> }
-<a name="113" href="#113">113</a>
-<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">/**</em>
-<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * Returns an item from the cache. /** Returns an item from the cache.</em>
-<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * RefreshableCachedObject will be refreshed if it is expired and not</em>
-<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * untouched.</em>
-<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * </em>
-<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @param id</em>
-<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * The key of the stored object.</em>
-<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @return The object from the cache.</em>
-<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @exception ObjectExpiredException,</em>
-<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * when either the object is not in the cache or it has</em>
-<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * expired.</em>
-<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> */</em>
-<a name="126" href="#126">126</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> getObject(String id) <strong class="jxr_keyword">throws</strong> ObjectExpiredException
-<a name="127" href="#127">127</a> {
-<a name="128" href="#128">128</a> <a href="../../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> obj = <strong class="jxr_keyword">null</strong>;
-<a name="129" href="#129">129</a> obj = (CachedObject) <strong class="jxr_keyword">this</strong>.cache.get(id);
-<a name="130" href="#130">130</a> <strong class="jxr_keyword">if</strong> (obj == <strong class="jxr_keyword">null</strong>)
-<a name="131" href="#131">131</a> {
-<a name="132" href="#132">132</a> <em class="jxr_comment">// Not in the cache.</em>
-<a name="133" href="#133">133</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html">ObjectExpiredException</a>();
-<a name="134" href="#134">134</a> }
-<a name="135" href="#135">135</a> <strong class="jxr_keyword">if</strong> (obj.isStale())
-<a name="136" href="#136">136</a> {
-<a name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> (obj instanceof RefreshableCachedObject)
-<a name="138" href="#138">138</a> {
-<a name="139" href="#139">139</a> <a href="../../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html">RefreshableCachedObject</a> rco = (RefreshableCachedObject) obj;
-<a name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong> (rco.isUntouched())
-<a name="141" href="#141">141</a> {
-<a name="142" href="#142">142</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html">ObjectExpiredException</a>();
-<a name="143" href="#143">143</a> }
-<a name="144" href="#144">144</a> <em class="jxr_comment">// Refresh Object</em>
-<a name="145" href="#145">145</a> rco.refresh();
-<a name="146" href="#146">146</a> <strong class="jxr_keyword">if</strong> (rco.isStale())
-<a name="147" href="#147">147</a> {
-<a name="148" href="#148">148</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html">ObjectExpiredException</a>();
-<a name="149" href="#149">149</a> }
-<a name="150" href="#150">150</a> }
-<a name="151" href="#151">151</a> <strong class="jxr_keyword">else</strong>
-<a name="152" href="#152">152</a> {
-<a name="153" href="#153">153</a> <em class="jxr_comment">// Expired.</em>
-<a name="154" href="#154">154</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html">ObjectExpiredException</a>();
-<a name="155" href="#155">155</a> }
-<a name="156" href="#156">156</a> }
-<a name="157" href="#157">157</a> <strong class="jxr_keyword">if</strong> (obj instanceof RefreshableCachedObject)
-<a name="158" href="#158">158</a> {
-<a name="159" href="#159">159</a> <em class="jxr_comment">// notify it that it's being accessed.</em>
-<a name="160" href="#160">160</a> <a href="../../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html">RefreshableCachedObject</a> rco = (RefreshableCachedObject) obj;
-<a name="161" href="#161">161</a> rco.touch();
-<a name="162" href="#162">162</a> }
-<a name="163" href="#163">163</a> <strong class="jxr_keyword">return</strong> obj;
-<a name="164" href="#164">164</a> }
-<a name="165" href="#165">165</a>
-<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">/**</em>
-<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * Adds an object to the cache.</em>
-<a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * </em>
-<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * @param id</em>
-<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * The key to store the object by.</em>
-<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * @param o</em>
-<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * The object to cache.</em>
-<a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> */</em>
-<a name="174" href="#174">174</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addObject(String id, <a href="../../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> o)
-<a name="175" href="#175">175</a> {
-<a name="176" href="#176">176</a> <em class="jxr_comment">// If the cache already contains the key, remove it and add</em>
-<a name="177" href="#177">177</a> <em class="jxr_comment">// the fresh one.</em>
-<a name="178" href="#178">178</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.cache.containsKey(id))
-<a name="179" href="#179">179</a> {
-<a name="180" href="#180">180</a> <strong class="jxr_keyword">this</strong>.cache.remove(id);
-<a name="181" href="#181">181</a> }
-<a name="182" href="#182">182</a> <strong class="jxr_keyword">this</strong>.cache.put(id, o);
-<a name="183" href="#183">183</a> }
-<a name="184" href="#184">184</a>
-<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">/**</em>
-<a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * Removes an object from the cache.</em>
-<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * </em>
-<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * @param id</em>
-<a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * The String id for the object.</em>
-<a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> */</em>
-<a name="191" href="#191">191</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> removeObject(String id)
-<a name="192" href="#192">192</a> {
-<a name="193" href="#193">193</a> <strong class="jxr_keyword">this</strong>.cache.remove(id);
-<a name="194" href="#194">194</a> }
-<a name="195" href="#195">195</a>
-<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">/**</em>
-<a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * Returns a copy of keys to objects in the cache as a list.</em>
-<a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * </em>
-<a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * Note that keys to expired objects are not returned.</em>
-<a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * </em>
-<a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * @return A List of <code>String</code>'s representing the keys to</em>
-<a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * objects in the cache.</em>
-<a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> */</em>
-<a name="204" href="#204">204</a> <strong class="jxr_keyword">public</strong> List getKeys()
-<a name="205" href="#205">205</a> {
-<a name="206" href="#206">206</a> ArrayList keys = <strong class="jxr_keyword">new</strong> ArrayList(<strong class="jxr_keyword">this</strong>.cache.size());
-<a name="207" href="#207">207</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>)
-<a name="208" href="#208">208</a> {
-<a name="209" href="#209">209</a> <strong class="jxr_keyword">for</strong> (Iterator itr = <strong class="jxr_keyword">this</strong>.cache.keySet().iterator(); itr.hasNext();)
-<a name="210" href="#210">210</a> {
-<a name="211" href="#211">211</a> String key = (String) itr.next();
-<a name="212" href="#212">212</a> <strong class="jxr_keyword">try</strong>
-<a name="213" href="#213">213</a> {
-<a name="214" href="#214">214</a> <em class="jxr_comment">/*<em class="jxr_comment"> <a href="../../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> obj = */</em>getObject(key);</em>
-<a name="215" href="#215">215</a> }
-<a name="216" href="#216">216</a> <strong class="jxr_keyword">catch</strong> (ObjectExpiredException oee)
-<a name="217" href="#217">217</a> {
-<a name="218" href="#218">218</a> <em class="jxr_comment">// this is OK we just do not want this key</em>
-<a name="219" href="#219">219</a> <strong class="jxr_keyword">continue</strong>;
-<a name="220" href="#220">220</a> }
-<a name="221" href="#221">221</a> keys.add(<strong class="jxr_keyword">new</strong> String(key));
-<a name="222" href="#222">222</a> }
-<a name="223" href="#223">223</a> }
-<a name="224" href="#224">224</a> <strong class="jxr_keyword">return</strong> keys;
-<a name="225" href="#225">225</a> }
-<a name="226" href="#226">226</a>
-<a name="227" href="#227">227</a> <em class="jxr_javadoccomment">/**</em>
-<a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * Returns a copy of the non-expired CachedObjects in the cache as a list.</em>
-<a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * </em>
-<a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * @return A List of <code>CachedObject</code> objects held in the cache</em>
-<a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> */</em>
-<a name="232" href="#232">232</a> <strong class="jxr_keyword">public</strong> List getCachedObjects()
-<a name="233" href="#233">233</a> {
-<a name="234" href="#234">234</a> ArrayList objects = <strong class="jxr_keyword">new</strong> ArrayList(<strong class="jxr_keyword">this</strong>.cache.size());
-<a name="235" href="#235">235</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>)
-<a name="236" href="#236">236</a> {
-<a name="237" href="#237">237</a> <strong class="jxr_keyword">for</strong> (Iterator itr = <strong class="jxr_keyword">this</strong>.cache.keySet().iterator(); itr.hasNext();)
-<a name="238" href="#238">238</a> {
-<a name="239" href="#239">239</a> String key = (String) itr.next();
-<a name="240" href="#240">240</a> <a href="../../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> obj = <strong class="jxr_keyword">null</strong>;
-<a name="241" href="#241">241</a> <strong class="jxr_keyword">try</strong>
-<a name="242" href="#242">242</a> {
-<a name="243" href="#243">243</a> obj = getObject(key);
-<a name="244" href="#244">244</a> }
-<a name="245" href="#245">245</a> <strong class="jxr_keyword">catch</strong> (ObjectExpiredException oee)
-<a name="246" href="#246">246</a> {
-<a name="247" href="#247">247</a> <em class="jxr_comment">// this is OK we just do not want this object</em>
-<a name="248" href="#248">248</a> <strong class="jxr_keyword">continue</strong>;
-<a name="249" href="#249">249</a> }
-<a name="250" href="#250">250</a> objects.add(obj);
-<a name="251" href="#251">251</a> }
-<a name="252" href="#252">252</a> }
-<a name="253" href="#253">253</a> <strong class="jxr_keyword">return</strong> objects;
-<a name="254" href="#254">254</a> }
-<a name="255" href="#255">255</a>
-<a name="256" href="#256">256</a> <em class="jxr_javadoccomment">/**</em>
-<a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * Circle through the cache and remove stale objects. Frequency is</em>
-<a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * determined by the cacheCheckFrequency property.</em>
-<a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> */</em>
-<a name="260" href="#260">260</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> run()
-<a name="261" href="#261">261</a> {
-<a name="262" href="#262">262</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">this</strong>.continueThread)
-<a name="263" href="#263">263</a> {
-<a name="264" href="#264">264</a> <em class="jxr_comment">// Sleep for amount of time set in cacheCheckFrequency -</em>
-<a name="265" href="#265">265</a> <em class="jxr_comment">// default = 5 seconds.</em>
-<a name="266" href="#266">266</a> <strong class="jxr_keyword">try</strong>
-<a name="267" href="#267">267</a> {
-<a name="268" href="#268">268</a> Thread.sleep(<strong class="jxr_keyword">this</strong>.cacheCheckFrequency);
-<a name="269" href="#269">269</a> }
-<a name="270" href="#270">270</a> <strong class="jxr_keyword">catch</strong> (InterruptedException exc)
-<a name="271" href="#271">271</a> {
-<a name="272" href="#272">272</a> <strong class="jxr_keyword">if</strong> (!<strong class="jxr_keyword">this</strong>.continueThread)
-<a name="273" href="#273">273</a> {
-<a name="274" href="#274">274</a> <strong class="jxr_keyword">return</strong>;
-<a name="275" href="#275">275</a> }
-<a name="276" href="#276">276</a> }
-<a name="277" href="#277">277</a>
-<a name="278" href="#278">278</a> clearCache();
-<a name="279" href="#279">279</a> }
-<a name="280" href="#280">280</a> }
-<a name="281" href="#281">281</a>
-<a name="282" href="#282">282</a> <em class="jxr_javadoccomment">/**</em>
-<a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * Iterate through the cache and remove or refresh stale objects.</em>
-<a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> */</em>
-<a name="285" href="#285">285</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clearCache()
-<a name="286" href="#286">286</a> {
-<a name="287" href="#287">287</a> List refreshThese = <strong class="jxr_keyword">new</strong> ArrayList(20);
-<a name="288" href="#288">288</a> <em class="jxr_comment">// Sync on this object so that other threads do not</em>
-<a name="289" href="#289">289</a> <em class="jxr_comment">// change the Hashtable while enumerating over it.</em>
-<a name="290" href="#290">290</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>)
-<a name="291" href="#291">291</a> {
-<a name="292" href="#292">292</a> <strong class="jxr_keyword">for</strong> (Enumeration e = <strong class="jxr_keyword">this</strong>.cache.keys(); e.hasMoreElements();)
-<a name="293" href="#293">293</a> {
-<a name="294" href="#294">294</a> String key = (String) e.nextElement();
-<a name="295" href="#295">295</a> <a href="../../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> co = (CachedObject) <strong class="jxr_keyword">this</strong>.cache.get(key);
-<a name="296" href="#296">296</a> <strong class="jxr_keyword">if</strong> (co instanceof RefreshableCachedObject)
-<a name="297" href="#297">297</a> {
-<a name="298" href="#298">298</a> <a href="../../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html">RefreshableCachedObject</a> rco = (RefreshableCachedObject) co;
-<a name="299" href="#299">299</a> <strong class="jxr_keyword">if</strong> (rco.isUntouched())
-<a name="300" href="#300">300</a> {
-<a name="301" href="#301">301</a> <strong class="jxr_keyword">this</strong>.cache.remove(key);
-<a name="302" href="#302">302</a> }
-<a name="303" href="#303">303</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (rco.isStale())
-<a name="304" href="#304">304</a> {
-<a name="305" href="#305">305</a> <em class="jxr_comment">// to prolong holding the lock on this object</em>
-<a name="306" href="#306">306</a> refreshThese.add(key);
-<a name="307" href="#307">307</a> }
-<a name="308" href="#308">308</a> }
-<a name="309" href="#309">309</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (co.isStale())
-<a name="310" href="#310">310</a> {
-<a name="311" href="#311">311</a> <strong class="jxr_keyword">this</strong>.cache.remove(key);
-<a name="312" href="#312">312</a> }
-<a name="313" href="#313">313</a> }
-<a name="314" href="#314">314</a> }
-<a name="315" href="#315">315</a> <strong class="jxr_keyword">for</strong> (Iterator i = refreshThese.iterator(); i.hasNext();)
-<a name="316" href="#316">316</a> {
-<a name="317" href="#317">317</a> String key = (String) i.next();
-<a name="318" href="#318">318</a> <a href="../../../../../org/apache/fulcrum/cache/CachedObject.html">CachedObject</a> co = (CachedObject) <strong class="jxr_keyword">this</strong>.cache.get(key);
-<a name="319" href="#319">319</a> <a href="../../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html">RefreshableCachedObject</a> rco = (RefreshableCachedObject) co;
-<a name="320" href="#320">320</a> rco.refresh();
-<a name="321" href="#321">321</a> }
-<a name="322" href="#322">322</a> }
-<a name="323" href="#323">323</a>
-<a name="324" href="#324">324</a> <em class="jxr_javadoccomment">/**</em>
-<a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * Returns the number of objects currently stored in the cache</em>
-<a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * </em>
-<a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * @return int number of object in the cache</em>
-<a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> */</em>
-<a name="329" href="#329">329</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getNumberOfObjects()
-<a name="330" href="#330">330</a> {
-<a name="331" href="#331">331</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.cache.size();
-<a name="332" href="#332">332</a> }
-<a name="333" href="#333">333</a>
-<a name="334" href="#334">334</a> <em class="jxr_javadoccomment">/**</em>
-<a name="335" href="#335">335</a> <em class="jxr_javadoccomment"> * Returns the current size of the cache.</em>
-<a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> * </em>
-<a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> * @return int representing current cache size in number of bytes</em>
-<a name="338" href="#338">338</a> <em class="jxr_javadoccomment"> */</em>
-<a name="339" href="#339">339</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getCacheSize() <strong class="jxr_keyword">throws</strong> IOException
-<a name="340" href="#340">340</a> {
-<a name="341" href="#341">341</a> ByteArrayOutputStream baos = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream();
-<a name="342" href="#342">342</a> ObjectOutputStream out = <strong class="jxr_keyword">new</strong> ObjectOutputStream(baos);
-<a name="343" href="#343">343</a> out.writeObject(<strong class="jxr_keyword">this</strong>.cache);
-<a name="344" href="#344">344</a> out.flush();
-<a name="345" href="#345">345</a> <em class="jxr_comment">//</em>
-<a name="346" href="#346">346</a> <em class="jxr_comment">// Subtract 4 bytes from the length, because the serialization</em>
-<a name="347" href="#347">347</a> <em class="jxr_comment">// magic number (2 bytes) and version number (2 bytes) are</em>
-<a name="348" href="#348">348</a> <em class="jxr_comment">// both written to the stream before the object</em>
-<a name="349" href="#349">349</a> <em class="jxr_comment">//</em>
-<a name="350" href="#350">350</a> <strong class="jxr_keyword">int</strong> objectsize = baos.toByteArray().length - 4;
-<a name="351" href="#351">351</a> <strong class="jxr_keyword">return</strong> objectsize;
-<a name="352" href="#352">352</a> }
-<a name="353" href="#353">353</a>
-<a name="354" href="#354">354</a> <em class="jxr_javadoccomment">/**</em>
-<a name="355" href="#355">355</a> <em class="jxr_javadoccomment"> * Flush the cache of all objects.</em>
-<a name="356" href="#356">356</a> <em class="jxr_javadoccomment"> */</em>
-<a name="357" href="#357">357</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> flushCache()
-<a name="358" href="#358">358</a> {
-<a name="359" href="#359">359</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>)
-<a name="360" href="#360">360</a> {
-<a name="361" href="#361">361</a> <strong class="jxr_keyword">for</strong> (Enumeration e = <strong class="jxr_keyword">this</strong>.cache.keys(); e.hasMoreElements();)
-<a name="362" href="#362">362</a> {
-<a name="363" href="#363">363</a> String key = (String) e.nextElement();
-<a name="364" href="#364">364</a> <strong class="jxr_keyword">this</strong>.cache.remove(key);
-<a name="365" href="#365">365</a> }
-<a name="366" href="#366">366</a> }
-<a name="367" href="#367">367</a> }
-<a name="368" href="#368">368</a>
-<a name="369" href="#369">369</a> <em class="jxr_comment">// ---------------- Avalon Lifecycle Methods ---------------------</em>
-<a name="370" href="#370">370</a> <em class="jxr_javadoccomment">/**</em>
-<a name="371" href="#371">371</a> <em class="jxr_javadoccomment"> * Avalon component lifecycle method</em>
-<a name="372" href="#372">372</a> <em class="jxr_javadoccomment"> */</em>
-<a name="373" href="#373">373</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> configure(Configuration conf) <strong class="jxr_keyword">throws</strong> ConfigurationException
-<a name="374" href="#374">374</a> {
-<a name="375" href="#375">375</a> <strong class="jxr_keyword">this</strong>.cacheCheckFrequency = conf.getAttributeAsLong(
-<a name="376" href="#376">376</a> CACHE_CHECK_FREQUENCY, DEFAULT_CACHE_CHECK_FREQUENCY);
-<a name="377" href="#377">377</a> <strong class="jxr_keyword">this</strong>.cacheInitialSize = conf.getAttributeAsInteger(INITIAL_CACHE_SIZE,
-<a name="378" href="#378">378</a> DEFAULT_INITIAL_CACHE_SIZE);
-<a name="379" href="#379">379</a> }
-<a name="380" href="#380">380</a>
-<a name="381" href="#381">381</a> <em class="jxr_javadoccomment">/**</em>
-<a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * Avalon component lifecycle method</em>
-<a name="383" href="#383">383</a> <em class="jxr_javadoccomment"> */</em>
-<a name="384" href="#384">384</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> initialize() <strong class="jxr_keyword">throws</strong> Exception
-<a name="385" href="#385">385</a> {
-<a name="386" href="#386">386</a> <strong class="jxr_keyword">try</strong>
-<a name="387" href="#387">387</a> {
-<a name="388" href="#388">388</a> <strong class="jxr_keyword">this</strong>.cache = <strong class="jxr_keyword">new</strong> Hashtable(<strong class="jxr_keyword">this</strong>.cacheInitialSize);
-<a name="389" href="#389">389</a> <em class="jxr_comment">// Start housekeeping thread.</em>
-<a name="390" href="#390">390</a> <strong class="jxr_keyword">this</strong>.continueThread = <strong class="jxr_keyword">true</strong>;
-<a name="391" href="#391">391</a> <strong class="jxr_keyword">this</strong>.housekeeping = <strong class="jxr_keyword">new</strong> Thread(<strong class="jxr_keyword">this</strong>);
-<a name="392" href="#392">392</a> <em class="jxr_comment">// Indicate that this is a system thread. JVM will quit only when</em>
-<a name="393" href="#393">393</a> <em class="jxr_comment">// there are no more active user threads. Settings threads spawned</em>
-<a name="394" href="#394">394</a> <em class="jxr_comment">// internally by Turbine as daemons allows commandline applications</em>
-<a name="395" href="#395">395</a> <em class="jxr_comment">// using Turbine to terminate in an orderly manner.</em>
-<a name="396" href="#396">396</a> <strong class="jxr_keyword">this</strong>.housekeeping.setDaemon(<strong class="jxr_keyword">true</strong>);
-<a name="397" href="#397">397</a> <strong class="jxr_keyword">this</strong>.housekeeping.start();
-<a name="398" href="#398">398</a> }
-<a name="399" href="#399">399</a> <strong class="jxr_keyword">catch</strong> (Exception e)
-<a name="400" href="#400">400</a> {
-<a name="401" href="#401">401</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(
-<a name="402" href="#402">402</a> <span class="jxr_string">"DefaultGlobalCacheService failed to initialize"</span>, e);
-<a name="403" href="#403">403</a> }
-<a name="404" href="#404">404</a> }
-<a name="405" href="#405">405</a>
-<a name="406" href="#406">406</a> <em class="jxr_javadoccomment">/**</em>
-<a name="407" href="#407">407</a> <em class="jxr_javadoccomment"> * Avalon component lifecycle method</em>
-<a name="408" href="#408">408</a> <em class="jxr_javadoccomment"> */</em>
-<a name="409" href="#409">409</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> dispose()
-<a name="410" href="#410">410</a> {
-<a name="411" href="#411">411</a> <strong class="jxr_keyword">this</strong>.continueThread = false;
-<a name="412" href="#412">412</a> <strong class="jxr_keyword">this</strong>.housekeeping.interrupt();
-<a name="413" href="#413">413</a> }
-<a name="414" href="#414">414</a>
-<a name="415" href="#415">415</a> <em class="jxr_javadoccomment">/**</em>
-<a name="416" href="#416">416</a> <em class="jxr_javadoccomment"> * The name used to specify this component in TurbineResources.properties</em>
-<a name="417" href="#417">417</a> <em class="jxr_javadoccomment"> * </em>
-<a name="418" href="#418">418</a> <em class="jxr_javadoccomment"> * @deprecated part of the pre-avalon compatibility layer</em>
-<a name="419" href="#419">419</a> <em class="jxr_javadoccomment"> */</em>
-<a name="420" href="#420">420</a> <strong class="jxr_keyword">protected</strong> String getName()
-<a name="421" href="#421">421</a> {
-<a name="422" href="#422">422</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"GlobalCacheService"</span>;
-<a name="423" href="#423">423</a> }
-<a name="424" href="#424">424</a> }
-</pre>
-<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
-</html>
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+<title>DefaultGlobalCacheService xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.html">View Javadoc</a></div><pre>
+<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.fulcrum.cache.impl;
+<a class="jxr_linenumber" name="L2" href="#L2">2</a>
+<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em>
+<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="L21" href="#L21">21</a>
+<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.ByteArrayOutputStream;
+<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.ObjectOutputStream;
+<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentHashMap;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a>
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.activity.Disposable;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.activity.Initializable;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.configuration.Configurable;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.configuration.Configuration;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.configuration.ConfigurationException;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.logger.AbstractLogEnabled;
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.avalon.framework.thread.ThreadSafe;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.fulcrum.cache.CachedObject;
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.fulcrum.cache.GlobalCacheService;
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.fulcrum.cache.ObjectExpiredException;
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.fulcrum.cache.RefreshableCachedObject;
+<a class="jxr_linenumber" name="L40" href="#L40">40</a>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * This Service functions as a Global Cache. A global cache is a good place to</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * store items that you may need to access often but don't necessarily need (or</em>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * want) to fetch from the database everytime. A good example would be a look up</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * table of States that you store in a database and use throughout your</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * application. Since information about States doesn't change very often, you</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * could store this information in the Global Cache and decrease the overhead of</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * hitting the database everytime you need State information.</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:mbryson@mont.mindspring.com" target="alexandria_uri">mailto:mbryson@mont.mindspring.com</a>">Dave Bryson</a></em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:jon@clearink.com" target="alexandria_uri">mailto:jon@clearink.com</a>">Jon S. Stevens</a></em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:john@zenplex.com" target="alexandria_uri">mailto:john@zenplex.com</a>">John Thorhauer</a></em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:hps@intermeta.de" target="alexandria_uri">mailto:hps@intermeta.de</a>">Henning P. Schmiedehausen</a></em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:epugh@upstate.com" target="alexandria_uri">mailto:epugh@upstate.com</a>">Eric Pugh</a></em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:peter@courefreshableCachedObjectux.biz" target="alexandria_uri">mailto:peter@courefreshableCachedObjectux.biz</a>">Peter CourefreshableCachedObjectux</a></em>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @version $Id: DefaultGlobalCacheService.java 1890338 2021-05-31 10:31:19Z gk $</em>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="DefaultGlobalCacheService" href="../../../../../org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.html#DefaultGlobalCacheService">DefaultGlobalCacheService</a> <strong class="jxr_keyword">extends</strong> AbstractLogEnabled <strong class="jxr_keyword">implements</strong>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> GlobalCacheService, Runnable, Configurable, Initializable, Disposable,
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> ThreadSafe
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> {
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * Initial size of hash table Value must be &gt; 0. Default = 20</em>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_INITIAL_CACHE_SIZE = 20;
+<a class="jxr_linenumber" name="L66" href="#L66">66</a>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * The property for the InitalCacheSize</em>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INITIAL_CACHE_SIZE = <span class="jxr_string">"cacheInitialSize"</span>;
+<a class="jxr_linenumber" name="L71" href="#L71">71</a>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * The property for the Cache check frequency</em>
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CACHE_CHECK_FREQUENCY = <span class="jxr_string">"cacheCheckFrequency"</span>;
+<a class="jxr_linenumber" name="L76" href="#L76">76</a>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * Cache check frequency in Millis (1000 Millis = 1 second). Value must be &gt;</em>
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * 0. Default = 5 seconds</em>
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> DEFAULT_CACHE_CHECK_FREQUENCY = 5000; <em class="jxr_comment">// 5 seconds</em>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a>
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/** The cache. */</em>
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">transient</strong> ConcurrentHashMap<String, CachedObject<?>> cache = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L85" href="#L85">85</a>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * cacheCheckFrequency (default - 5 seconds)</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> <strong class="jxr_keyword">long</strong> cacheCheckFrequency;
+<a class="jxr_linenumber" name="L90" href="#L90">90</a>
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * cacheInitialSize (default - 20)</em>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> <strong class="jxr_keyword">int</strong> cacheInitialSize;
+<a class="jxr_linenumber" name="L95" href="#L95">95</a>
+<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/** thread for removing stale items from the cache */</em>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> Thread houseKeepingThread;
+<a class="jxr_linenumber" name="L98" href="#L98">98</a>
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment">/** flag to stop the housekeeping thread when the component is disposed. */</em>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> <strong class="jxr_keyword">boolean</strong> continueThread;
+<a class="jxr_linenumber" name="L101" href="#L101">101</a>
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">public</strong> <a name="DefaultGlobalCacheService" href="../../../../../org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.html#DefaultGlobalCacheService">DefaultGlobalCacheService</a>()
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> {
+<a class="jxr_linenumber" name="L104" href="#L104">104</a>
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> }
+<a class="jxr_linenumber" name="L106" href="#L106">106</a>
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Get the Cache Check Frequency in milliseconds</em>
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @return the time between two cache check runs in milliseconds</em>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getCacheCheckFrequency()
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> {
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.cacheCheckFrequency;
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
+<a class="jxr_linenumber" name="L116" href="#L116">116</a>
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * Returns an item from the cache. /** Returns an item from the cache.</em>
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * RefreshableCachedObject will be refreshed if it is expired and not</em>
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * untouched.</em>
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * @param objectId</em>
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * The key of the stored object.</em>
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * @return The object from the cache.</em>
+<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @throws ObjectExpiredException</em>
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * when either the object is not in the cache or it has</em>
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * expired.</em>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> @Override
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">public</strong> <T> CachedObject<T> getObject(String objectId) <strong class="jxr_keyword">throws</strong> <a name="ObjectExpiredException" href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html#ObjectExpiredException">ObjectExpiredException</a>
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> {
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">final</strong> CachedObject<T> cachedObject = (CachedObject<T>) <strong class="jxr_keyword">this</strong>.cache.get(objectId);
+<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">if</strong> (cachedObject == <strong class="jxr_keyword">null</strong>)
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> {
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_comment">// Not in the cache.</em>
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ObjectExpiredException" href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html#ObjectExpiredException">ObjectExpiredException</a>();
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> }
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">if</strong> (cachedObject.isStale())
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> {
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">if</strong> (cachedObject instanceof <a name="RefreshableCachedObject" href="../../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html#RefreshableCachedObject">RefreshableCachedObject</a>)
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> {
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> RefreshableCachedObject<?> refreshableCachedObj = (RefreshableCachedObject<?>) cachedObject;
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">if</strong> (refreshableCachedObj.isUntouched())
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> {
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ObjectExpiredException" href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html#ObjectExpiredException">ObjectExpiredException</a>();
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> }
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_comment">// Refresh Object</em>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> refreshableCachedObj.refresh();
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">if</strong> (refreshableCachedObj.isStale())
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> {
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ObjectExpiredException" href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html#ObjectExpiredException">ObjectExpiredException</a>();
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> }
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> {
+<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_comment">// Expired.</em>
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ObjectExpiredException" href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html#ObjectExpiredException">ObjectExpiredException</a>();
+<a class="jxr_linenumber" name="L159" href="#L159">159</a> }
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
+<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">if</strong> (cachedObject instanceof <a name="RefreshableCachedObject" href="../../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html#RefreshableCachedObject">RefreshableCachedObject</a>)
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> {
+<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_comment">// notify it that it's being accessed.</em>
+<a class="jxr_linenumber" name="L164" href="#L164">164</a> RefreshableCachedObject<?> refreshableCachedObj = (RefreshableCachedObject<?>) cachedObject;
+<a class="jxr_linenumber" name="L165" href="#L165">165</a> refreshableCachedObj.touch();
+<a class="jxr_linenumber" name="L166" href="#L166">166</a> }
+<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">return</strong> cachedObject;
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
+<a class="jxr_linenumber" name="L169" href="#L169">169</a>
+<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Adds an object to the cache.</em>
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * @param objectId</em>
+<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * The key to store the object by.</em>
+<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @param object</em>
+<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * The object to cache.</em>
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> @Override
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">public</strong> <T> <strong class="jxr_keyword">void</strong> addObject(<strong class="jxr_keyword">final</strong> String objectId, <strong class="jxr_keyword">final</strong> CachedObject<T> object)
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> {
+<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_comment">// If the cache already contains the key, remove it and add</em>
+<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_comment">// the fresh one.</em>
+<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.cache.containsKey(objectId))
+<a class="jxr_linenumber" name="L184" href="#L184">184</a> {
+<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">this</strong>.cache.remove(objectId);
+<a class="jxr_linenumber" name="L186" href="#L186">186</a> }
+<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">this</strong>.cache.put(objectId, object);
+<a class="jxr_linenumber" name="L188" href="#L188">188</a> }
+<a class="jxr_linenumber" name="L189" href="#L189">189</a>
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * Removes an object from the cache.</em>
+<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * @param objectId</em>
+<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * The String id for the object.</em>
+<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L196" href="#L196">196</a> @Override
+<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> removeObject(String objectId)
+<a class="jxr_linenumber" name="L198" href="#L198">198</a> {
+<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">this</strong>.cache.remove(objectId);
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> }
+<a class="jxr_linenumber" name="L201" href="#L201">201</a>
+<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * Returns a copy of keys to objects in the cache as a list.</em>
+<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * Note that keys to expired objects are not returned.</em>
+<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * @return A List of <code>String</code>'s representing the keys to</em>
+<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * objects in the cache.</em>
+<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L210" href="#L210">210</a> @Override
+<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">public</strong> List<String> getKeys()
+<a class="jxr_linenumber" name="L212" href="#L212">212</a> {
+<a class="jxr_linenumber" name="L213" href="#L213">213</a> ArrayList<String> keys = <strong class="jxr_keyword">new</strong> ArrayList<>(<strong class="jxr_keyword">this</strong>.cache.size());
+<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">for</strong> (String key : <strong class="jxr_keyword">this</strong>.cache.keySet())
+<a class="jxr_linenumber" name="L215" href="#L215">215</a> {
+<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="L217" href="#L217">217</a> {
+<a class="jxr_linenumber" name="L218" href="#L218">218</a> getObject(key);
+<a class="jxr_linenumber" name="L219" href="#L219">219</a> }
+<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">catch</strong> (<a name="ObjectExpiredException" href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html#ObjectExpiredException">ObjectExpiredException</a> oee)
+<a class="jxr_linenumber" name="L221" href="#L221">221</a> {
+<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_comment">// this is OK we just do not want this key</em>
+<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">continue</strong>;
+<a class="jxr_linenumber" name="L224" href="#L224">224</a> }
+<a class="jxr_linenumber" name="L225" href="#L225">225</a> keys.add(key);
+<a class="jxr_linenumber" name="L226" href="#L226">226</a> }
+<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">return</strong> keys;
+<a class="jxr_linenumber" name="L228" href="#L228">228</a> }
+<a class="jxr_linenumber" name="L229" href="#L229">229</a>
+<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * Returns a copy of the non-expired CachedObjects in the cache as a list.</em>
+<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * @return A List of <code>CachedObject</code> objects held in the cache</em>
+<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L235" href="#L235">235</a> @Override
+<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">public</strong> List<CachedObject<?>> getCachedObjects()
+<a class="jxr_linenumber" name="L237" href="#L237">237</a> {
+<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">final</strong> ArrayList<CachedObject<?>> objects = <strong class="jxr_keyword">new</strong> ArrayList<>(<strong class="jxr_keyword">this</strong>.cache.size());
+<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">for</strong> (String key : <strong class="jxr_keyword">this</strong>.cache.keySet())
+<a class="jxr_linenumber" name="L240" href="#L240">240</a> {
+<a class="jxr_linenumber" name="L241" href="#L241">241</a> CachedObject<?> cachedObject = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="L243" href="#L243">243</a> {
+<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_comment">// only add non-null objects</em>
+<a class="jxr_linenumber" name="L245" href="#L245">245</a> cachedObject = getObject(key);
+<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">if</strong> ( cachedObject != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="L247" href="#L247">247</a> {
+<a class="jxr_linenumber" name="L248" href="#L248">248</a> objects.add(cachedObject);
+<a class="jxr_linenumber" name="L249" href="#L249">249</a> }
+<a class="jxr_linenumber" name="L250" href="#L250">250</a> }
+<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">catch</strong> (<a name="ObjectExpiredException" href="../../../../../org/apache/fulcrum/cache/ObjectExpiredException.html#ObjectExpiredException">ObjectExpiredException</a> oee)
+<a class="jxr_linenumber" name="L252" href="#L252">252</a> {
+<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_comment">// this is OK we just do not want this object</em>
+<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">continue</strong>;
+<a class="jxr_linenumber" name="L255" href="#L255">255</a> }
+<a class="jxr_linenumber" name="L256" href="#L256">256</a> }
+<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">return</strong> objects;
+<a class="jxr_linenumber" name="L258" href="#L258">258</a> }
+<a class="jxr_linenumber" name="L259" href="#L259">259</a>
+<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> * Circle through the cache and remove stale objects. Frequency is</em>
+<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * determined by the cacheCheckFrequency property.</em>
+<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L264" href="#L264">264</a> @Override
+<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> run()
+<a class="jxr_linenumber" name="L266" href="#L266">266</a> {
+<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">this</strong>.continueThread)
+<a class="jxr_linenumber" name="L268" href="#L268">268</a> {
+<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_comment">// Sleep for amount of time set in cacheCheckFrequency -</em>
+<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_comment">// default = 5 seconds.</em>
+<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>)
+<a class="jxr_linenumber" name="L272" href="#L272">272</a> {
+<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="L274" href="#L274">274</a> {
+<a class="jxr_linenumber" name="L275" href="#L275">275</a> wait(<strong class="jxr_keyword">this</strong>.cacheCheckFrequency);
+<a class="jxr_linenumber" name="L276" href="#L276">276</a> }
+<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">catch</strong> (InterruptedException exc)
+<a class="jxr_linenumber" name="L278" href="#L278">278</a> {
+<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_comment">// to be expected</em>
+<a class="jxr_linenumber" name="L280" href="#L280">280</a> }
+<a class="jxr_linenumber" name="L281" href="#L281">281</a> }
+<a class="jxr_linenumber" name="L282" href="#L282">282</a>
+<a class="jxr_linenumber" name="L283" href="#L283">283</a> clearCache();
+<a class="jxr_linenumber" name="L284" href="#L284">284</a> }
+<a class="jxr_linenumber" name="L285" href="#L285">285</a> }
+<a class="jxr_linenumber" name="L286" href="#L286">286</a>
+<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * Iterate through the cache and remove or refresh stale objects.</em>
+<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clearCache()
+<a class="jxr_linenumber" name="L291" href="#L291">291</a> {
+<a class="jxr_linenumber" name="L292" href="#L292">292</a> List<String> refreshThese = <strong class="jxr_keyword">new</strong> ArrayList<>(20);
+<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_comment">// Sync on this object so that other threads do not</em>
+<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_comment">// change the Hashtable while enumerating over it.</em>
+<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">for</strong> (String key : <strong class="jxr_keyword">this</strong>.cache.keySet())
+<a class="jxr_linenumber" name="L296" href="#L296">296</a> {
+<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">final</strong> CachedObject<?> cachedObject = <strong class="jxr_keyword">this</strong>.cache.get(key);
+<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">if</strong> (cachedObject instanceof <a name="RefreshableCachedObject" href="../../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html#RefreshableCachedObject">RefreshableCachedObject</a>)
+<a class="jxr_linenumber" name="L299" href="#L299">299</a> {
+<a class="jxr_linenumber" name="L300" href="#L300">300</a> RefreshableCachedObject<?> refreshableObject = (RefreshableCachedObject<?>) cachedObject;
+<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">if</strong> (refreshableObject.isUntouched())
+<a class="jxr_linenumber" name="L302" href="#L302">302</a> {
+<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">this</strong>.cache.remove(key);
+<a class="jxr_linenumber" name="L304" href="#L304">304</a> }
+<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (refreshableObject.isStale())
+<a class="jxr_linenumber" name="L306" href="#L306">306</a> {
+<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_comment">// to prolong holding the lock on this object</em>
+<a class="jxr_linenumber" name="L308" href="#L308">308</a> refreshThese.add(key);
+<a class="jxr_linenumber" name="L309" href="#L309">309</a> }
+<a class="jxr_linenumber" name="L310" href="#L310">310</a> }
+<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (cachedObject.isStale())
+<a class="jxr_linenumber" name="L312" href="#L312">312</a> {
+<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">this</strong>.cache.remove(key);
+<a class="jxr_linenumber" name="L314" href="#L314">314</a> }
+<a class="jxr_linenumber" name="L315" href="#L315">315</a> }
+<a class="jxr_linenumber" name="L316" href="#L316">316</a>
+<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">for</strong> (String key : refreshThese)
+<a class="jxr_linenumber" name="L318" href="#L318">318</a> {
+<a class="jxr_linenumber" name="L319" href="#L319">319</a> CachedObject<?> cachedObject = <strong class="jxr_keyword">this</strong>.cache.get(key);
+<a class="jxr_linenumber" name="L320" href="#L320">320</a> RefreshableCachedObject<?> refreshableCachedObject = (RefreshableCachedObject<?>) cachedObject;
+<a class="jxr_linenumber" name="L321" href="#L321">321</a> refreshableCachedObject.refresh();
+<a class="jxr_linenumber" name="L322" href="#L322">322</a> }
+<a class="jxr_linenumber" name="L323" href="#L323">323</a> }
+<a class="jxr_linenumber" name="L324" href="#L324">324</a>
+<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * Returns the number of objects currently stored in the cache</em>
+<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * @return int number of object in the cache</em>
+<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L330" href="#L330">330</a> @Override
+<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getNumberOfObjects()
+<a class="jxr_linenumber" name="L332" href="#L332">332</a> {
+<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.cache.size();
+<a class="jxr_linenumber" name="L334" href="#L334">334</a> }
+<a class="jxr_linenumber" name="L335" href="#L335">335</a>
+<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * Returns the current size of the cache.</em>
+<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * @return int representing current cache size in number of bytes</em>
+<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L341" href="#L341">341</a> @Override
+<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getCacheSize() <strong class="jxr_keyword">throws</strong> IOException
+<a class="jxr_linenumber" name="L343" href="#L343">343</a> {
+<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">final</strong> ByteArrayOutputStream baos = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream();
+<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">final</strong> ObjectOutputStream out = <strong class="jxr_keyword">new</strong> ObjectOutputStream(baos);
+<a class="jxr_linenumber" name="L346" href="#L346">346</a> out.writeObject(<strong class="jxr_keyword">this</strong>.cache);
+<a class="jxr_linenumber" name="L347" href="#L347">347</a> out.flush();
+<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_comment">//</em>
+<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_comment">// Subtract 4 bytes from the length, because the serialization</em>
+<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_comment">// magic number (2 bytes) and version number (2 bytes) are</em>
+<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_comment">// both written to the stream before the object</em>
+<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_comment">//</em>
+<a class="jxr_linenumber" name="L353" href="#L353">353</a> <strong class="jxr_keyword">return</strong> baos.toByteArray().length - 4;
[... 62 lines stripped ...]