| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> *<a name="line.18"></a> |
| <span class="sourceLineNo">019</span> */<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.mina.util;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Map;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Set;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.concurrent.CopyOnWriteArrayList;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.concurrent.locks.ReadWriteLock;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.concurrent.locks.ReentrantReadWriteLock;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * A map with expiration. This class contains a worker thread that will <a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * periodically check this class in order to determine if any objects <a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * should be removed based on the provided time-to-live value.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>public class ExpiringMap<K, V> implements Map<K, V> {<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * The default value, 60<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> public static final int DEFAULT_TIME_TO_LIVE = 60;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> /**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * The default value, 1<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> public static final int DEFAULT_EXPIRATION_INTERVAL = 1;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private static volatile int expirerCount = 1;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private final ConcurrentHashMap<K, ExpiringObject> delegate;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private final CopyOnWriteArrayList<ExpirationListener<V>> expirationListeners;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private final Expirer expirer;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Creates a new instance of ExpiringMap using the default values <a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * DEFAULT_TIME_TO_LIVE and DEFAULT_EXPIRATION_INTERVAL<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> *<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> public ExpiringMap() {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> this(DEFAULT_TIME_TO_LIVE, DEFAULT_EXPIRATION_INTERVAL);<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> }<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Creates a new instance of ExpiringMap using the supplied <a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * time-to-live value and the default value for DEFAULT_EXPIRATION_INTERVAL<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> *<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param timeToLive<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * The time-to-live value (seconds)<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> public ExpiringMap(int timeToLive) {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> this(timeToLive, DEFAULT_EXPIRATION_INTERVAL);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> }<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * Creates a new instance of ExpiringMap using the supplied values and <a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * a {@link ConcurrentHashMap} for the internal data structure.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> *<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @param timeToLive<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * The time-to-live value (seconds)<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @param expirationInterval<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * The time between checks to see if a value should be removed (seconds)<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> public ExpiringMap(int timeToLive, int expirationInterval) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> this(new ConcurrentHashMap<K, ExpiringObject>(), new CopyOnWriteArrayList<ExpirationListener<V>>(), timeToLive,<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> expirationInterval);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> }<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> private ExpiringMap(ConcurrentHashMap<K, ExpiringObject> delegate,<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> CopyOnWriteArrayList<ExpirationListener<V>> expirationListeners, int timeToLive, int expirationInterval) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> this.delegate = delegate;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> this.expirationListeners = expirationListeners;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> this.expirer = new Expirer();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> expirer.setTimeToLive(timeToLive);<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> expirer.setExpirationInterval(expirationInterval);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> public V put(K key, V value) {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> ExpiringObject answer = delegate.put(key, new ExpiringObject(key, value, System.currentTimeMillis()));<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> if (answer == null) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> return null;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> }<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return answer.getValue();<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> public V get(Object key) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> ExpiringObject object = delegate.get(key);<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> if (object != null) {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> object.setLastAccessTime(System.currentTimeMillis());<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return object.getValue();<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> return null;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> public V remove(Object key) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> ExpiringObject answer = delegate.remove(key);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> if (answer == null) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> return null;<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> return answer.getValue();<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> }<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public boolean containsKey(Object key) {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> return delegate.containsKey(key);<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> public boolean containsValue(Object value) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> return delegate.containsValue(value);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> public int size() {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> return delegate.size();<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> public boolean isEmpty() {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> return delegate.isEmpty();<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> public void clear() {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> delegate.clear();<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> @Override<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> public int hashCode() {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> return delegate.hashCode();<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> public Set<K> keySet() {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> return delegate.keySet();<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> }<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> @Override<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> public boolean equals(Object obj) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> return delegate.equals(obj);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> public void putAll(Map<? extends K, ? extends V> inMap) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> for (Entry<? extends K, ? extends V> e : inMap.entrySet()) {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> this.put(e.getKey(), e.getValue());<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> }<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> }<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> public Collection<V> values() {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> throw new UnsupportedOperationException();<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> public Set<Map.Entry<K, V>> entrySet() {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> throw new UnsupportedOperationException();<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> public void addExpirationListener(ExpirationListener<V> listener) {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> expirationListeners.add(listener);<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> }<a name="line.181"></a> |
| <span class="sourceLineNo">182</span><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> public void removeExpirationListener(ExpirationListener<V> listener) {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> expirationListeners.remove(listener);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> }<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> public Expirer getExpirer() {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> return expirer;<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> }<a name="line.189"></a> |
| <span class="sourceLineNo">190</span><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> public int getExpirationInterval() {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> return expirer.getExpirationInterval();<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> }<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> public int getTimeToLive() {<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> return expirer.getTimeToLive();<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<a name="line.197"></a> |
| <span class="sourceLineNo">198</span><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> public void setExpirationInterval(int expirationInterval) {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> expirer.setExpirationInterval(expirationInterval);<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> }<a name="line.201"></a> |
| <span class="sourceLineNo">202</span><a name="line.202"></a> |
| <span class="sourceLineNo">203</span> public void setTimeToLive(int timeToLive) {<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> expirer.setTimeToLive(timeToLive);<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> }<a name="line.205"></a> |
| <span class="sourceLineNo">206</span><a name="line.206"></a> |
| <span class="sourceLineNo">207</span> private class ExpiringObject {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> private K key;<a name="line.208"></a> |
| <span class="sourceLineNo">209</span><a name="line.209"></a> |
| <span class="sourceLineNo">210</span> private V value;<a name="line.210"></a> |
| <span class="sourceLineNo">211</span><a name="line.211"></a> |
| <span class="sourceLineNo">212</span> private long lastAccessTime;<a name="line.212"></a> |
| <span class="sourceLineNo">213</span><a name="line.213"></a> |
| <span class="sourceLineNo">214</span> private final ReadWriteLock lastAccessTimeLock = new ReentrantReadWriteLock();<a name="line.214"></a> |
| <span class="sourceLineNo">215</span><a name="line.215"></a> |
| <span class="sourceLineNo">216</span> ExpiringObject(K key, V value, long lastAccessTime) {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> if (value == null) {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> throw new IllegalArgumentException("An expiring object cannot be null.");<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> this.key = key;<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> this.value = value;<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> this.lastAccessTime = lastAccessTime;<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<a name="line.224"></a> |
| <span class="sourceLineNo">225</span><a name="line.225"></a> |
| <span class="sourceLineNo">226</span> public long getLastAccessTime() {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> lastAccessTimeLock.readLock().lock();<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> try {<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> return lastAccessTime;<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> } finally {<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> lastAccessTimeLock.readLock().unlock();<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> }<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> }<a name="line.234"></a> |
| <span class="sourceLineNo">235</span><a name="line.235"></a> |
| <span class="sourceLineNo">236</span> public void setLastAccessTime(long lastAccessTime) {<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> lastAccessTimeLock.writeLock().lock();<a name="line.237"></a> |
| <span class="sourceLineNo">238</span><a name="line.238"></a> |
| <span class="sourceLineNo">239</span> try {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> this.lastAccessTime = lastAccessTime;<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> } finally {<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> lastAccessTimeLock.writeLock().unlock();<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> }<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> }<a name="line.244"></a> |
| <span class="sourceLineNo">245</span><a name="line.245"></a> |
| <span class="sourceLineNo">246</span> public K getKey() {<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> return key;<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> }<a name="line.248"></a> |
| <span class="sourceLineNo">249</span><a name="line.249"></a> |
| <span class="sourceLineNo">250</span> public V getValue() {<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> return value;<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> }<a name="line.252"></a> |
| <span class="sourceLineNo">253</span><a name="line.253"></a> |
| <span class="sourceLineNo">254</span> @Override<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> public boolean equals(Object obj) {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> return value.equals(obj);<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> }<a name="line.257"></a> |
| <span class="sourceLineNo">258</span><a name="line.258"></a> |
| <span class="sourceLineNo">259</span> @Override<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> public int hashCode() {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> return value.hashCode();<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> }<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> }<a name="line.263"></a> |
| <span class="sourceLineNo">264</span><a name="line.264"></a> |
| <span class="sourceLineNo">265</span> /**<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * A Thread that monitors an {@link ExpiringMap} and will remove<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * elements that have passed the threshold.<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> *<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> */<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> public class Expirer implements Runnable {<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> private final ReadWriteLock stateLock = new ReentrantReadWriteLock();<a name="line.271"></a> |
| <span class="sourceLineNo">272</span><a name="line.272"></a> |
| <span class="sourceLineNo">273</span> private long timeToLiveMillis;<a name="line.273"></a> |
| <span class="sourceLineNo">274</span><a name="line.274"></a> |
| <span class="sourceLineNo">275</span> private long expirationIntervalMillis;<a name="line.275"></a> |
| <span class="sourceLineNo">276</span><a name="line.276"></a> |
| <span class="sourceLineNo">277</span> private boolean running = false;<a name="line.277"></a> |
| <span class="sourceLineNo">278</span><a name="line.278"></a> |
| <span class="sourceLineNo">279</span> private final Thread expirerThread;<a name="line.279"></a> |
| <span class="sourceLineNo">280</span><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> /**<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * Creates a new instance of Expirer. <a name="line.282"></a> |
| <span class="sourceLineNo">283</span> *<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> */<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> public Expirer() {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> expirerThread = new Thread(this, "ExpiringMapExpirer-" + expirerCount++);<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> expirerThread.setDaemon(true);<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> }<a name="line.288"></a> |
| <span class="sourceLineNo">289</span><a name="line.289"></a> |
| <span class="sourceLineNo">290</span> public void run() {<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> while (running) {<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> processExpires();<a name="line.292"></a> |
| <span class="sourceLineNo">293</span><a name="line.293"></a> |
| <span class="sourceLineNo">294</span> try {<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> Thread.sleep(expirationIntervalMillis);<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> } catch (InterruptedException e) {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> // Do nothing<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> }<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> }<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> }<a name="line.300"></a> |
| <span class="sourceLineNo">301</span><a name="line.301"></a> |
| <span class="sourceLineNo">302</span> private void processExpires() {<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> long timeNow = System.currentTimeMillis();<a name="line.303"></a> |
| <span class="sourceLineNo">304</span><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> for (ExpiringObject o : delegate.values()) {<a name="line.305"></a> |
| <span class="sourceLineNo">306</span><a name="line.306"></a> |
| <span class="sourceLineNo">307</span> if (timeToLiveMillis <= 0) {<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> continue;<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> long timeIdle = timeNow - o.getLastAccessTime();<a name="line.311"></a> |
| <span class="sourceLineNo">312</span><a name="line.312"></a> |
| <span class="sourceLineNo">313</span> if (timeIdle >= timeToLiveMillis) {<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> delegate.remove(o.getKey());<a name="line.314"></a> |
| <span class="sourceLineNo">315</span><a name="line.315"></a> |
| <span class="sourceLineNo">316</span> for (ExpirationListener<V> listener : expirationListeners) {<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> listener.expired(o.getValue());<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> }<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> }<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> }<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> }<a name="line.321"></a> |
| <span class="sourceLineNo">322</span><a name="line.322"></a> |
| <span class="sourceLineNo">323</span> /**<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * Kick off this thread which will look for old objects and remove them.<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> *<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> */<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> public void startExpiring() {<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> stateLock.writeLock().lock();<a name="line.328"></a> |
| <span class="sourceLineNo">329</span><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> try {<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> if (!running) {<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> running = true;<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> expirerThread.start();<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> }<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> } finally {<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> stateLock.writeLock().unlock();<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> }<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> }<a name="line.338"></a> |
| <span class="sourceLineNo">339</span><a name="line.339"></a> |
| <span class="sourceLineNo">340</span> /**<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * If this thread has not started, then start it. <a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * Otherwise just return;<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> */<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> public void startExpiringIfNotStarted() {<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> stateLock.readLock().lock();<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> try {<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> if (running) {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> return;<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> }<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> } finally {<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> stateLock.readLock().unlock();<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> }<a name="line.352"></a> |
| <span class="sourceLineNo">353</span><a name="line.353"></a> |
| <span class="sourceLineNo">354</span> stateLock.writeLock().lock();<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> try {<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> if (!running) {<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> running = true;<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> expirerThread.start();<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> }<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> } finally {<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> stateLock.writeLock().unlock();<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> }<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> }<a name="line.363"></a> |
| <span class="sourceLineNo">364</span><a name="line.364"></a> |
| <span class="sourceLineNo">365</span> /**<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * Stop the thread from monitoring the map.<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> */<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> public void stopExpiring() {<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> stateLock.writeLock().lock();<a name="line.369"></a> |
| <span class="sourceLineNo">370</span><a name="line.370"></a> |
| <span class="sourceLineNo">371</span> try {<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> if (running) {<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> running = false;<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> expirerThread.interrupt();<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> }<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> } finally {<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> stateLock.writeLock().unlock();<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> }<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> }<a name="line.379"></a> |
| <span class="sourceLineNo">380</span><a name="line.380"></a> |
| <span class="sourceLineNo">381</span> /**<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * Checks to see if the thread is running<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> *<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * @return<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * If the thread is running, true. Otherwise false.<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> */<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> public boolean isRunning() {<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> stateLock.readLock().lock();<a name="line.388"></a> |
| <span class="sourceLineNo">389</span><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> try {<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> return running;<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> } finally {<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> stateLock.readLock().unlock();<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> }<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> }<a name="line.395"></a> |
| <span class="sourceLineNo">396</span><a name="line.396"></a> |
| <span class="sourceLineNo">397</span> /**<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> * Returns the Time-to-live value.<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> *<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> * @return<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> * The time-to-live (seconds)<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> */<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> public int getTimeToLive() {<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> stateLock.readLock().lock();<a name="line.404"></a> |
| <span class="sourceLineNo">405</span><a name="line.405"></a> |
| <span class="sourceLineNo">406</span> try {<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> return (int) timeToLiveMillis / 1000;<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> } finally {<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> stateLock.readLock().unlock();<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> }<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> }<a name="line.411"></a> |
| <span class="sourceLineNo">412</span><a name="line.412"></a> |
| <span class="sourceLineNo">413</span> /**<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> * Update the value for the time-to-live<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> *<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * @param timeToLive<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> * The time-to-live (seconds)<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> */<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> public void setTimeToLive(long timeToLive) {<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> stateLock.writeLock().lock();<a name="line.420"></a> |
| <span class="sourceLineNo">421</span><a name="line.421"></a> |
| <span class="sourceLineNo">422</span> try {<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> this.timeToLiveMillis = timeToLive * 1000;<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> } finally {<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> stateLock.writeLock().unlock();<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> }<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> }<a name="line.427"></a> |
| <span class="sourceLineNo">428</span><a name="line.428"></a> |
| <span class="sourceLineNo">429</span> /**<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> * Get the interval in which an object will live in the map before<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> * it is removed.<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> *<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> * @return<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> * The time in seconds.<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> */<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> public int getExpirationInterval() {<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> stateLock.readLock().lock();<a name="line.437"></a> |
| <span class="sourceLineNo">438</span><a name="line.438"></a> |
| <span class="sourceLineNo">439</span> try {<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> return (int) expirationIntervalMillis / 1000;<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> } finally {<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> stateLock.readLock().unlock();<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> }<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> }<a name="line.444"></a> |
| <span class="sourceLineNo">445</span><a name="line.445"></a> |
| <span class="sourceLineNo">446</span> /**<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> * Set the interval in which an object will live in the map before<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * it is removed.<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> *<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> * @param expirationInterval<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> * The time in seconds<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> */<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> public void setExpirationInterval(long expirationInterval) {<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> stateLock.writeLock().lock();<a name="line.454"></a> |
| <span class="sourceLineNo">455</span><a name="line.455"></a> |
| <span class="sourceLineNo">456</span> try {<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> this.expirationIntervalMillis = expirationInterval * 1000;<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> } finally {<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> stateLock.writeLock().unlock();<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> }<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> }<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> }<a name="line.462"></a> |
| <span class="sourceLineNo">463</span>}<a name="line.463"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
