Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/impl/EHCacheService.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/impl/EHCacheService.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/impl/EHCacheService.html Wed Aug 4 05:57:38 2021 @@ -1,403 +1,426 @@ -<HTML> -<BODY BGCOLOR="white"> -<PRE> -<FONT color="green">001</FONT> package org.apache.fulcrum.cache.impl;<a name="line.1"></a> -<FONT color="green">002</FONT> <a name="line.2"></a> -<FONT color="green">003</FONT> /*<a name="line.3"></a> -<FONT color="green">004</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a> -<FONT color="green">005</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a> -<FONT color="green">006</FONT> * distributed with this work for additional information<a name="line.6"></a> -<FONT color="green">007</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a> -<FONT color="green">008</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a> -<FONT color="green">009</FONT> * "License"); you may not use this file except in compliance<a name="line.9"></a> -<FONT color="green">010</FONT> * with the License. You may obtain a copy of the License at<a name="line.10"></a> -<FONT color="green">011</FONT> *<a name="line.11"></a> -<FONT color="green">012</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a> -<FONT color="green">013</FONT> *<a name="line.13"></a> -<FONT color="green">014</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a> -<FONT color="green">015</FONT> * software distributed under the License is distributed on an<a name="line.15"></a> -<FONT color="green">016</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a> -<FONT color="green">017</FONT> * KIND, either express or implied. See the License for the<a name="line.17"></a> -<FONT color="green">018</FONT> * specific language governing permissions and limitations<a name="line.18"></a> -<FONT color="green">019</FONT> * under the License.<a name="line.19"></a> -<FONT color="green">020</FONT> */<a name="line.20"></a> -<FONT color="green">021</FONT> <a name="line.21"></a> -<FONT color="green">022</FONT> import java.io.IOException;<a name="line.22"></a> -<FONT color="green">023</FONT> import java.util.ArrayList;<a name="line.23"></a> -<FONT color="green">024</FONT> import java.util.Iterator;<a name="line.24"></a> -<FONT color="green">025</FONT> import java.util.List;<a name="line.25"></a> -<FONT color="green">026</FONT> <a name="line.26"></a> -<FONT color="green">027</FONT> import net.sf.ehcache.Cache;<a name="line.27"></a> -<FONT color="green">028</FONT> import net.sf.ehcache.CacheManager;<a name="line.28"></a> -<FONT color="green">029</FONT> import net.sf.ehcache.Element;<a name="line.29"></a> -<FONT color="green">030</FONT> <a name="line.30"></a> -<FONT color="green">031</FONT> import org.apache.avalon.framework.activity.Disposable;<a name="line.31"></a> -<FONT color="green">032</FONT> import org.apache.avalon.framework.activity.Initializable;<a name="line.32"></a> -<FONT color="green">033</FONT> import org.apache.avalon.framework.configuration.Configurable;<a name="line.33"></a> -<FONT color="green">034</FONT> import org.apache.avalon.framework.configuration.Configuration;<a name="line.34"></a> -<FONT color="green">035</FONT> import org.apache.avalon.framework.configuration.ConfigurationException;<a name="line.35"></a> -<FONT color="green">036</FONT> import org.apache.avalon.framework.logger.AbstractLogEnabled;<a name="line.36"></a> -<FONT color="green">037</FONT> import org.apache.avalon.framework.thread.ThreadSafe;<a name="line.37"></a> -<FONT color="green">038</FONT> import org.apache.fulcrum.cache.CachedObject;<a name="line.38"></a> -<FONT color="green">039</FONT> import org.apache.fulcrum.cache.GlobalCacheService;<a name="line.39"></a> -<FONT color="green">040</FONT> import org.apache.fulcrum.cache.ObjectExpiredException;<a name="line.40"></a> -<FONT color="green">041</FONT> import org.apache.fulcrum.cache.RefreshableCachedObject;<a name="line.41"></a> -<FONT color="green">042</FONT> <a name="line.42"></a> -<FONT color="green">043</FONT> /**<a name="line.43"></a> -<FONT color="green">044</FONT> * Default implementation of EHCacheService<a name="line.44"></a> -<FONT color="green">045</FONT> * <a name="line.45"></a> -<FONT color="green">046</FONT> * @author <a href="mailto:[email protected]">Eric Pugh</a><a name="line.46"></a> -<FONT color="green">047</FONT> * @author <a href="mailto:[email protected]">Thomas Vandahl</a><a name="line.47"></a> -<FONT color="green">048</FONT> * <a name="line.48"></a> -<FONT color="green">049</FONT> */<a name="line.49"></a> -<FONT color="green">050</FONT> public class EHCacheService extends AbstractLogEnabled implements<a name="line.50"></a> -<FONT color="green">051</FONT> GlobalCacheService, Runnable, Configurable, Disposable, Initializable, ThreadSafe<a name="line.51"></a> -<FONT color="green">052</FONT> {<a name="line.52"></a> -<FONT color="green">053</FONT> /**<a name="line.53"></a> -<FONT color="green">054</FONT> * Cache check frequency in Millis (1000 Millis = 1 second). Value must be ><a name="line.54"></a> -<FONT color="green">055</FONT> * 0. Default = 5 seconds<a name="line.55"></a> -<FONT color="green">056</FONT> */<a name="line.56"></a> -<FONT color="green">057</FONT> public static final long DEFAULT_CACHE_CHECK_FREQUENCY = 5000; // 5 seconds<a name="line.57"></a> -<FONT color="green">058</FONT> <a name="line.58"></a> -<FONT color="green">059</FONT> /**<a name="line.59"></a> -<FONT color="green">060</FONT> * cacheCheckFrequency (default - 5 seconds)<a name="line.60"></a> -<FONT color="green">061</FONT> */<a name="line.61"></a> -<FONT color="green">062</FONT> private long cacheCheckFrequency;<a name="line.62"></a> -<FONT color="green">063</FONT> <a name="line.63"></a> -<FONT color="green">064</FONT> /**<a name="line.64"></a> -<FONT color="green">065</FONT> * Path name of the JCS configuration file<a name="line.65"></a> -<FONT color="green">066</FONT> */<a name="line.66"></a> -<FONT color="green">067</FONT> private String configFile;<a name="line.67"></a> -<FONT color="green">068</FONT> <a name="line.68"></a> -<FONT color="green">069</FONT> /**<a name="line.69"></a> -<FONT color="green">070</FONT> * Constant value which provides a cache name<a name="line.70"></a> -<FONT color="green">071</FONT> */<a name="line.71"></a> -<FONT color="green">072</FONT> private static final String DEFAULT_CACHE_NAME = "fulcrum";<a name="line.72"></a> -<FONT color="green">073</FONT> <a name="line.73"></a> -<FONT color="green">074</FONT> /**<a name="line.74"></a> -<FONT color="green">075</FONT> * A cache name<a name="line.75"></a> -<FONT color="green">076</FONT> */<a name="line.76"></a> -<FONT color="green">077</FONT> private String cacheName;<a name="line.77"></a> -<FONT color="green">078</FONT> <a name="line.78"></a> -<FONT color="green">079</FONT> /** thread for refreshing stale items in the cache */<a name="line.79"></a> -<FONT color="green">080</FONT> private Thread refreshing;<a name="line.80"></a> -<FONT color="green">081</FONT> <a name="line.81"></a> -<FONT color="green">082</FONT> /** flag to stop the housekeeping thread when the component is disposed. */<a name="line.82"></a> -<FONT color="green">083</FONT> private boolean continueThread;<a name="line.83"></a> -<FONT color="green">084</FONT> <a name="line.84"></a> -<FONT color="green">085</FONT> /** The EHCache manager instance */<a name="line.85"></a> -<FONT color="green">086</FONT> private CacheManager cacheManager;<a name="line.86"></a> -<FONT color="green">087</FONT> <a name="line.87"></a> -<FONT color="green">088</FONT> /** A cache instance */<a name="line.88"></a> -<FONT color="green">089</FONT> private Cache cache;<a name="line.89"></a> -<FONT color="green">090</FONT> <a name="line.90"></a> -<FONT color="green">091</FONT> // ---------------- Avalon Lifecycle Methods ---------------------<a name="line.91"></a> -<FONT color="green">092</FONT> <a name="line.92"></a> -<FONT color="green">093</FONT> /**<a name="line.93"></a> -<FONT color="green">094</FONT> * @see org.apache.avalon.framework.configuration.Configurable#configure(org.apache.avalon.framework.configuration.Configuration)<a name="line.94"></a> -<FONT color="green">095</FONT> */<a name="line.95"></a> -<FONT color="green">096</FONT> public void configure(Configuration config) throws ConfigurationException<a name="line.96"></a> -<FONT color="green">097</FONT> {<a name="line.97"></a> -<FONT color="green">098</FONT> this.cacheCheckFrequency = config.getChild("cacheCheckFrequency")<a name="line.98"></a> -<FONT color="green">099</FONT> .getValueAsLong(DEFAULT_CACHE_CHECK_FREQUENCY);<a name="line.99"></a> -<FONT color="green">100</FONT> this.cacheName = config.getChild("cacheName").getValue(DEFAULT_CACHE_NAME);<a name="line.100"></a> -<FONT color="green">101</FONT> this.configFile = config.getChild("configurationFile").getValue(null);<a name="line.101"></a> -<FONT color="green">102</FONT> }<a name="line.102"></a> -<FONT color="green">103</FONT> <a name="line.103"></a> -<FONT color="green">104</FONT> /**<a name="line.104"></a> -<FONT color="green">105</FONT> * @see org.apache.avalon.framework.activity.Initializable#initialize()<a name="line.105"></a> -<FONT color="green">106</FONT> */<a name="line.106"></a> -<FONT color="green">107</FONT> public void initialize() throws Exception<a name="line.107"></a> -<FONT color="green">108</FONT> {<a name="line.108"></a> -<FONT color="green">109</FONT> if (this.configFile == null)<a name="line.109"></a> -<FONT color="green">110</FONT> {<a name="line.110"></a> -<FONT color="green">111</FONT> this.cacheManager = new CacheManager();<a name="line.111"></a> -<FONT color="green">112</FONT> this.cacheManager.addCache(this.cacheName);<a name="line.112"></a> -<FONT color="green">113</FONT> }<a name="line.113"></a> -<FONT color="green">114</FONT> else<a name="line.114"></a> -<FONT color="green">115</FONT> {<a name="line.115"></a> -<FONT color="green">116</FONT> this.cacheManager = new CacheManager(this.configFile);<a name="line.116"></a> -<FONT color="green">117</FONT> }<a name="line.117"></a> -<FONT color="green">118</FONT> <a name="line.118"></a> -<FONT color="green">119</FONT> this.cache = this.cacheManager.getCache(this.cacheName);<a name="line.119"></a> -<FONT color="green">120</FONT> <a name="line.120"></a> -<FONT color="green">121</FONT> // Start housekeeping thread.<a name="line.121"></a> -<FONT color="green">122</FONT> this.continueThread = true;<a name="line.122"></a> -<FONT color="green">123</FONT> this.refreshing = new Thread(this);<a name="line.123"></a> -<FONT color="green">124</FONT> <a name="line.124"></a> -<FONT color="green">125</FONT> // Indicate that this is a system thread. JVM will quit only when<a name="line.125"></a> -<FONT color="green">126</FONT> // there are no more active user threads. Settings threads spawned<a name="line.126"></a> -<FONT color="green">127</FONT> // internally by Turbine as daemons allows commandline applications<a name="line.127"></a> -<FONT color="green">128</FONT> // using Turbine to terminate in an orderly manner.<a name="line.128"></a> -<FONT color="green">129</FONT> this.refreshing.setDaemon(true);<a name="line.129"></a> -<FONT color="green">130</FONT> this.refreshing.setName("EHCacheService Refreshing");<a name="line.130"></a> -<FONT color="green">131</FONT> this.refreshing.start();<a name="line.131"></a> -<FONT color="green">132</FONT> <a name="line.132"></a> -<FONT color="green">133</FONT> getLogger().debug("EHCacheService started!");<a name="line.133"></a> -<FONT color="green">134</FONT> }<a name="line.134"></a> -<FONT color="green">135</FONT> <a name="line.135"></a> -<FONT color="green">136</FONT> /**<a name="line.136"></a> -<FONT color="green">137</FONT> * @see org.apache.avalon.framework.activity.Disposable#dispose()<a name="line.137"></a> -<FONT color="green">138</FONT> */<a name="line.138"></a> -<FONT color="green">139</FONT> public void dispose()<a name="line.139"></a> -<FONT color="green">140</FONT> {<a name="line.140"></a> -<FONT color="green">141</FONT> this.continueThread = false;<a name="line.141"></a> -<FONT color="green">142</FONT> this.refreshing.interrupt();<a name="line.142"></a> -<FONT color="green">143</FONT> <a name="line.143"></a> -<FONT color="green">144</FONT> this.cacheManager.shutdown();<a name="line.144"></a> -<FONT color="green">145</FONT> this.cacheManager = null;<a name="line.145"></a> -<FONT color="green">146</FONT> this.cache = null;<a name="line.146"></a> -<FONT color="green">147</FONT> getLogger().debug("EHCacheService stopped!");<a name="line.147"></a> -<FONT color="green">148</FONT> }<a name="line.148"></a> -<FONT color="green">149</FONT> <a name="line.149"></a> -<FONT color="green">150</FONT> /**<a name="line.150"></a> -<FONT color="green">151</FONT> * @see org.apache.fulcrum.cache.GlobalCacheService#addObject(java.lang.String, org.apache.fulcrum.cache.CachedObject)<a name="line.151"></a> -<FONT color="green">152</FONT> */<a name="line.152"></a> -<FONT color="green">153</FONT> public void addObject(String id, CachedObject o)<a name="line.153"></a> -<FONT color="green">154</FONT> {<a name="line.154"></a> -<FONT color="green">155</FONT> Element cacheElement = new Element(id, o);<a name="line.155"></a> -<FONT color="green">156</FONT> <a name="line.156"></a> -<FONT color="green">157</FONT> if (o instanceof RefreshableCachedObject)<a name="line.157"></a> -<FONT color="green">158</FONT> {<a name="line.158"></a> -<FONT color="green">159</FONT> cacheElement.setEternal(true);<a name="line.159"></a> -<FONT color="green">160</FONT> }<a name="line.160"></a> -<FONT color="green">161</FONT> else<a name="line.161"></a> -<FONT color="green">162</FONT> {<a name="line.162"></a> -<FONT color="green">163</FONT> cacheElement.setEternal(false);<a name="line.163"></a> -<FONT color="green">164</FONT> cacheElement.setTimeToLive((int)(o.getExpires() + 500) / 1000);<a name="line.164"></a> -<FONT color="green">165</FONT> }<a name="line.165"></a> -<FONT color="green">166</FONT> <a name="line.166"></a> -<FONT color="green">167</FONT> cacheElement.setCreateTime();<a name="line.167"></a> -<FONT color="green">168</FONT> <a name="line.168"></a> -<FONT color="green">169</FONT> this.cache.put(cacheElement);<a name="line.169"></a> -<FONT color="green">170</FONT> }<a name="line.170"></a> -<FONT color="green">171</FONT> <a name="line.171"></a> -<FONT color="green">172</FONT> /**<a name="line.172"></a> -<FONT color="green">173</FONT> * @see org.apache.fulcrum.cache.GlobalCacheService#flushCache()<a name="line.173"></a> -<FONT color="green">174</FONT> */<a name="line.174"></a> -<FONT color="green">175</FONT> public void flushCache()<a name="line.175"></a> -<FONT color="green">176</FONT> {<a name="line.176"></a> -<FONT color="green">177</FONT> this.cache.removeAll();<a name="line.177"></a> -<FONT color="green">178</FONT> }<a name="line.178"></a> -<FONT color="green">179</FONT> <a name="line.179"></a> -<FONT color="green">180</FONT> /**<a name="line.180"></a> -<FONT color="green">181</FONT> * @see org.apache.fulcrum.cache.GlobalCacheService#getCachedObjects()<a name="line.181"></a> -<FONT color="green">182</FONT> */<a name="line.182"></a> -<FONT color="green">183</FONT> public List getCachedObjects()<a name="line.183"></a> -<FONT color="green">184</FONT> {<a name="line.184"></a> -<FONT color="green">185</FONT> ArrayList values = new ArrayList();<a name="line.185"></a> -<FONT color="green">186</FONT> <a name="line.186"></a> -<FONT color="green">187</FONT> for (Iterator i = getKeys().iterator(); i.hasNext();)<a name="line.187"></a> -<FONT color="green">188</FONT> {<a name="line.188"></a> -<FONT color="green">189</FONT> Element cachedElement = this.cache.get(i.next());<a name="line.189"></a> -<FONT color="green">190</FONT> <a name="line.190"></a> -<FONT color="green">191</FONT> if (cachedElement != null)<a name="line.191"></a> -<FONT color="green">192</FONT> {<a name="line.192"></a> -<FONT color="green">193</FONT> values.add(cachedElement.getObjectValue());<a name="line.193"></a> -<FONT color="green">194</FONT> }<a name="line.194"></a> -<FONT color="green">195</FONT> }<a name="line.195"></a> -<FONT color="green">196</FONT> <a name="line.196"></a> -<FONT color="green">197</FONT> return values;<a name="line.197"></a> -<FONT color="green">198</FONT> }<a name="line.198"></a> -<FONT color="green">199</FONT> <a name="line.199"></a> -<FONT color="green">200</FONT> /**<a name="line.200"></a> -<FONT color="green">201</FONT> * @see org.apache.fulcrum.cache.GlobalCacheService#getCacheSize()<a name="line.201"></a> -<FONT color="green">202</FONT> */<a name="line.202"></a> -<FONT color="green">203</FONT> public int getCacheSize() throws IOException<a name="line.203"></a> -<FONT color="green">204</FONT> {<a name="line.204"></a> -<FONT color="green">205</FONT> return (int)this.cache.calculateInMemorySize();<a name="line.205"></a> -<FONT color="green">206</FONT> }<a name="line.206"></a> -<FONT color="green">207</FONT> <a name="line.207"></a> -<FONT color="green">208</FONT> /**<a name="line.208"></a> -<FONT color="green">209</FONT> * @see org.apache.fulcrum.cache.GlobalCacheService#getKeys()<a name="line.209"></a> -<FONT color="green">210</FONT> */<a name="line.210"></a> -<FONT color="green">211</FONT> public List getKeys()<a name="line.211"></a> -<FONT color="green">212</FONT> {<a name="line.212"></a> -<FONT color="green">213</FONT> return this.cache.getKeysWithExpiryCheck();<a name="line.213"></a> -<FONT color="green">214</FONT> }<a name="line.214"></a> -<FONT color="green">215</FONT> <a name="line.215"></a> -<FONT color="green">216</FONT> /**<a name="line.216"></a> -<FONT color="green">217</FONT> * @see org.apache.fulcrum.cache.GlobalCacheService#getNumberOfObjects()<a name="line.217"></a> -<FONT color="green">218</FONT> */<a name="line.218"></a> -<FONT color="green">219</FONT> public int getNumberOfObjects()<a name="line.219"></a> -<FONT color="green">220</FONT> {<a name="line.220"></a> -<FONT color="green">221</FONT> return getKeys().size();<a name="line.221"></a> -<FONT color="green">222</FONT> }<a name="line.222"></a> -<FONT color="green">223</FONT> <a name="line.223"></a> -<FONT color="green">224</FONT> /**<a name="line.224"></a> -<FONT color="green">225</FONT> * @see org.apache.fulcrum.cache.GlobalCacheService#getObject(java.lang.String)<a name="line.225"></a> -<FONT color="green">226</FONT> */<a name="line.226"></a> -<FONT color="green">227</FONT> public CachedObject getObject(String id) throws ObjectExpiredException<a name="line.227"></a> -<FONT color="green">228</FONT> {<a name="line.228"></a> -<FONT color="green">229</FONT> Element cachedElement = this.cache.get(id);<a name="line.229"></a> -<FONT color="green">230</FONT> <a name="line.230"></a> -<FONT color="green">231</FONT> if (cachedElement == null)<a name="line.231"></a> -<FONT color="green">232</FONT> {<a name="line.232"></a> -<FONT color="green">233</FONT> // Not in the cache.<a name="line.233"></a> -<FONT color="green">234</FONT> throw new ObjectExpiredException();<a name="line.234"></a> -<FONT color="green">235</FONT> }<a name="line.235"></a> -<FONT color="green">236</FONT> <a name="line.236"></a> -<FONT color="green">237</FONT> CachedObject obj = (CachedObject)cachedElement.getObjectValue();<a name="line.237"></a> -<FONT color="green">238</FONT> <a name="line.238"></a> -<FONT color="green">239</FONT> if (obj.isStale())<a name="line.239"></a> -<FONT color="green">240</FONT> {<a name="line.240"></a> -<FONT color="green">241</FONT> if (obj instanceof RefreshableCachedObject)<a name="line.241"></a> -<FONT color="green">242</FONT> {<a name="line.242"></a> -<FONT color="green">243</FONT> RefreshableCachedObject rco = (RefreshableCachedObject) obj;<a name="line.243"></a> -<FONT color="green">244</FONT> if (rco.isUntouched())<a name="line.244"></a> -<FONT color="green">245</FONT> {<a name="line.245"></a> -<FONT color="green">246</FONT> // Do not refresh an object that has exceeded TimeToLive<a name="line.246"></a> -<FONT color="green">247</FONT> removeObject(id);<a name="line.247"></a> -<FONT color="green">248</FONT> throw new ObjectExpiredException();<a name="line.248"></a> -<FONT color="green">249</FONT> }<a name="line.249"></a> -<FONT color="green">250</FONT> <a name="line.250"></a> -<FONT color="green">251</FONT> // Refresh Object<a name="line.251"></a> -<FONT color="green">252</FONT> rco.refresh();<a name="line.252"></a> -<FONT color="green">253</FONT> if (rco.isStale())<a name="line.253"></a> -<FONT color="green">254</FONT> {<a name="line.254"></a> -<FONT color="green">255</FONT> // Object is Expired, remove it from cache.<a name="line.255"></a> -<FONT color="green">256</FONT> removeObject(id);<a name="line.256"></a> -<FONT color="green">257</FONT> throw new ObjectExpiredException();<a name="line.257"></a> -<FONT color="green">258</FONT> }<a name="line.258"></a> -<FONT color="green">259</FONT> }<a name="line.259"></a> -<FONT color="green">260</FONT> else<a name="line.260"></a> -<FONT color="green">261</FONT> {<a name="line.261"></a> -<FONT color="green">262</FONT> // Expired.<a name="line.262"></a> -<FONT color="green">263</FONT> removeObject(id);<a name="line.263"></a> -<FONT color="green">264</FONT> throw new ObjectExpiredException();<a name="line.264"></a> -<FONT color="green">265</FONT> }<a name="line.265"></a> -<FONT color="green">266</FONT> }<a name="line.266"></a> -<FONT color="green">267</FONT> <a name="line.267"></a> -<FONT color="green">268</FONT> if (obj instanceof RefreshableCachedObject)<a name="line.268"></a> -<FONT color="green">269</FONT> {<a name="line.269"></a> -<FONT color="green">270</FONT> // notify it that it's being accessed.<a name="line.270"></a> -<FONT color="green">271</FONT> RefreshableCachedObject rco = (RefreshableCachedObject) obj;<a name="line.271"></a> -<FONT color="green">272</FONT> rco.touch();<a name="line.272"></a> -<FONT color="green">273</FONT> }<a name="line.273"></a> -<FONT color="green">274</FONT> <a name="line.274"></a> -<FONT color="green">275</FONT> return obj;<a name="line.275"></a> -<FONT color="green">276</FONT> }<a name="line.276"></a> -<FONT color="green">277</FONT> <a name="line.277"></a> -<FONT color="green">278</FONT> /**<a name="line.278"></a> -<FONT color="green">279</FONT> * @see org.apache.fulcrum.cache.GlobalCacheService#removeObject(java.lang.String)<a name="line.279"></a> -<FONT color="green">280</FONT> */<a name="line.280"></a> -<FONT color="green">281</FONT> public void removeObject(String id)<a name="line.281"></a> -<FONT color="green">282</FONT> {<a name="line.282"></a> -<FONT color="green">283</FONT> this.cache.remove(id);<a name="line.283"></a> -<FONT color="green">284</FONT> }<a name="line.284"></a> -<FONT color="green">285</FONT> <a name="line.285"></a> -<FONT color="green">286</FONT> /**<a name="line.286"></a> -<FONT color="green">287</FONT> * Circle through the cache and refresh stale objects. Frequency is<a name="line.287"></a> -<FONT color="green">288</FONT> * determined by the cacheCheckFrequency property.<a name="line.288"></a> -<FONT color="green">289</FONT> */<a name="line.289"></a> -<FONT color="green">290</FONT> public void run()<a name="line.290"></a> -<FONT color="green">291</FONT> {<a name="line.291"></a> -<FONT color="green">292</FONT> while (this.continueThread)<a name="line.292"></a> -<FONT color="green">293</FONT> {<a name="line.293"></a> -<FONT color="green">294</FONT> // Sleep for amount of time set in cacheCheckFrequency -<a name="line.294"></a> -<FONT color="green">295</FONT> // default = 5 seconds.<a name="line.295"></a> -<FONT color="green">296</FONT> try<a name="line.296"></a> -<FONT color="green">297</FONT> {<a name="line.297"></a> -<FONT color="green">298</FONT> Thread.sleep(this.cacheCheckFrequency);<a name="line.298"></a> -<FONT color="green">299</FONT> }<a name="line.299"></a> -<FONT color="green">300</FONT> catch (InterruptedException exc)<a name="line.300"></a> -<FONT color="green">301</FONT> {<a name="line.301"></a> -<FONT color="green">302</FONT> if (!this.continueThread)<a name="line.302"></a> -<FONT color="green">303</FONT> {<a name="line.303"></a> -<FONT color="green">304</FONT> return;<a name="line.304"></a> -<FONT color="green">305</FONT> }<a name="line.305"></a> -<FONT color="green">306</FONT> }<a name="line.306"></a> -<FONT color="green">307</FONT> <a name="line.307"></a> -<FONT color="green">308</FONT> for (Iterator i = getKeys().iterator(); i.hasNext();)<a name="line.308"></a> -<FONT color="green">309</FONT> {<a name="line.309"></a> -<FONT color="green">310</FONT> String key = (String) i.next();<a name="line.310"></a> -<FONT color="green">311</FONT> <a name="line.311"></a> -<FONT color="green">312</FONT> Element cachedElement = this.cache.get(key);<a name="line.312"></a> -<FONT color="green">313</FONT> <a name="line.313"></a> -<FONT color="green">314</FONT> if (cachedElement == null)<a name="line.314"></a> -<FONT color="green">315</FONT> {<a name="line.315"></a> -<FONT color="green">316</FONT> this.cache.remove(key);<a name="line.316"></a> -<FONT color="green">317</FONT> continue;<a name="line.317"></a> -<FONT color="green">318</FONT> }<a name="line.318"></a> -<FONT color="green">319</FONT> <a name="line.319"></a> -<FONT color="green">320</FONT> Object o = cachedElement.getObjectValue();<a name="line.320"></a> -<FONT color="green">321</FONT> <a name="line.321"></a> -<FONT color="green">322</FONT> if (o instanceof RefreshableCachedObject)<a name="line.322"></a> -<FONT color="green">323</FONT> {<a name="line.323"></a> -<FONT color="green">324</FONT> RefreshableCachedObject rco = (RefreshableCachedObject) o;<a name="line.324"></a> -<FONT color="green">325</FONT> if (rco.isUntouched())<a name="line.325"></a> -<FONT color="green">326</FONT> {<a name="line.326"></a> -<FONT color="green">327</FONT> this.cache.remove(key);<a name="line.327"></a> -<FONT color="green">328</FONT> }<a name="line.328"></a> -<FONT color="green">329</FONT> else if (rco.isStale())<a name="line.329"></a> -<FONT color="green">330</FONT> {<a name="line.330"></a> -<FONT color="green">331</FONT> rco.refresh();<a name="line.331"></a> -<FONT color="green">332</FONT> }<a name="line.332"></a> -<FONT color="green">333</FONT> }<a name="line.333"></a> -<FONT color="green">334</FONT> }<a name="line.334"></a> -<FONT color="green">335</FONT> }<a name="line.335"></a> -<FONT color="green">336</FONT> }<a name="line.336"></a> -<FONT color="green">337</FONT> }<a name="line.337"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</PRE> -</BODY> -</HTML> +<!DOCTYPE HTML> +<html lang="de"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<main role="main"> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.fulcrum.cache.impl;</a> +<span class="sourceLineNo">002</span><a id="line.2"></a> +<span class="sourceLineNo">003</span><a id="line.3">/*</a> +<span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a> +<span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> +<span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> +<span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> +<span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> +<span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> +<span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> +<span class="sourceLineNo">011</span><a id="line.11"> *</a> +<span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> +<span class="sourceLineNo">013</span><a id="line.13"> *</a> +<span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> +<span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> +<span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> +<span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> +<span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> +<span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a> +<span class="sourceLineNo">020</span><a id="line.20"> */</a> +<span class="sourceLineNo">021</span><a id="line.21"></a> +<span class="sourceLineNo">022</span><a id="line.22">import java.io.IOException;</a> +<span class="sourceLineNo">023</span><a id="line.23">import java.util.ArrayList;</a> +<span class="sourceLineNo">024</span><a id="line.24">import java.util.List;</a> +<span class="sourceLineNo">025</span><a id="line.25"></a> +<span class="sourceLineNo">026</span><a id="line.26">import org.apache.avalon.framework.activity.Disposable;</a> +<span class="sourceLineNo">027</span><a id="line.27">import org.apache.avalon.framework.activity.Initializable;</a> +<span class="sourceLineNo">028</span><a id="line.28">import org.apache.avalon.framework.configuration.Configurable;</a> +<span class="sourceLineNo">029</span><a id="line.29">import org.apache.avalon.framework.configuration.Configuration;</a> +<span class="sourceLineNo">030</span><a id="line.30">import org.apache.avalon.framework.configuration.ConfigurationException;</a> +<span class="sourceLineNo">031</span><a id="line.31">import org.apache.avalon.framework.logger.AbstractLogEnabled;</a> +<span class="sourceLineNo">032</span><a id="line.32">import org.apache.avalon.framework.thread.ThreadSafe;</a> +<span class="sourceLineNo">033</span><a id="line.33">import org.apache.fulcrum.cache.CachedObject;</a> +<span class="sourceLineNo">034</span><a id="line.34">import org.apache.fulcrum.cache.GlobalCacheService;</a> +<span class="sourceLineNo">035</span><a id="line.35">import org.apache.fulcrum.cache.ObjectExpiredException;</a> +<span class="sourceLineNo">036</span><a id="line.36">import org.apache.fulcrum.cache.RefreshableCachedObject;</a> +<span class="sourceLineNo">037</span><a id="line.37"></a> +<span class="sourceLineNo">038</span><a id="line.38">import net.sf.ehcache.Cache;</a> +<span class="sourceLineNo">039</span><a id="line.39">import net.sf.ehcache.CacheManager;</a> +<span class="sourceLineNo">040</span><a id="line.40">import net.sf.ehcache.Element;</a> +<span class="sourceLineNo">041</span><a id="line.41"></a> +<span class="sourceLineNo">042</span><a id="line.42">/**</a> +<span class="sourceLineNo">043</span><a id="line.43"> * Default implementation of EHCacheService (Ehcache 2)</a> +<span class="sourceLineNo">044</span><a id="line.44"> *</a> +<span class="sourceLineNo">045</span><a id="line.45"> * @author <a href="mailto:[email protected]">Eric Pugh</a></a> +<span class="sourceLineNo">046</span><a id="line.46"> * @author <a href="mailto:[email protected]">Thomas Vandahl</a></a> +<span class="sourceLineNo">047</span><a id="line.47"> *</a> +<span class="sourceLineNo">048</span><a id="line.48"> */</a> +<span class="sourceLineNo">049</span><a id="line.49">public class EHCacheService extends AbstractLogEnabled implements</a> +<span class="sourceLineNo">050</span><a id="line.50"> GlobalCacheService, Runnable, Configurable, Disposable, Initializable, ThreadSafe</a> +<span class="sourceLineNo">051</span><a id="line.51">{</a> +<span class="sourceLineNo">052</span><a id="line.52"> /**</a> +<span class="sourceLineNo">053</span><a id="line.53"> * Cache check frequency in Millis (1000 Millis = 1 second). Value must be &gt;</a> +<span class="sourceLineNo">054</span><a id="line.54"> * 0. Default = 5 seconds</a> +<span class="sourceLineNo">055</span><a id="line.55"> */</a> +<span class="sourceLineNo">056</span><a id="line.56"> public static final long DEFAULT_CACHE_CHECK_FREQUENCY = 5000; // 5 seconds</a> +<span class="sourceLineNo">057</span><a id="line.57"></a> +<span class="sourceLineNo">058</span><a id="line.58"> /**</a> +<span class="sourceLineNo">059</span><a id="line.59"> * cacheCheckFrequency (default - 5 seconds)</a> +<span class="sourceLineNo">060</span><a id="line.60"> */</a> +<span class="sourceLineNo">061</span><a id="line.61"> private long cacheCheckFrequency;</a> +<span class="sourceLineNo">062</span><a id="line.62"></a> +<span class="sourceLineNo">063</span><a id="line.63"> /**</a> +<span class="sourceLineNo">064</span><a id="line.64"> * Path name of the Ehcache configuration file</a> +<span class="sourceLineNo">065</span><a id="line.65"> */</a> +<span class="sourceLineNo">066</span><a id="line.66"> private String configFile;</a> +<span class="sourceLineNo">067</span><a id="line.67"></a> +<span class="sourceLineNo">068</span><a id="line.68"> /**</a> +<span class="sourceLineNo">069</span><a id="line.69"> * Constant value which provides a cache name</a> +<span class="sourceLineNo">070</span><a id="line.70"> */</a> +<span class="sourceLineNo">071</span><a id="line.71"> private static final String DEFAULT_CACHE_NAME = "fulcrum";</a> +<span class="sourceLineNo">072</span><a id="line.72"></a> +<span class="sourceLineNo">073</span><a id="line.73"> /**</a> +<span class="sourceLineNo">074</span><a id="line.74"> * A cache name</a> +<span class="sourceLineNo">075</span><a id="line.75"> */</a> +<span class="sourceLineNo">076</span><a id="line.76"> private String cacheName;</a> +<span class="sourceLineNo">077</span><a id="line.77"></a> +<span class="sourceLineNo">078</span><a id="line.78"> /** thread for refreshing stale items in the cache */</a> +<span class="sourceLineNo">079</span><a id="line.79"> private Thread refreshing;</a> +<span class="sourceLineNo">080</span><a id="line.80"></a> +<span class="sourceLineNo">081</span><a id="line.81"> /** flag to stop the housekeeping thread when the component is disposed. */</a> +<span class="sourceLineNo">082</span><a id="line.82"> private boolean continueThread;</a> +<span class="sourceLineNo">083</span><a id="line.83"></a> +<span class="sourceLineNo">084</span><a id="line.84"> /** The EHCache manager instance */</a> +<span class="sourceLineNo">085</span><a id="line.85"> private CacheManager cacheManager;</a> +<span class="sourceLineNo">086</span><a id="line.86"></a> +<span class="sourceLineNo">087</span><a id="line.87"> /** A cache instance */</a> +<span class="sourceLineNo">088</span><a id="line.88"> private Cache cache;</a> +<span class="sourceLineNo">089</span><a id="line.89"></a> +<span class="sourceLineNo">090</span><a id="line.90"> public EHCacheService()</a> +<span class="sourceLineNo">091</span><a id="line.91"> {</a> +<span class="sourceLineNo">092</span><a id="line.92"> </a> +<span class="sourceLineNo">093</span><a id="line.93"> }</a> +<span class="sourceLineNo">094</span><a id="line.94"> // ---------------- Avalon Lifecycle Methods ---------------------</a> +<span class="sourceLineNo">095</span><a id="line.95"></a> +<span class="sourceLineNo">096</span><a id="line.96"> /**</a> +<span class="sourceLineNo">097</span><a id="line.97"> * @see org.apache.avalon.framework.configuration.Configurable#configure(org.apache.avalon.framework.configuration.Configuration)</a> +<span class="sourceLineNo">098</span><a id="line.98"> */</a> +<span class="sourceLineNo">099</span><a id="line.99"> @Override</a> +<span class="sourceLineNo">100</span><a id="line.100"> public void configure(Configuration config) throws ConfigurationException</a> +<span class="sourceLineNo">101</span><a id="line.101"> {</a> +<span class="sourceLineNo">102</span><a id="line.102"> this.cacheCheckFrequency = config.getChild("cacheCheckFrequency")</a> +<span class="sourceLineNo">103</span><a id="line.103"> .getValueAsLong(DEFAULT_CACHE_CHECK_FREQUENCY);</a> +<span class="sourceLineNo">104</span><a id="line.104"> this.cacheName = config.getChild("cacheName").getValue(DEFAULT_CACHE_NAME);</a> +<span class="sourceLineNo">105</span><a id="line.105"> this.configFile = config.getChild("configurationFile").getValue(null);</a> +<span class="sourceLineNo">106</span><a id="line.106"> }</a> +<span class="sourceLineNo">107</span><a id="line.107"></a> +<span class="sourceLineNo">108</span><a id="line.108"> /**</a> +<span class="sourceLineNo">109</span><a id="line.109"> * @see org.apache.avalon.framework.activity.Initializable#initialize()</a> +<span class="sourceLineNo">110</span><a id="line.110"> */</a> +<span class="sourceLineNo">111</span><a id="line.111"> @Override</a> +<span class="sourceLineNo">112</span><a id="line.112"> public void initialize() throws Exception</a> +<span class="sourceLineNo">113</span><a id="line.113"> {</a> +<span class="sourceLineNo">114</span><a id="line.114"> if (this.configFile == null)</a> +<span class="sourceLineNo">115</span><a id="line.115"> {</a> +<span class="sourceLineNo">116</span><a id="line.116"> this.cacheManager = new CacheManager();</a> +<span class="sourceLineNo">117</span><a id="line.117"> this.cacheManager.addCache(this.cacheName);</a> +<span class="sourceLineNo">118</span><a id="line.118"> }</a> +<span class="sourceLineNo">119</span><a id="line.119"> else</a> +<span class="sourceLineNo">120</span><a id="line.120"> {</a> +<span class="sourceLineNo">121</span><a id="line.121"> this.cacheManager = new CacheManager(this.configFile);</a> +<span class="sourceLineNo">122</span><a id="line.122"> }</a> +<span class="sourceLineNo">123</span><a id="line.123"></a> +<span class="sourceLineNo">124</span><a id="line.124"> this.cache = this.cacheManager.getCache(this.cacheName);</a> +<span class="sourceLineNo">125</span><a id="line.125"></a> +<span class="sourceLineNo">126</span><a id="line.126"> // Start housekeeping thread.</a> +<span class="sourceLineNo">127</span><a id="line.127"> this.continueThread = true;</a> +<span class="sourceLineNo">128</span><a id="line.128"> this.refreshing = new Thread(this);</a> +<span class="sourceLineNo">129</span><a id="line.129"></a> +<span class="sourceLineNo">130</span><a id="line.130"> // Indicate that this is a system thread. JVM will quit only when</a> +<span class="sourceLineNo">131</span><a id="line.131"> // there are no more active user threads. Settings threads spawned</a> +<span class="sourceLineNo">132</span><a id="line.132"> // internally by Turbine as daemons allows commandline applications</a> +<span class="sourceLineNo">133</span><a id="line.133"> // using Turbine to terminate in an orderly manner.</a> +<span class="sourceLineNo">134</span><a id="line.134"> this.refreshing.setDaemon(true);</a> +<span class="sourceLineNo">135</span><a id="line.135"> this.refreshing.setName("EHCacheService Refreshing");</a> +<span class="sourceLineNo">136</span><a id="line.136"> this.refreshing.start();</a> +<span class="sourceLineNo">137</span><a id="line.137"></a> +<span class="sourceLineNo">138</span><a id="line.138"> getLogger().debug("EHCacheService started!");</a> +<span class="sourceLineNo">139</span><a id="line.139"> }</a> +<span class="sourceLineNo">140</span><a id="line.140"></a> +<span class="sourceLineNo">141</span><a id="line.141"> /**</a> +<span class="sourceLineNo">142</span><a id="line.142"> * @see org.apache.avalon.framework.activity.Disposable#dispose()</a> +<span class="sourceLineNo">143</span><a id="line.143"> */</a> +<span class="sourceLineNo">144</span><a id="line.144"> @Override</a> +<span class="sourceLineNo">145</span><a id="line.145"> public void dispose()</a> +<span class="sourceLineNo">146</span><a id="line.146"> {</a> +<span class="sourceLineNo">147</span><a id="line.147"> this.continueThread = false;</a> +<span class="sourceLineNo">148</span><a id="line.148"> this.refreshing.interrupt();</a> +<span class="sourceLineNo">149</span><a id="line.149"></a> +<span class="sourceLineNo">150</span><a id="line.150"> this.cacheManager.shutdown();</a> +<span class="sourceLineNo">151</span><a id="line.151"> this.cacheManager = null;</a> +<span class="sourceLineNo">152</span><a id="line.152"> this.cache = null;</a> +<span class="sourceLineNo">153</span><a id="line.153"> getLogger().debug("EHCacheService stopped!");</a> +<span class="sourceLineNo">154</span><a id="line.154"> }</a> +<span class="sourceLineNo">155</span><a id="line.155"></a> +<span class="sourceLineNo">156</span><a id="line.156"> /**</a> +<span class="sourceLineNo">157</span><a id="line.157"> * @see org.apache.fulcrum.cache.GlobalCacheService#addObject(java.lang.String, org.apache.fulcrum.cache.CachedObject)</a> +<span class="sourceLineNo">158</span><a id="line.158"> */</a> +<span class="sourceLineNo">159</span><a id="line.159"> @Override</a> +<span class="sourceLineNo">160</span><a id="line.160"> public <T> void addObject(String objectId, CachedObject<T> object)</a> +<span class="sourceLineNo">161</span><a id="line.161"> {</a> +<span class="sourceLineNo">162</span><a id="line.162"> Element cacheElement = new Element(objectId, object);</a> +<span class="sourceLineNo">163</span><a id="line.163"></a> +<span class="sourceLineNo">164</span><a id="line.164"> if (object instanceof RefreshableCachedObject)</a> +<span class="sourceLineNo">165</span><a id="line.165"> {</a> +<span class="sourceLineNo">166</span><a id="line.166"> cacheElement.setEternal(true);</a> +<span class="sourceLineNo">167</span><a id="line.167"> }</a> +<span class="sourceLineNo">168</span><a id="line.168"> else</a> +<span class="sourceLineNo">169</span><a id="line.169"> {</a> +<span class="sourceLineNo">170</span><a id="line.170"> cacheElement.setEternal(false);</a> +<span class="sourceLineNo">171</span><a id="line.171"> cacheElement.setTimeToLive((int)(object.getExpires() + 500) / 1000);</a> +<span class="sourceLineNo">172</span><a id="line.172"> }</a> +<span class="sourceLineNo">173</span><a id="line.173"></a> +<span class="sourceLineNo">174</span><a id="line.174"> this.cache.put(cacheElement);</a> +<span class="sourceLineNo">175</span><a id="line.175"> }</a> +<span class="sourceLineNo">176</span><a id="line.176"></a> +<span class="sourceLineNo">177</span><a id="line.177"> /**</a> +<span class="sourceLineNo">178</span><a id="line.178"> * @see org.apache.fulcrum.cache.GlobalCacheService#flushCache()</a> +<span class="sourceLineNo">179</span><a id="line.179"> */</a> +<span class="sourceLineNo">180</span><a id="line.180"> @Override</a> +<span class="sourceLineNo">181</span><a id="line.181"> public void flushCache()</a> +<span class="sourceLineNo">182</span><a id="line.182"> {</a> +<span class="sourceLineNo">183</span><a id="line.183"> this.cache.removeAll();</a> +<span class="sourceLineNo">184</span><a id="line.184"> }</a> +<span class="sourceLineNo">185</span><a id="line.185"></a> +<span class="sourceLineNo">186</span><a id="line.186"> /**</a> +<span class="sourceLineNo">187</span><a id="line.187"> * @see org.apache.fulcrum.cache.GlobalCacheService#getCachedObjects()</a> +<span class="sourceLineNo">188</span><a id="line.188"> */</a> +<span class="sourceLineNo">189</span><a id="line.189"> @Override</a> +<span class="sourceLineNo">190</span><a id="line.190"> public List<CachedObject<?>> getCachedObjects()</a> +<span class="sourceLineNo">191</span><a id="line.191"> {</a> +<span class="sourceLineNo">192</span><a id="line.192"> ArrayList<CachedObject<?>> values = new ArrayList<CachedObject<?>>();</a> +<span class="sourceLineNo">193</span><a id="line.193"></a> +<span class="sourceLineNo">194</span><a id="line.194"> for (String key : getKeys())</a> +<span class="sourceLineNo">195</span><a id="line.195"> {</a> +<span class="sourceLineNo">196</span><a id="line.196"> Element cachedElement = this.cache.get(key);</a> +<span class="sourceLineNo">197</span><a id="line.197"></a> +<span class="sourceLineNo">198</span><a id="line.198"> if (cachedElement != null)</a> +<span class="sourceLineNo">199</span><a id="line.199"> {</a> +<span class="sourceLineNo">200</span><a id="line.200"> values.add((CachedObject<?>)cachedElement.getObjectValue());</a> +<span class="sourceLineNo">201</span><a id="line.201"> }</a> +<span class="sourceLineNo">202</span><a id="line.202"> }</a> +<span class="sourceLineNo">203</span><a id="line.203"></a> +<span class="sourceLineNo">204</span><a id="line.204"> return values;</a> +<span class="sourceLineNo">205</span><a id="line.205"> }</a> +<span class="sourceLineNo">206</span><a id="line.206"></a> +<span class="sourceLineNo">207</span><a id="line.207"> /**</a> +<span class="sourceLineNo">208</span><a id="line.208"> * @see org.apache.fulcrum.cache.GlobalCacheService#getCacheSize()</a> +<span class="sourceLineNo">209</span><a id="line.209"> */</a> +<span class="sourceLineNo">210</span><a id="line.210"> @SuppressWarnings("deprecation")</a> +<span class="sourceLineNo">211</span><a id="line.211"> @Override</a> +<span class="sourceLineNo">212</span><a id="line.212"> public int getCacheSize() throws IOException</a> +<span class="sourceLineNo">213</span><a id="line.213"> {</a> +<span class="sourceLineNo">214</span><a id="line.214"> return (int)this.cache.calculateInMemorySize();</a> +<span class="sourceLineNo">215</span><a id="line.215"> }</a> +<span class="sourceLineNo">216</span><a id="line.216"></a> +<span class="sourceLineNo">217</span><a id="line.217"> /**</a> +<span class="sourceLineNo">218</span><a id="line.218"> * @see org.apache.fulcrum.cache.GlobalCacheService#getKeys()</a> +<span class="sourceLineNo">219</span><a id="line.219"> */</a> +<span class="sourceLineNo">220</span><a id="line.220"> @Override</a> +<span class="sourceLineNo">221</span><a id="line.221"> public List<String> getKeys()</a> +<span class="sourceLineNo">222</span><a id="line.222"> {</a> +<span class="sourceLineNo">223</span><a id="line.223"> @SuppressWarnings("unchecked")</a> +<span class="sourceLineNo">224</span><a id="line.224"> List<String> keysWithExpiryCheck = this.cache.getKeysWithExpiryCheck();</a> +<span class="sourceLineNo">225</span><a id="line.225"> return keysWithExpiryCheck;</a> +<span class="sourceLineNo">226</span><a id="line.226"> }</a> +<span class="sourceLineNo">227</span><a id="line.227"></a> +<span class="sourceLineNo">228</span><a id="line.228"> /**</a> +<span class="sourceLineNo">229</span><a id="line.229"> * @see org.apache.fulcrum.cache.GlobalCacheService#getNumberOfObjects()</a> +<span class="sourceLineNo">230</span><a id="line.230"> */</a> +<span class="sourceLineNo">231</span><a id="line.231"> @Override</a> +<span class="sourceLineNo">232</span><a id="line.232"> public int getNumberOfObjects()</a> +<span class="sourceLineNo">233</span><a id="line.233"> {</a> +<span class="sourceLineNo">234</span><a id="line.234"> return getKeys().size();</a> +<span class="sourceLineNo">235</span><a id="line.235"> }</a> +<span class="sourceLineNo">236</span><a id="line.236"></a> +<span class="sourceLineNo">237</span><a id="line.237"> /**</a> +<span class="sourceLineNo">238</span><a id="line.238"> * @see org.apache.fulcrum.cache.GlobalCacheService#getObject(java.lang.String)</a> +<span class="sourceLineNo">239</span><a id="line.239"> */</a> +<span class="sourceLineNo">240</span><a id="line.240"> @Override</a> +<span class="sourceLineNo">241</span><a id="line.241"> public <T> CachedObject<T> getObject(String objectId) throws ObjectExpiredException</a> +<span class="sourceLineNo">242</span><a id="line.242"> {</a> +<span class="sourceLineNo">243</span><a id="line.243"> Element cachedElement = this.cache.get(objectId);</a> +<span class="sourceLineNo">244</span><a id="line.244"></a> +<span class="sourceLineNo">245</span><a id="line.245"> if (cachedElement == null)</a> +<span class="sourceLineNo">246</span><a id="line.246"> {</a> +<span class="sourceLineNo">247</span><a id="line.247"> // Not in the cache.</a> +<span class="sourceLineNo">248</span><a id="line.248"> throw new ObjectExpiredException();</a> +<span class="sourceLineNo">249</span><a id="line.249"> }</a> +<span class="sourceLineNo">250</span><a id="line.250"></a> +<span class="sourceLineNo">251</span><a id="line.251"> @SuppressWarnings("unchecked")</a> +<span class="sourceLineNo">252</span><a id="line.252"> CachedObject<T> cachedObject = (CachedObject<T>)cachedElement.getObjectValue();</a> +<span class="sourceLineNo">253</span><a id="line.253"></a> +<span class="sourceLineNo">254</span><a id="line.254"> if (cachedObject.isStale())</a> +<span class="sourceLineNo">255</span><a id="line.255"> {</a> +<span class="sourceLineNo">256</span><a id="line.256"> if (cachedObject instanceof RefreshableCachedObject)</a> +<span class="sourceLineNo">257</span><a id="line.257"> {</a> +<span class="sourceLineNo">258</span><a id="line.258"> RefreshableCachedObject<?> refreshableCachedObject = (RefreshableCachedObject<?>) cachedObject;</a> +<span class="sourceLineNo">259</span><a id="line.259"> if (refreshableCachedObject.isUntouched())</a> +<span class="sourceLineNo">260</span><a id="line.260"> {</a> +<span class="sourceLineNo">261</span><a id="line.261"> // Do not refresh an object that has exceeded TimeToLive</a> +<span class="sourceLineNo">262</span><a id="line.262"> removeObject(objectId);</a> +<span class="sourceLineNo">263</span><a id="line.263"> throw new ObjectExpiredException();</a> +<span class="sourceLineNo">264</span><a id="line.264"> }</a> +<span class="sourceLineNo">265</span><a id="line.265"></a> +<span class="sourceLineNo">266</span><a id="line.266"> // Refresh Object</a> +<span class="sourceLineNo">267</span><a id="line.267"> refreshableCachedObject.refresh();</a> +<span class="sourceLineNo">268</span><a id="line.268"> if (refreshableCachedObject.isStale())</a> +<span class="sourceLineNo">269</span><a id="line.269"> {</a> +<span class="sourceLineNo">270</span><a id="line.270"> // Object is Expired, remove it from cache.</a> +<span class="sourceLineNo">271</span><a id="line.271"> removeObject(objectId);</a> +<span class="sourceLineNo">272</span><a id="line.272"> throw new ObjectExpiredException();</a> +<span class="sourceLineNo">273</span><a id="line.273"> }</a> +<span class="sourceLineNo">274</span><a id="line.274"> }</a> +<span class="sourceLineNo">275</span><a id="line.275"> else</a> +<span class="sourceLineNo">276</span><a id="line.276"> {</a> +<span class="sourceLineNo">277</span><a id="line.277"> // Expired.</a> +<span class="sourceLineNo">278</span><a id="line.278"> removeObject(objectId);</a> +<span class="sourceLineNo">279</span><a id="line.279"> throw new ObjectExpiredException();</a> +<span class="sourceLineNo">280</span><a id="line.280"> }</a> +<span class="sourceLineNo">281</span><a id="line.281"> }</a> +<span class="sourceLineNo">282</span><a id="line.282"></a> +<span class="sourceLineNo">283</span><a id="line.283"> if (cachedObject instanceof RefreshableCachedObject)</a> +<span class="sourceLineNo">284</span><a id="line.284"> {</a> +<span class="sourceLineNo">285</span><a id="line.285"> // notify it that it's being accessed.</a> +<span class="sourceLineNo">286</span><a id="line.286"> RefreshableCachedObject<?> refreshableCachedObject = (RefreshableCachedObject<?>) cachedObject;</a> +<span class="sourceLineNo">287</span><a id="line.287"> refreshableCachedObject.touch();</a> +<span class="sourceLineNo">288</span><a id="line.288"> }</a> +<span class="sourceLineNo">289</span><a id="line.289"></a> +<span class="sourceLineNo">290</span><a id="line.290"> return cachedObject;</a> +<span class="sourceLineNo">291</span><a id="line.291"> }</a> +<span class="sourceLineNo">292</span><a id="line.292"></a> +<span class="sourceLineNo">293</span><a id="line.293"> /**</a> +<span class="sourceLineNo">294</span><a id="line.294"> * @see org.apache.fulcrum.cache.GlobalCacheService#removeObject(java.lang.String)</a> +<span class="sourceLineNo">295</span><a id="line.295"> */</a> +<span class="sourceLineNo">296</span><a id="line.296"> @Override</a> +<span class="sourceLineNo">297</span><a id="line.297"> public void removeObject(String objectId)</a> +<span class="sourceLineNo">298</span><a id="line.298"> {</a> +<span class="sourceLineNo">299</span><a id="line.299"> this.cache.remove(objectId);</a> +<span class="sourceLineNo">300</span><a id="line.300"> }</a> +<span class="sourceLineNo">301</span><a id="line.301"></a> +<span class="sourceLineNo">302</span><a id="line.302"> /**</a> +<span class="sourceLineNo">303</span><a id="line.303"> * Circle through the cache and refresh stale objects. Frequency is</a> +<span class="sourceLineNo">304</span><a id="line.304"> * determined by the cacheCheckFrequency property.</a> +<span class="sourceLineNo">305</span><a id="line.305"> */</a> +<span class="sourceLineNo">306</span><a id="line.306"> @Override</a> +<span class="sourceLineNo">307</span><a id="line.307"> public void run()</a> +<span class="sourceLineNo">308</span><a id="line.308"> {</a> +<span class="sourceLineNo">309</span><a id="line.309"> while (this.continueThread)</a> +<span class="sourceLineNo">310</span><a id="line.310"> {</a> +<span class="sourceLineNo">311</span><a id="line.311"> // Sleep for amount of time set in cacheCheckFrequency -</a> +<span class="sourceLineNo">312</span><a id="line.312"> // default = 5 seconds.</a> +<span class="sourceLineNo">313</span><a id="line.313"> try</a> +<span class="sourceLineNo">314</span><a id="line.314"> {</a> +<span class="sourceLineNo">315</span><a id="line.315"> Thread.sleep(this.cacheCheckFrequency);</a> +<span class="sourceLineNo">316</span><a id="line.316"> }</a> +<span class="sourceLineNo">317</span><a id="line.317"> catch (InterruptedException exc)</a> +<span class="sourceLineNo">318</span><a id="line.318"> {</a> +<span class="sourceLineNo">319</span><a id="line.319"> if (!this.continueThread)</a> +<span class="sourceLineNo">320</span><a id="line.320"> {</a> +<span class="sourceLineNo">321</span><a id="line.321"> return;</a> +<span class="sourceLineNo">322</span><a id="line.322"> }</a> +<span class="sourceLineNo">323</span><a id="line.323"> }</a> +<span class="sourceLineNo">324</span><a id="line.324"></a> +<span class="sourceLineNo">325</span><a id="line.325"> for (String key : getKeys())</a> +<span class="sourceLineNo">326</span><a id="line.326"> {</a> +<span class="sourceLineNo">327</span><a id="line.327"> Element cachedElement = this.cache.get(key);</a> +<span class="sourceLineNo">328</span><a id="line.328"></a> +<span class="sourceLineNo">329</span><a id="line.329"> if (cachedElement == null)</a> +<span class="sourceLineNo">330</span><a id="line.330"> {</a> +<span class="sourceLineNo">331</span><a id="line.331"> this.cache.remove(key);</a> +<span class="sourceLineNo">332</span><a id="line.332"> continue;</a> +<span class="sourceLineNo">333</span><a id="line.333"> }</a> +<span class="sourceLineNo">334</span><a id="line.334"></a> +<span class="sourceLineNo">335</span><a id="line.335"> Object object = cachedElement.getObjectValue();</a> +<span class="sourceLineNo">336</span><a id="line.336"></a> +<span class="sourceLineNo">337</span><a id="line.337"> if (object instanceof RefreshableCachedObject)</a> +<span class="sourceLineNo">338</span><a id="line.338"> {</a> +<span class="sourceLineNo">339</span><a id="line.339"> RefreshableCachedObject<?> refreshableObject = (RefreshableCachedObject<?>) object;</a> +<span class="sourceLineNo">340</span><a id="line.340"> if (refreshableObject.isUntouched())</a> +<span class="sourceLineNo">341</span><a id="line.341"> {</a> +<span class="sourceLineNo">342</span><a id="line.342"> this.cache.remove(key);</a> +<span class="sourceLineNo">343</span><a id="line.343"> }</a> +<span class="sourceLineNo">344</span><a id="line.344"> else if (refreshableObject.isStale())</a> +<span class="sourceLineNo">345</span><a id="line.345"> {</a> +<span class="sourceLineNo">346</span><a id="line.346"> refreshableObject.refresh();</a> +<span class="sourceLineNo">347</span><a id="line.347"> }</a> +<span class="sourceLineNo">348</span><a id="line.348"> }</a> +<span class="sourceLineNo">349</span><a id="line.349"> }</a> +<span class="sourceLineNo">350</span><a id="line.350"> }</a> +<span class="sourceLineNo">351</span><a id="line.351"> }</a> +<span class="sourceLineNo">352</span><a id="line.352">}</a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</main> +</body> +</html> \ No newline at end of file
