Added: websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PoolUtils.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PoolUtils.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PoolUtils.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,1875 @@ +<!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 or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.commons.pool2;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.util.Collection;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.util.HashMap;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.Iterator;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.util.NoSuchElementException;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.util.Timer;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import java.util.TimerTask;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import java.util.Collections;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import java.util.concurrent.locks.ReentrantReadWriteLock;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock;<a name="line.29"></a> +<span class="sourceLineNo">030</span><a name="line.30"></a> +<span class="sourceLineNo">031</span>/**<a name="line.31"></a> +<span class="sourceLineNo">032</span> * This class consists exclusively of static methods that operate on or return<a name="line.32"></a> +<span class="sourceLineNo">033</span> * ObjectPool or KeyedObjectPool related interfaces.<a name="line.33"></a> +<span class="sourceLineNo">034</span> *<a name="line.34"></a> +<span class="sourceLineNo">035</span> * @version $Revision: 1566584 $<a name="line.35"></a> +<span class="sourceLineNo">036</span> *<a name="line.36"></a> +<span class="sourceLineNo">037</span> * @since 2.0<a name="line.37"></a> +<span class="sourceLineNo">038</span> */<a name="line.38"></a> +<span class="sourceLineNo">039</span>public final class PoolUtils {<a name="line.39"></a> +<span class="sourceLineNo">040</span><a name="line.40"></a> +<span class="sourceLineNo">041</span> /**<a name="line.41"></a> +<span class="sourceLineNo">042</span> * Timer used to periodically check pools idle object count. Because a<a name="line.42"></a> +<span class="sourceLineNo">043</span> * {@link Timer} creates a {@link Thread}, an IODH is used.<a name="line.43"></a> +<span class="sourceLineNo">044</span> */<a name="line.44"></a> +<span class="sourceLineNo">045</span> static class TimerHolder {<a name="line.45"></a> +<span class="sourceLineNo">046</span> static final Timer MIN_IDLE_TIMER = new Timer(true);<a name="line.46"></a> +<span class="sourceLineNo">047</span> }<a name="line.47"></a> +<span class="sourceLineNo">048</span><a name="line.48"></a> +<span class="sourceLineNo">049</span> /**<a name="line.49"></a> +<span class="sourceLineNo">050</span> * PoolUtils instances should NOT be constructed in standard programming.<a name="line.50"></a> +<span class="sourceLineNo">051</span> * Instead, the class should be used procedurally: PoolUtils.adapt(aPool);.<a name="line.51"></a> +<span class="sourceLineNo">052</span> * This constructor is public to permit tools that require a JavaBean<a name="line.52"></a> +<span class="sourceLineNo">053</span> * instance to operate.<a name="line.53"></a> +<span class="sourceLineNo">054</span> */<a name="line.54"></a> +<span class="sourceLineNo">055</span> public PoolUtils() {<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> /**<a name="line.58"></a> +<span class="sourceLineNo">059</span> * Should the supplied Throwable be re-thrown (eg if it is an instance of<a name="line.59"></a> +<span class="sourceLineNo">060</span> * one of the Throwables that should never be swallowed). Used by the pool<a name="line.60"></a> +<span class="sourceLineNo">061</span> * error handling for operations that throw exceptions that normally need to<a name="line.61"></a> +<span class="sourceLineNo">062</span> * be ignored.<a name="line.62"></a> +<span class="sourceLineNo">063</span> *<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @param t<a name="line.64"></a> +<span class="sourceLineNo">065</span> * The Throwable to check<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @throws ThreadDeath<a name="line.66"></a> +<span class="sourceLineNo">067</span> * if that is passed in<a name="line.67"></a> +<span class="sourceLineNo">068</span> * @throws VirtualMachineError<a name="line.68"></a> +<span class="sourceLineNo">069</span> * if that is passed in<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> public static void checkRethrow(Throwable t) {<a name="line.71"></a> +<span class="sourceLineNo">072</span> if (t instanceof ThreadDeath) {<a name="line.72"></a> +<span class="sourceLineNo">073</span> throw (ThreadDeath) t;<a name="line.73"></a> +<span class="sourceLineNo">074</span> }<a name="line.74"></a> +<span class="sourceLineNo">075</span> if (t instanceof VirtualMachineError) {<a name="line.75"></a> +<span class="sourceLineNo">076</span> throw (VirtualMachineError) t;<a name="line.76"></a> +<span class="sourceLineNo">077</span> }<a name="line.77"></a> +<span class="sourceLineNo">078</span> // All other instances of Throwable will be silently swallowed<a name="line.78"></a> +<span class="sourceLineNo">079</span> }<a name="line.79"></a> +<span class="sourceLineNo">080</span><a name="line.80"></a> +<span class="sourceLineNo">081</span> /**<a name="line.81"></a> +<span class="sourceLineNo">082</span> * Periodically check the idle object count for the pool. At most one idle<a name="line.82"></a> +<span class="sourceLineNo">083</span> * object will be added per period. If there is an exception when calling<a name="line.83"></a> +<span class="sourceLineNo">084</span> * {@link ObjectPool#addObject()} then no more checks will be performed.<a name="line.84"></a> +<span class="sourceLineNo">085</span> *<a name="line.85"></a> +<span class="sourceLineNo">086</span> * @param pool<a name="line.86"></a> +<span class="sourceLineNo">087</span> * the pool to check periodically.<a name="line.87"></a> +<span class="sourceLineNo">088</span> * @param minIdle<a name="line.88"></a> +<span class="sourceLineNo">089</span> * if the {@link ObjectPool#getNumIdle()} is less than this then<a name="line.89"></a> +<span class="sourceLineNo">090</span> * add an idle object.<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @param period<a name="line.91"></a> +<span class="sourceLineNo">092</span> * the frequency to check the number of idle objects in a pool,<a name="line.92"></a> +<span class="sourceLineNo">093</span> * see {@link Timer#schedule(TimerTask, long, long)}.<a name="line.93"></a> +<span class="sourceLineNo">094</span> * @param <T> the type of objects in the pool<a name="line.94"></a> +<span class="sourceLineNo">095</span> * @return the {@link TimerTask} that will periodically check the pools idle<a name="line.95"></a> +<span class="sourceLineNo">096</span> * object count.<a name="line.96"></a> +<span class="sourceLineNo">097</span> * @throws IllegalArgumentException<a name="line.97"></a> +<span class="sourceLineNo">098</span> * when <code>pool</code> is <code>null</code> or when<a name="line.98"></a> +<span class="sourceLineNo">099</span> * <code>minIdle</code> is negative or when <code>period</code><a name="line.99"></a> +<span class="sourceLineNo">100</span> * isn't valid for {@link Timer#schedule(TimerTask, long, long)}<a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> public static <T> TimerTask checkMinIdle(final ObjectPool<T> pool,<a name="line.102"></a> +<span class="sourceLineNo">103</span> final int minIdle, final long period)<a name="line.103"></a> +<span class="sourceLineNo">104</span> throws IllegalArgumentException {<a name="line.104"></a> +<span class="sourceLineNo">105</span> if (pool == null) {<a name="line.105"></a> +<span class="sourceLineNo">106</span> throw new IllegalArgumentException("keyedPool must not be null.");<a name="line.106"></a> +<span class="sourceLineNo">107</span> }<a name="line.107"></a> +<span class="sourceLineNo">108</span> if (minIdle < 0) {<a name="line.108"></a> +<span class="sourceLineNo">109</span> throw new IllegalArgumentException("minIdle must be non-negative.");<a name="line.109"></a> +<span class="sourceLineNo">110</span> }<a name="line.110"></a> +<span class="sourceLineNo">111</span> final TimerTask task = new ObjectPoolMinIdleTimerTask<T>(pool, minIdle);<a name="line.111"></a> +<span class="sourceLineNo">112</span> getMinIdleTimer().schedule(task, 0L, period);<a name="line.112"></a> +<span class="sourceLineNo">113</span> return task;<a name="line.113"></a> +<span class="sourceLineNo">114</span> }<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> /**<a name="line.116"></a> +<span class="sourceLineNo">117</span> * Periodically check the idle object count for the key in the keyedPool. At<a name="line.117"></a> +<span class="sourceLineNo">118</span> * most one idle object will be added per period. If there is an exception<a name="line.118"></a> +<span class="sourceLineNo">119</span> * when calling {@link KeyedObjectPool#addObject(Object)} then no more<a name="line.119"></a> +<span class="sourceLineNo">120</span> * checks for that key will be performed.<a name="line.120"></a> +<span class="sourceLineNo">121</span> *<a name="line.121"></a> +<span class="sourceLineNo">122</span> * @param keyedPool<a name="line.122"></a> +<span class="sourceLineNo">123</span> * the keyedPool to check periodically.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @param key<a name="line.124"></a> +<span class="sourceLineNo">125</span> * the key to check the idle count of.<a name="line.125"></a> +<span class="sourceLineNo">126</span> * @param minIdle<a name="line.126"></a> +<span class="sourceLineNo">127</span> * if the {@link KeyedObjectPool#getNumIdle(Object)} is less than<a name="line.127"></a> +<span class="sourceLineNo">128</span> * this then add an idle object.<a name="line.128"></a> +<span class="sourceLineNo">129</span> * @param period<a name="line.129"></a> +<span class="sourceLineNo">130</span> * the frequency to check the number of idle objects in a<a name="line.130"></a> +<span class="sourceLineNo">131</span> * keyedPool, see {@link Timer#schedule(TimerTask, long, long)}.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @param <K> the type of the pool key<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @param <V> the type of pool entries<a name="line.133"></a> +<span class="sourceLineNo">134</span> * @return the {@link TimerTask} that will periodically check the pools idle<a name="line.134"></a> +<span class="sourceLineNo">135</span> * object count.<a name="line.135"></a> +<span class="sourceLineNo">136</span> * @throws IllegalArgumentException<a name="line.136"></a> +<span class="sourceLineNo">137</span> * when <code>keyedPool</code>, <code>key</code> is<a name="line.137"></a> +<span class="sourceLineNo">138</span> * <code>null</code> or when <code>minIdle</code> is negative or<a name="line.138"></a> +<span class="sourceLineNo">139</span> * when <code>period</code> isn't valid for<a name="line.139"></a> +<span class="sourceLineNo">140</span> * {@link Timer#schedule(TimerTask, long, long)}.<a name="line.140"></a> +<span class="sourceLineNo">141</span> */<a name="line.141"></a> +<span class="sourceLineNo">142</span> public static <K, V> TimerTask checkMinIdle(<a name="line.142"></a> +<span class="sourceLineNo">143</span> final KeyedObjectPool<K, V> keyedPool, final K key,<a name="line.143"></a> +<span class="sourceLineNo">144</span> final int minIdle, final long period)<a name="line.144"></a> +<span class="sourceLineNo">145</span> throws IllegalArgumentException {<a name="line.145"></a> +<span class="sourceLineNo">146</span> if (keyedPool == null) {<a name="line.146"></a> +<span class="sourceLineNo">147</span> throw new IllegalArgumentException("keyedPool must not be null.");<a name="line.147"></a> +<span class="sourceLineNo">148</span> }<a name="line.148"></a> +<span class="sourceLineNo">149</span> if (key == null) {<a name="line.149"></a> +<span class="sourceLineNo">150</span> throw new IllegalArgumentException("key must not be null.");<a name="line.150"></a> +<span class="sourceLineNo">151</span> }<a name="line.151"></a> +<span class="sourceLineNo">152</span> if (minIdle < 0) {<a name="line.152"></a> +<span class="sourceLineNo">153</span> throw new IllegalArgumentException("minIdle must be non-negative.");<a name="line.153"></a> +<span class="sourceLineNo">154</span> }<a name="line.154"></a> +<span class="sourceLineNo">155</span> final TimerTask task = new KeyedObjectPoolMinIdleTimerTask<K, V>(<a name="line.155"></a> +<span class="sourceLineNo">156</span> keyedPool, key, minIdle);<a name="line.156"></a> +<span class="sourceLineNo">157</span> getMinIdleTimer().schedule(task, 0L, period);<a name="line.157"></a> +<span class="sourceLineNo">158</span> return task;<a name="line.158"></a> +<span class="sourceLineNo">159</span> }<a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> /**<a name="line.161"></a> +<span class="sourceLineNo">162</span> * Periodically check the idle object count for each key in the<a name="line.162"></a> +<span class="sourceLineNo">163</span> * <code>Collection</code> <code>keys</code> in the keyedPool. At most one<a name="line.163"></a> +<span class="sourceLineNo">164</span> * idle object will be added per period.<a name="line.164"></a> +<span class="sourceLineNo">165</span> *<a name="line.165"></a> +<span class="sourceLineNo">166</span> * @param keyedPool<a name="line.166"></a> +<span class="sourceLineNo">167</span> * the keyedPool to check periodically.<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @param keys<a name="line.168"></a> +<span class="sourceLineNo">169</span> * a collection of keys to check the idle object count.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * @param minIdle<a name="line.170"></a> +<span class="sourceLineNo">171</span> * if the {@link KeyedObjectPool#getNumIdle(Object)} is less than<a name="line.171"></a> +<span class="sourceLineNo">172</span> * this then add an idle object.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param period<a name="line.173"></a> +<span class="sourceLineNo">174</span> * the frequency to check the number of idle objects in a<a name="line.174"></a> +<span class="sourceLineNo">175</span> * keyedPool, see {@link Timer#schedule(TimerTask, long, long)}.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @param <K> the type of the pool key<a name="line.176"></a> +<span class="sourceLineNo">177</span> * @param <V> the type of pool entries<a name="line.177"></a> +<span class="sourceLineNo">178</span> * @return a {@link Map} of key and {@link TimerTask} pairs that will<a name="line.178"></a> +<span class="sourceLineNo">179</span> * periodically check the pools idle object count.<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @throws IllegalArgumentException<a name="line.180"></a> +<span class="sourceLineNo">181</span> * when <code>keyedPool</code>, <code>keys</code>, or any of the<a name="line.181"></a> +<span class="sourceLineNo">182</span> * values in the collection is <code>null</code> or when<a name="line.182"></a> +<span class="sourceLineNo">183</span> * <code>minIdle</code> is negative or when <code>period</code><a name="line.183"></a> +<span class="sourceLineNo">184</span> * isn't valid for {@link Timer#schedule(TimerTask, long, long)}<a name="line.184"></a> +<span class="sourceLineNo">185</span> * .<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @see #checkMinIdle(KeyedObjectPool, Object, int, long)<a name="line.186"></a> +<span class="sourceLineNo">187</span> */<a name="line.187"></a> +<span class="sourceLineNo">188</span> public static <K, V> Map<K, TimerTask> checkMinIdle(<a name="line.188"></a> +<span class="sourceLineNo">189</span> final KeyedObjectPool<K, V> keyedPool, final Collection<K> keys,<a name="line.189"></a> +<span class="sourceLineNo">190</span> final int minIdle, final long period)<a name="line.190"></a> +<span class="sourceLineNo">191</span> throws IllegalArgumentException {<a name="line.191"></a> +<span class="sourceLineNo">192</span> if (keys == null) {<a name="line.192"></a> +<span class="sourceLineNo">193</span> throw new IllegalArgumentException("keys must not be null.");<a name="line.193"></a> +<span class="sourceLineNo">194</span> }<a name="line.194"></a> +<span class="sourceLineNo">195</span> final Map<K, TimerTask> tasks = new HashMap<K, TimerTask>(keys.size());<a name="line.195"></a> +<span class="sourceLineNo">196</span> final Iterator<K> iter = keys.iterator();<a name="line.196"></a> +<span class="sourceLineNo">197</span> while (iter.hasNext()) {<a name="line.197"></a> +<span class="sourceLineNo">198</span> final K key = iter.next();<a name="line.198"></a> +<span class="sourceLineNo">199</span> final TimerTask task = checkMinIdle(keyedPool, key, minIdle, period);<a name="line.199"></a> +<span class="sourceLineNo">200</span> tasks.put(key, task);<a name="line.200"></a> +<span class="sourceLineNo">201</span> }<a name="line.201"></a> +<span class="sourceLineNo">202</span> return tasks;<a name="line.202"></a> +<span class="sourceLineNo">203</span> }<a name="line.203"></a> +<span class="sourceLineNo">204</span><a name="line.204"></a> +<span class="sourceLineNo">205</span> /**<a name="line.205"></a> +<span class="sourceLineNo">206</span> * Call <code>addObject()</code> on <code>pool</code> <code>count</code><a name="line.206"></a> +<span class="sourceLineNo">207</span> * number of times.<a name="line.207"></a> +<span class="sourceLineNo">208</span> *<a name="line.208"></a> +<span class="sourceLineNo">209</span> * @param pool<a name="line.209"></a> +<span class="sourceLineNo">210</span> * the pool to prefill.<a name="line.210"></a> +<span class="sourceLineNo">211</span> * @param count<a name="line.211"></a> +<span class="sourceLineNo">212</span> * the number of idle objects to add.<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @param <T> the type of objects in the pool<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @throws Exception<a name="line.214"></a> +<span class="sourceLineNo">215</span> * when {@link ObjectPool#addObject()} fails.<a name="line.215"></a> +<span class="sourceLineNo">216</span> * @throws IllegalArgumentException<a name="line.216"></a> +<span class="sourceLineNo">217</span> * when <code>pool</code> is <code>null</code>.<a name="line.217"></a> +<span class="sourceLineNo">218</span> */<a name="line.218"></a> +<span class="sourceLineNo">219</span> public static <T> void prefill(final ObjectPool<T> pool, final int count)<a name="line.219"></a> +<span class="sourceLineNo">220</span> throws Exception, IllegalArgumentException {<a name="line.220"></a> +<span class="sourceLineNo">221</span> if (pool == null) {<a name="line.221"></a> +<span class="sourceLineNo">222</span> throw new IllegalArgumentException("pool must not be null.");<a name="line.222"></a> +<span class="sourceLineNo">223</span> }<a name="line.223"></a> +<span class="sourceLineNo">224</span> for (int i = 0; i < count; i++) {<a name="line.224"></a> +<span class="sourceLineNo">225</span> pool.addObject();<a name="line.225"></a> +<span class="sourceLineNo">226</span> }<a name="line.226"></a> +<span class="sourceLineNo">227</span> }<a name="line.227"></a> +<span class="sourceLineNo">228</span><a name="line.228"></a> +<span class="sourceLineNo">229</span> /**<a name="line.229"></a> +<span class="sourceLineNo">230</span> * Call <code>addObject(Object)</code> on <code>keyedPool</code> with<a name="line.230"></a> +<span class="sourceLineNo">231</span> * <code>key</code> <code>count</code> number of times.<a name="line.231"></a> +<span class="sourceLineNo">232</span> *<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @param keyedPool<a name="line.233"></a> +<span class="sourceLineNo">234</span> * the keyedPool to prefill.<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @param key<a name="line.235"></a> +<span class="sourceLineNo">236</span> * the key to add objects for.<a name="line.236"></a> +<span class="sourceLineNo">237</span> * @param count<a name="line.237"></a> +<span class="sourceLineNo">238</span> * the number of idle objects to add for <code>key</code>.<a name="line.238"></a> +<span class="sourceLineNo">239</span> * @param <K> the type of the pool key<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @param <V> the type of pool entries<a name="line.240"></a> +<span class="sourceLineNo">241</span> * @throws Exception<a name="line.241"></a> +<span class="sourceLineNo">242</span> * when {@link KeyedObjectPool#addObject(Object)} fails.<a name="line.242"></a> +<span class="sourceLineNo">243</span> * @throws IllegalArgumentException<a name="line.243"></a> +<span class="sourceLineNo">244</span> * when <code>keyedPool</code> or <code>key</code> is<a name="line.244"></a> +<span class="sourceLineNo">245</span> * <code>null</code>.<a name="line.245"></a> +<span class="sourceLineNo">246</span> */<a name="line.246"></a> +<span class="sourceLineNo">247</span> public static <K, V> void prefill(final KeyedObjectPool<K, V> keyedPool,<a name="line.247"></a> +<span class="sourceLineNo">248</span> final K key, final int count) throws Exception,<a name="line.248"></a> +<span class="sourceLineNo">249</span> IllegalArgumentException {<a name="line.249"></a> +<span class="sourceLineNo">250</span> if (keyedPool == null) {<a name="line.250"></a> +<span class="sourceLineNo">251</span> throw new IllegalArgumentException("keyedPool must not be null.");<a name="line.251"></a> +<span class="sourceLineNo">252</span> }<a name="line.252"></a> +<span class="sourceLineNo">253</span> if (key == null) {<a name="line.253"></a> +<span class="sourceLineNo">254</span> throw new IllegalArgumentException("key must not be null.");<a name="line.254"></a> +<span class="sourceLineNo">255</span> }<a name="line.255"></a> +<span class="sourceLineNo">256</span> for (int i = 0; i < count; i++) {<a name="line.256"></a> +<span class="sourceLineNo">257</span> keyedPool.addObject(key);<a name="line.257"></a> +<span class="sourceLineNo">258</span> }<a name="line.258"></a> +<span class="sourceLineNo">259</span> }<a name="line.259"></a> +<span class="sourceLineNo">260</span><a name="line.260"></a> +<span class="sourceLineNo">261</span> /**<a name="line.261"></a> +<span class="sourceLineNo">262</span> * Call <code>addObject(Object)</code> on <code>keyedPool</code> with each<a name="line.262"></a> +<span class="sourceLineNo">263</span> * key in <code>keys</code> for <code>count</code> number of times. This has<a name="line.263"></a> +<span class="sourceLineNo">264</span> * the same effect as calling {@link #prefill(KeyedObjectPool, Object, int)}<a name="line.264"></a> +<span class="sourceLineNo">265</span> * for each key in the <code>keys</code> collection.<a name="line.265"></a> +<span class="sourceLineNo">266</span> *<a name="line.266"></a> +<span class="sourceLineNo">267</span> * @param keyedPool<a name="line.267"></a> +<span class="sourceLineNo">268</span> * the keyedPool to prefill.<a name="line.268"></a> +<span class="sourceLineNo">269</span> * @param keys<a name="line.269"></a> +<span class="sourceLineNo">270</span> * {@link Collection} of keys to add objects for.<a name="line.270"></a> +<span class="sourceLineNo">271</span> * @param count<a name="line.271"></a> +<span class="sourceLineNo">272</span> * the number of idle objects to add for each <code>key</code>.<a name="line.272"></a> +<span class="sourceLineNo">273</span> * @param <K> the type of the pool key<a name="line.273"></a> +<span class="sourceLineNo">274</span> * @param <V> the type of pool entries<a name="line.274"></a> +<span class="sourceLineNo">275</span> * @throws Exception<a name="line.275"></a> +<span class="sourceLineNo">276</span> * when {@link KeyedObjectPool#addObject(Object)} fails.<a name="line.276"></a> +<span class="sourceLineNo">277</span> * @throws IllegalArgumentException<a name="line.277"></a> +<span class="sourceLineNo">278</span> * when <code>keyedPool</code>, <code>keys</code>, or any value<a name="line.278"></a> +<span class="sourceLineNo">279</span> * in <code>keys</code> is <code>null</code>.<a name="line.279"></a> +<span class="sourceLineNo">280</span> * @see #prefill(KeyedObjectPool, Object, int)<a name="line.280"></a> +<span class="sourceLineNo">281</span> */<a name="line.281"></a> +<span class="sourceLineNo">282</span> public static <K, V> void prefill(final KeyedObjectPool<K, V> keyedPool,<a name="line.282"></a> +<span class="sourceLineNo">283</span> final Collection<K> keys, final int count) throws Exception,<a name="line.283"></a> +<span class="sourceLineNo">284</span> IllegalArgumentException {<a name="line.284"></a> +<span class="sourceLineNo">285</span> if (keys == null) {<a name="line.285"></a> +<span class="sourceLineNo">286</span> throw new IllegalArgumentException("keys must not be null.");<a name="line.286"></a> +<span class="sourceLineNo">287</span> }<a name="line.287"></a> +<span class="sourceLineNo">288</span> final Iterator<K> iter = keys.iterator();<a name="line.288"></a> +<span class="sourceLineNo">289</span> while (iter.hasNext()) {<a name="line.289"></a> +<span class="sourceLineNo">290</span> prefill(keyedPool, iter.next(), count);<a name="line.290"></a> +<span class="sourceLineNo">291</span> }<a name="line.291"></a> +<span class="sourceLineNo">292</span> }<a name="line.292"></a> +<span class="sourceLineNo">293</span><a name="line.293"></a> +<span class="sourceLineNo">294</span> /**<a name="line.294"></a> +<span class="sourceLineNo">295</span> * Returns a synchronized (thread-safe) ObjectPool backed by the specified<a name="line.295"></a> +<span class="sourceLineNo">296</span> * ObjectPool.<a name="line.296"></a> +<span class="sourceLineNo">297</span> * <p><a name="line.297"></a> +<span class="sourceLineNo">298</span> * <b>Note:</b> This should not be used on pool implementations that already<a name="line.298"></a> +<span class="sourceLineNo">299</span> * provide proper synchronization such as the pools provided in the Commons<a name="line.299"></a> +<span class="sourceLineNo">300</span> * Pool library. Wrapping a pool that {@link #wait() waits} for poolable<a name="line.300"></a> +<span class="sourceLineNo">301</span> * objects to be returned before allowing another one to be borrowed with<a name="line.301"></a> +<span class="sourceLineNo">302</span> * another layer of synchronization will cause liveliness issues or a<a name="line.302"></a> +<span class="sourceLineNo">303</span> * deadlock.<a name="line.303"></a> +<span class="sourceLineNo">304</span> * </p><a name="line.304"></a> +<span class="sourceLineNo">305</span> *<a name="line.305"></a> +<span class="sourceLineNo">306</span> * @param pool<a name="line.306"></a> +<span class="sourceLineNo">307</span> * the ObjectPool to be "wrapped" in a synchronized ObjectPool.<a name="line.307"></a> +<span class="sourceLineNo">308</span> * @param <T> the type of objects in the pool<a name="line.308"></a> +<span class="sourceLineNo">309</span> * @return a synchronized view of the specified ObjectPool.<a name="line.309"></a> +<span class="sourceLineNo">310</span> */<a name="line.310"></a> +<span class="sourceLineNo">311</span> public static <T> ObjectPool<T> synchronizedPool(final ObjectPool<T> pool) {<a name="line.311"></a> +<span class="sourceLineNo">312</span> if (pool == null) {<a name="line.312"></a> +<span class="sourceLineNo">313</span> throw new IllegalArgumentException("pool must not be null.");<a name="line.313"></a> +<span class="sourceLineNo">314</span> }<a name="line.314"></a> +<span class="sourceLineNo">315</span> /*<a name="line.315"></a> +<span class="sourceLineNo">316</span> * assert !(pool instanceof GenericObjectPool) :<a name="line.316"></a> +<span class="sourceLineNo">317</span> * "GenericObjectPool is already thread-safe"; assert !(pool instanceof<a name="line.317"></a> +<span class="sourceLineNo">318</span> * SoftReferenceObjectPool) :<a name="line.318"></a> +<span class="sourceLineNo">319</span> * "SoftReferenceObjectPool is already thread-safe"; assert !(pool<a name="line.319"></a> +<span class="sourceLineNo">320</span> * instanceof StackObjectPool) :<a name="line.320"></a> +<span class="sourceLineNo">321</span> * "StackObjectPool is already thread-safe"; assert<a name="line.321"></a> +<span class="sourceLineNo">322</span> * !"org.apache.commons.pool.composite.CompositeObjectPool"<a name="line.322"></a> +<span class="sourceLineNo">323</span> * .equals(pool.getClass().getName()) :<a name="line.323"></a> +<span class="sourceLineNo">324</span> * "CompositeObjectPools are already thread-safe";<a name="line.324"></a> +<span class="sourceLineNo">325</span> */<a name="line.325"></a> +<span class="sourceLineNo">326</span> return new SynchronizedObjectPool<T>(pool);<a name="line.326"></a> +<span class="sourceLineNo">327</span> }<a name="line.327"></a> +<span class="sourceLineNo">328</span><a name="line.328"></a> +<span class="sourceLineNo">329</span> /**<a name="line.329"></a> +<span class="sourceLineNo">330</span> * Returns a synchronized (thread-safe) KeyedObjectPool backed by the<a name="line.330"></a> +<span class="sourceLineNo">331</span> * specified KeyedObjectPool.<a name="line.331"></a> +<span class="sourceLineNo">332</span> * <p><a name="line.332"></a> +<span class="sourceLineNo">333</span> * <b>Note:</b> This should not be used on pool implementations that already<a name="line.333"></a> +<span class="sourceLineNo">334</span> * provide proper synchronization such as the pools provided in the Commons<a name="line.334"></a> +<span class="sourceLineNo">335</span> * Pool library. Wrapping a pool that {@link #wait() waits} for poolable<a name="line.335"></a> +<span class="sourceLineNo">336</span> * objects to be returned before allowing another one to be borrowed with<a name="line.336"></a> +<span class="sourceLineNo">337</span> * another layer of synchronization will cause liveliness issues or a<a name="line.337"></a> +<span class="sourceLineNo">338</span> * deadlock.<a name="line.338"></a> +<span class="sourceLineNo">339</span> * </p><a name="line.339"></a> +<span class="sourceLineNo">340</span> *<a name="line.340"></a> +<span class="sourceLineNo">341</span> * @param keyedPool<a name="line.341"></a> +<span class="sourceLineNo">342</span> * the KeyedObjectPool to be "wrapped" in a synchronized<a name="line.342"></a> +<span class="sourceLineNo">343</span> * KeyedObjectPool.<a name="line.343"></a> +<span class="sourceLineNo">344</span> * @param <K> the type of the pool key<a name="line.344"></a> +<span class="sourceLineNo">345</span> * @param <V> the type of pool entries<a name="line.345"></a> +<span class="sourceLineNo">346</span> * @return a synchronized view of the specified KeyedObjectPool.<a name="line.346"></a> +<span class="sourceLineNo">347</span> */<a name="line.347"></a> +<span class="sourceLineNo">348</span> public static <K, V> KeyedObjectPool<K, V> synchronizedPool(<a name="line.348"></a> +<span class="sourceLineNo">349</span> final KeyedObjectPool<K, V> keyedPool) {<a name="line.349"></a> +<span class="sourceLineNo">350</span> /*<a name="line.350"></a> +<span class="sourceLineNo">351</span> * assert !(keyedPool instanceof GenericKeyedObjectPool) :<a name="line.351"></a> +<span class="sourceLineNo">352</span> * "GenericKeyedObjectPool is already thread-safe"; assert !(keyedPool<a name="line.352"></a> +<span class="sourceLineNo">353</span> * instanceof StackKeyedObjectPool) :<a name="line.353"></a> +<span class="sourceLineNo">354</span> * "StackKeyedObjectPool is already thread-safe"; assert<a name="line.354"></a> +<span class="sourceLineNo">355</span> * !"org.apache.commons.pool.composite.CompositeKeyedObjectPool"<a name="line.355"></a> +<span class="sourceLineNo">356</span> * .equals(keyedPool.getClass().getName()) :<a name="line.356"></a> +<span class="sourceLineNo">357</span> * "CompositeKeyedObjectPools are already thread-safe";<a name="line.357"></a> +<span class="sourceLineNo">358</span> */<a name="line.358"></a> +<span class="sourceLineNo">359</span> return new SynchronizedKeyedObjectPool<K, V>(keyedPool);<a name="line.359"></a> +<span class="sourceLineNo">360</span> }<a name="line.360"></a> +<span class="sourceLineNo">361</span><a name="line.361"></a> +<span class="sourceLineNo">362</span> /**<a name="line.362"></a> +<span class="sourceLineNo">363</span> * Returns a synchronized (thread-safe) PooledObjectFactory backed by the<a name="line.363"></a> +<span class="sourceLineNo">364</span> * specified PooledObjectFactory.<a name="line.364"></a> +<span class="sourceLineNo">365</span> *<a name="line.365"></a> +<span class="sourceLineNo">366</span> * @param factory<a name="line.366"></a> +<span class="sourceLineNo">367</span> * the PooledObjectFactory to be "wrapped" in a synchronized<a name="line.367"></a> +<span class="sourceLineNo">368</span> * PooledObjectFactory.<a name="line.368"></a> +<span class="sourceLineNo">369</span> * @param <T> the type of objects in the pool<a name="line.369"></a> +<span class="sourceLineNo">370</span> * @return a synchronized view of the specified PooledObjectFactory.<a name="line.370"></a> +<span class="sourceLineNo">371</span> */<a name="line.371"></a> +<span class="sourceLineNo">372</span> public static <T> PooledObjectFactory<T> synchronizedPooledFactory(<a name="line.372"></a> +<span class="sourceLineNo">373</span> final PooledObjectFactory<T> factory) {<a name="line.373"></a> +<span class="sourceLineNo">374</span> return new SynchronizedPooledObjectFactory<T>(factory);<a name="line.374"></a> +<span class="sourceLineNo">375</span> }<a name="line.375"></a> +<span class="sourceLineNo">376</span><a name="line.376"></a> +<span class="sourceLineNo">377</span> /**<a name="line.377"></a> +<span class="sourceLineNo">378</span> * Returns a synchronized (thread-safe) KeyedPooledObjectFactory backed by<a name="line.378"></a> +<span class="sourceLineNo">379</span> * the specified KeyedPoolableObjectFactory.<a name="line.379"></a> +<span class="sourceLineNo">380</span> *<a name="line.380"></a> +<span class="sourceLineNo">381</span> * @param keyedFactory<a name="line.381"></a> +<span class="sourceLineNo">382</span> * the KeyedPooledObjectFactory to be "wrapped" in a<a name="line.382"></a> +<span class="sourceLineNo">383</span> * synchronized KeyedPooledObjectFactory.<a name="line.383"></a> +<span class="sourceLineNo">384</span> * @param <K> the type of the pool key<a name="line.384"></a> +<span class="sourceLineNo">385</span> * @param <V> the type of pool entries<a name="line.385"></a> +<span class="sourceLineNo">386</span> * @return a synchronized view of the specified KeyedPooledObjectFactory.<a name="line.386"></a> +<span class="sourceLineNo">387</span> */<a name="line.387"></a> +<span class="sourceLineNo">388</span> public static <K, V> KeyedPooledObjectFactory<K, V> synchronizedKeyedPooledFactory(<a name="line.388"></a> +<span class="sourceLineNo">389</span> final KeyedPooledObjectFactory<K, V> keyedFactory) {<a name="line.389"></a> +<span class="sourceLineNo">390</span> return new SynchronizedKeyedPooledObjectFactory<K, V>(keyedFactory);<a name="line.390"></a> +<span class="sourceLineNo">391</span> }<a name="line.391"></a> +<span class="sourceLineNo">392</span><a name="line.392"></a> +<span class="sourceLineNo">393</span> /**<a name="line.393"></a> +<span class="sourceLineNo">394</span> * Returns a pool that adaptively decreases its size when idle objects are<a name="line.394"></a> +<span class="sourceLineNo">395</span> * no longer needed. This is intended as an always thread-safe alternative<a name="line.395"></a> +<span class="sourceLineNo">396</span> * to using an idle object evictor provided by many pool implementations.<a name="line.396"></a> +<span class="sourceLineNo">397</span> * This is also an effective way to shrink FIFO ordered pools that<a name="line.397"></a> +<span class="sourceLineNo">398</span> * experience load spikes.<a name="line.398"></a> +<span class="sourceLineNo">399</span> *<a name="line.399"></a> +<span class="sourceLineNo">400</span> * @param pool<a name="line.400"></a> +<span class="sourceLineNo">401</span> * the ObjectPool to be decorated so it shrinks its idle count<a name="line.401"></a> +<span class="sourceLineNo">402</span> * when possible.<a name="line.402"></a> +<span class="sourceLineNo">403</span> * @param <T> the type of objects in the pool<a name="line.403"></a> +<span class="sourceLineNo">404</span> * @return a pool that adaptively decreases its size when idle objects are<a name="line.404"></a> +<span class="sourceLineNo">405</span> * no longer needed.<a name="line.405"></a> +<span class="sourceLineNo">406</span> * @see #erodingPool(ObjectPool, float)<a name="line.406"></a> +<span class="sourceLineNo">407</span> */<a name="line.407"></a> +<span class="sourceLineNo">408</span> public static <T> ObjectPool<T> erodingPool(final ObjectPool<T> pool) {<a name="line.408"></a> +<span class="sourceLineNo">409</span> return erodingPool(pool, 1f);<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> * Returns a pool that adaptively decreases its size when idle objects are<a name="line.413"></a> +<span class="sourceLineNo">414</span> * no longer needed. This is intended as an always thread-safe alternative<a name="line.414"></a> +<span class="sourceLineNo">415</span> * to using an idle object evictor provided by many pool implementations.<a name="line.415"></a> +<span class="sourceLineNo">416</span> * This is also an effective way to shrink FIFO ordered pools that<a name="line.416"></a> +<span class="sourceLineNo">417</span> * experience load spikes.<a name="line.417"></a> +<span class="sourceLineNo">418</span> * <p><a name="line.418"></a> +<span class="sourceLineNo">419</span> * The factor parameter provides a mechanism to tweak the rate at which the<a name="line.419"></a> +<span class="sourceLineNo">420</span> * pool tries to shrink its size. Values between 0 and 1 cause the pool to<a name="line.420"></a> +<span class="sourceLineNo">421</span> * try to shrink its size more often. Values greater than 1 cause the pool<a name="line.421"></a> +<span class="sourceLineNo">422</span> * to less frequently try to shrink its size.<a name="line.422"></a> +<span class="sourceLineNo">423</span> * </p><a name="line.423"></a> +<span class="sourceLineNo">424</span> *<a name="line.424"></a> +<span class="sourceLineNo">425</span> * @param pool<a name="line.425"></a> +<span class="sourceLineNo">426</span> * the ObjectPool to be decorated so it shrinks its idle count<a name="line.426"></a> +<span class="sourceLineNo">427</span> * when possible.<a name="line.427"></a> +<span class="sourceLineNo">428</span> * @param factor<a name="line.428"></a> +<span class="sourceLineNo">429</span> * a positive value to scale the rate at which the pool tries to<a name="line.429"></a> +<span class="sourceLineNo">430</span> * reduce its size. If 0 &lt; factor &lt; 1 then the pool<a name="line.430"></a> +<span class="sourceLineNo">431</span> * shrinks more aggressively. If 1 &lt; factor then the pool<a name="line.431"></a> +<span class="sourceLineNo">432</span> * shrinks less aggressively.<a name="line.432"></a> +<span class="sourceLineNo">433</span> * @param <T> the type of objects in the pool<a name="line.433"></a> +<span class="sourceLineNo">434</span> * @return a pool that adaptively decreases its size when idle objects are<a name="line.434"></a> +<span class="sourceLineNo">435</span> * no longer needed.<a name="line.435"></a> +<span class="sourceLineNo">436</span> * @see #erodingPool(ObjectPool)<a name="line.436"></a> +<span class="sourceLineNo">437</span> */<a name="line.437"></a> +<span class="sourceLineNo">438</span> public static <T> ObjectPool<T> erodingPool(final ObjectPool<T> pool,<a name="line.438"></a> +<span class="sourceLineNo">439</span> final float factor) {<a name="line.439"></a> +<span class="sourceLineNo">440</span> if (pool == null) {<a name="line.440"></a> +<span class="sourceLineNo">441</span> throw new IllegalArgumentException("pool must not be null.");<a name="line.441"></a> +<span class="sourceLineNo">442</span> }<a name="line.442"></a> +<span class="sourceLineNo">443</span> if (factor <= 0f) {<a name="line.443"></a> +<span class="sourceLineNo">444</span> throw new IllegalArgumentException("factor must be positive.");<a name="line.444"></a> +<span class="sourceLineNo">445</span> }<a name="line.445"></a> +<span class="sourceLineNo">446</span> return new ErodingObjectPool<T>(pool, factor);<a name="line.446"></a> +<span class="sourceLineNo">447</span> }<a name="line.447"></a> +<span class="sourceLineNo">448</span><a name="line.448"></a> +<span class="sourceLineNo">449</span> /**<a name="line.449"></a> +<span class="sourceLineNo">450</span> * Returns a pool that adaptively decreases its size when idle objects are<a name="line.450"></a> +<span class="sourceLineNo">451</span> * no longer needed. This is intended as an always thread-safe alternative<a name="line.451"></a> +<span class="sourceLineNo">452</span> * to using an idle object evictor provided by many pool implementations.<a name="line.452"></a> +<span class="sourceLineNo">453</span> * This is also an effective way to shrink FIFO ordered pools that<a name="line.453"></a> +<span class="sourceLineNo">454</span> * experience load spikes.<a name="line.454"></a> +<span class="sourceLineNo">455</span> *<a name="line.455"></a> +<span class="sourceLineNo">456</span> * @param keyedPool<a name="line.456"></a> +<span class="sourceLineNo">457</span> * the KeyedObjectPool to be decorated so it shrinks its idle<a name="line.457"></a> +<span class="sourceLineNo">458</span> * count when possible.<a name="line.458"></a> +<span class="sourceLineNo">459</span> * @param <K> the type of the pool key<a name="line.459"></a> +<span class="sourceLineNo">460</span> * @param <V> the type of pool entries<a name="line.460"></a> +<span class="sourceLineNo">461</span> * @return a pool that adaptively decreases its size when idle objects are<a name="line.461"></a> +<span class="sourceLineNo">462</span> * no longer needed.<a name="line.462"></a> +<span class="sourceLineNo">463</span> * @see #erodingPool(KeyedObjectPool, float)<a name="line.463"></a> +<span class="sourceLineNo">464</span> * @see #erodingPool(KeyedObjectPool, float, boolean)<a name="line.464"></a> +<span class="sourceLineNo">465</span> */<a name="line.465"></a> +<span class="sourceLineNo">466</span> public static <K, V> KeyedObjectPool<K, V> erodingPool(<a name="line.466"></a> +<span class="sourceLineNo">467</span> final KeyedObjectPool<K, V> keyedPool) {<a name="line.467"></a> +<span class="sourceLineNo">468</span> return erodingPool(keyedPool, 1f);<a name="line.468"></a> +<span class="sourceLineNo">469</span> }<a name="line.469"></a> +<span class="sourceLineNo">470</span><a name="line.470"></a> +<span class="sourceLineNo">471</span> /**<a name="line.471"></a> +<span class="sourceLineNo">472</span> * Returns a pool that adaptively decreases its size when idle objects are<a name="line.472"></a> +<span class="sourceLineNo">473</span> * no longer needed. This is intended as an always thread-safe alternative<a name="line.473"></a> +<span class="sourceLineNo">474</span> * to using an idle object evictor provided by many pool implementations.<a name="line.474"></a> +<span class="sourceLineNo">475</span> * This is also an effective way to shrink FIFO ordered pools that<a name="line.475"></a> +<span class="sourceLineNo">476</span> * experience load spikes.<a name="line.476"></a> +<span class="sourceLineNo">477</span> * <p><a name="line.477"></a> +<span class="sourceLineNo">478</span> * The factor parameter provides a mechanism to tweak the rate at which the<a name="line.478"></a> +<span class="sourceLineNo">479</span> * pool tries to shrink its size. Values between 0 and 1 cause the pool to<a name="line.479"></a> +<span class="sourceLineNo">480</span> * try to shrink its size more often. Values greater than 1 cause the pool<a name="line.480"></a> +<span class="sourceLineNo">481</span> * to less frequently try to shrink its size.<a name="line.481"></a> +<span class="sourceLineNo">482</span> * </p><a name="line.482"></a> +<span class="sourceLineNo">483</span> *<a name="line.483"></a> +<span class="sourceLineNo">484</span> * @param keyedPool<a name="line.484"></a> +<span class="sourceLineNo">485</span> * the KeyedObjectPool to be decorated so it shrinks its idle<a name="line.485"></a> +<span class="sourceLineNo">486</span> * count when possible.<a name="line.486"></a> +<span class="sourceLineNo">487</span> * @param factor<a name="line.487"></a> +<span class="sourceLineNo">488</span> * a positive value to scale the rate at which the pool tries to<a name="line.488"></a> +<span class="sourceLineNo">489</span> * reduce its size. If 0 &lt; factor &lt; 1 then the pool<a name="line.489"></a> +<span class="sourceLineNo">490</span> * shrinks more aggressively. If 1 &lt; factor then the pool<a name="line.490"></a> +<span class="sourceLineNo">491</span> * shrinks less aggressively.<a name="line.491"></a> +<span class="sourceLineNo">492</span> * @param <K> the type of the pool key<a name="line.492"></a> +<span class="sourceLineNo">493</span> * @param <V> the type of pool entries<a name="line.493"></a> +<span class="sourceLineNo">494</span> * @return a pool that adaptively decreases its size when idle objects are<a name="line.494"></a> +<span class="sourceLineNo">495</span> * no longer needed.<a name="line.495"></a> +<span class="sourceLineNo">496</span> * @see #erodingPool(KeyedObjectPool, float, boolean)<a name="line.496"></a> +<span class="sourceLineNo">497</span> */<a name="line.497"></a> +<span class="sourceLineNo">498</span> public static <K, V> KeyedObjectPool<K, V> erodingPool(<a name="line.498"></a> +<span class="sourceLineNo">499</span> final KeyedObjectPool<K, V> keyedPool, final float factor) {<a name="line.499"></a> +<span class="sourceLineNo">500</span> return erodingPool(keyedPool, factor, false);<a name="line.500"></a> +<span class="sourceLineNo">501</span> }<a name="line.501"></a> +<span class="sourceLineNo">502</span><a name="line.502"></a> +<span class="sourceLineNo">503</span> /**<a name="line.503"></a> +<span class="sourceLineNo">504</span> * Returns a pool that adaptively decreases its size when idle objects are<a name="line.504"></a> +<span class="sourceLineNo">505</span> * no longer needed. This is intended as an always thread-safe alternative<a name="line.505"></a> +<span class="sourceLineNo">506</span> * to using an idle object evictor provided by many pool implementations.<a name="line.506"></a> +<span class="sourceLineNo">507</span> * This is also an effective way to shrink FIFO ordered pools that<a name="line.507"></a> +<span class="sourceLineNo">508</span> * experience load spikes.<a name="line.508"></a> +<span class="sourceLineNo">509</span> * <p><a name="line.509"></a> +<span class="sourceLineNo">510</span> * The factor parameter provides a mechanism to tweak the rate at which the<a name="line.510"></a> +<span class="sourceLineNo">511</span> * pool tries to shrink its size. Values between 0 and 1 cause the pool to<a name="line.511"></a> +<span class="sourceLineNo">512</span> * try to shrink its size more often. Values greater than 1 cause the pool<a name="line.512"></a> +<span class="sourceLineNo">513</span> * to less frequently try to shrink its size.<a name="line.513"></a> +<span class="sourceLineNo">514</span> * </p><a name="line.514"></a> +<span class="sourceLineNo">515</span> * <p><a name="line.515"></a> +<span class="sourceLineNo">516</span> * The perKey parameter determines if the pool shrinks on a whole pool basis<a name="line.516"></a> +<span class="sourceLineNo">517</span> * or a per key basis. When perKey is false, the keys do not have an effect<a name="line.517"></a> +<span class="sourceLineNo">518</span> * on the rate at which the pool tries to shrink its size. When perKey is<a name="line.518"></a> +<span class="sourceLineNo">519</span> * true, each key is shrunk independently.<a name="line.519"></a> +<span class="sourceLineNo">520</span> * </p><a name="line.520"></a> +<span class="sourceLineNo">521</span> *<a name="line.521"></a> +<span class="sourceLineNo">522</span> * @param keyedPool<a name="line.522"></a> +<span class="sourceLineNo">523</span> * the KeyedObjectPool to be decorated so it shrinks its idle<a name="line.523"></a> +<span class="sourceLineNo">524</span> * count when possible.<a name="line.524"></a> +<span class="sourceLineNo">525</span> * @param factor<a name="line.525"></a> +<span class="sourceLineNo">526</span> * a positive value to scale the rate at which the pool tries to<a name="line.526"></a> +<span class="sourceLineNo">527</span> * reduce its size. If 0 &lt; factor &lt; 1 then the pool<a name="line.527"></a> +<span class="sourceLineNo">528</span> * shrinks more aggressively. If 1 &lt; factor then the pool<a name="line.528"></a> +<span class="sourceLineNo">529</span> * shrinks less aggressively.<a name="line.529"></a> +<span class="sourceLineNo">530</span> * @param perKey<a name="line.530"></a> +<span class="sourceLineNo">531</span> * when true, each key is treated independently.<a name="line.531"></a> +<span class="sourceLineNo">532</span> * @param <K> the type of the pool key<a name="line.532"></a> +<span class="sourceLineNo">533</span> * @param <V> the type of pool entries<a name="line.533"></a> +<span class="sourceLineNo">534</span> * @return a pool that adaptively decreases its size when idle objects are<a name="line.534"></a> +<span class="sourceLineNo">535</span> * no longer needed.<a name="line.535"></a> +<span class="sourceLineNo">536</span> * @see #erodingPool(KeyedObjectPool)<a name="line.536"></a> +<span class="sourceLineNo">537</span> * @see #erodingPool(KeyedObjectPool, float)<a name="line.537"></a> +<span class="sourceLineNo">538</span> */<a name="line.538"></a> +<span class="sourceLineNo">539</span> public static <K, V> KeyedObjectPool<K, V> erodingPool(<a name="line.539"></a> +<span class="sourceLineNo">540</span> final KeyedObjectPool<K, V> keyedPool, final float factor,<a name="line.540"></a> +<span class="sourceLineNo">541</span> final boolean perKey) {<a name="line.541"></a> +<span class="sourceLineNo">542</span> if (keyedPool == null) {<a name="line.542"></a> +<span class="sourceLineNo">543</span> throw new IllegalArgumentException("keyedPool must not be null.");<a name="line.543"></a> +<span class="sourceLineNo">544</span> }<a name="line.544"></a> +<span class="sourceLineNo">545</span> if (factor <= 0f) {<a name="line.545"></a> +<span class="sourceLineNo">546</span> throw new IllegalArgumentException("factor must be positive.");<a name="line.546"></a> +<span class="sourceLineNo">547</span> }<a name="line.547"></a> +<span class="sourceLineNo">548</span> if (perKey) {<a name="line.548"></a> +<span class="sourceLineNo">549</span> return new ErodingPerKeyKeyedObjectPool<K, V>(keyedPool, factor);<a name="line.549"></a> +<span class="sourceLineNo">550</span> }<a name="line.550"></a> +<span class="sourceLineNo">551</span> return new ErodingKeyedObjectPool<K, V>(keyedPool, factor);<a name="line.551"></a> +<span class="sourceLineNo">552</span> }<a name="line.552"></a> +<span class="sourceLineNo">553</span><a name="line.553"></a> +<span class="sourceLineNo">554</span> /**<a name="line.554"></a> +<span class="sourceLineNo">555</span> * Get the <code>Timer</code> for checking keyedPool's idle count.<a name="line.555"></a> +<span class="sourceLineNo">556</span> *<a name="line.556"></a> +<span class="sourceLineNo">557</span> * @return the {@link Timer} for checking keyedPool's idle count.<a name="line.557"></a> +<span class="sourceLineNo">558</span> */<a name="line.558"></a> +<span class="sourceLineNo">559</span> private static Timer getMinIdleTimer() {<a name="line.559"></a> +<span class="sourceLineNo">560</span> return TimerHolder.MIN_IDLE_TIMER;<a name="line.560"></a> +<span class="sourceLineNo">561</span> }<a name="line.561"></a> +<span class="sourceLineNo">562</span><a name="line.562"></a> +<span class="sourceLineNo">563</span> /**<a name="line.563"></a> +<span class="sourceLineNo">564</span> * Timer task that adds objects to the pool until the number of idle<a name="line.564"></a> +<span class="sourceLineNo">565</span> * instances reaches the configured minIdle. Note that this is not the same<a name="line.565"></a> +<span class="sourceLineNo">566</span> * as the pool's minIdle setting.<a name="line.566"></a> +<span class="sourceLineNo">567</span> */<a name="line.567"></a> +<span class="sourceLineNo">568</span> private static class ObjectPoolMinIdleTimerTask<T> extends TimerTask {<a name="line.568"></a> +<span class="sourceLineNo">569</span><a name="line.569"></a> +<span class="sourceLineNo">570</span> /** Minimum number of idle instances. Not the same as pool.getMinIdle(). */<a name="line.570"></a> +<span class="sourceLineNo">571</span> private final int minIdle;<a name="line.571"></a> +<span class="sourceLineNo">572</span><a name="line.572"></a> +<span class="sourceLineNo">573</span> /** Object pool */<a name="line.573"></a> +<span class="sourceLineNo">574</span> private final ObjectPool<T> pool;<a name="line.574"></a> +<span class="sourceLineNo">575</span><a name="line.575"></a> +<span class="sourceLineNo">576</span> /**<a name="line.576"></a> +<span class="sourceLineNo">577</span> * Create a new ObjectPoolMinIdleTimerTask for the given pool with the<a name="line.577"></a> +<span class="sourceLineNo">578</span> * given minIdle setting.<a name="line.578"></a> +<span class="sourceLineNo">579</span> *<a name="line.579"></a> +<span class="sourceLineNo">580</span> * @param pool<a name="line.580"></a> +<span class="sourceLineNo">581</span> * object pool<a name="line.581"></a> +<span class="sourceLineNo">582</span> * @param minIdle<a name="line.582"></a> +<span class="sourceLineNo">583</span> * number of idle instances to maintain<a name="line.583"></a> +<span class="sourceLineNo">584</span> * @throws IllegalArgumentException<a name="line.584"></a> +<span class="sourceLineNo">585</span> * if the pool is null<a name="line.585"></a> +<span class="sourceLineNo">586</span> */<a name="line.586"></a> +<span class="sourceLineNo">587</span> ObjectPoolMinIdleTimerTask(final ObjectPool<T> pool, final int minIdle)<a name="line.587"></a> +<span class="sourceLineNo">588</span> throws IllegalArgumentException {<a name="line.588"></a> +<span class="sourceLineNo">589</span> if (pool == null) {<a name="line.589"></a> +<span class="sourceLineNo">590</span> throw new IllegalArgumentException("pool must not be null.");<a name="line.590"></a> +<span class="sourceLineNo">591</span> }<a name="line.591"></a> +<span class="sourceLineNo">592</span> this.pool = pool;<a name="line.592"></a> +<span class="sourceLineNo">593</span> this.minIdle = minIdle;<a name="line.593"></a> +<span class="sourceLineNo">594</span> }<a name="line.594"></a> +<span class="sourceLineNo">595</span><a name="line.595"></a> +<span class="sourceLineNo">596</span> /**<a name="line.596"></a> +<span class="sourceLineNo">597</span> * {@inheritDoc}<a name="line.597"></a> +<span class="sourceLineNo">598</span> */<a name="line.598"></a> +<span class="sourceLineNo">599</span> @Override<a name="line.599"></a> +<span class="sourceLineNo">600</span> public void run() {<a name="line.600"></a> +<span class="sourceLineNo">601</span> boolean success = false;<a name="line.601"></a> +<span class="sourceLineNo">602</span> try {<a name="line.602"></a> +<span class="sourceLineNo">603</span> if (pool.getNumIdle() < minIdle) {<a name="line.603"></a> +<span class="sourceLineNo">604</span> pool.addObject();<a name="line.604"></a> +<span class="sourceLineNo">605</span> }<a name="line.605"></a> +<span class="sourceLineNo">606</span> success = true;<a name="line.606"></a> +<span class="sourceLineNo">607</span><a name="line.607"></a> +<span class="sourceLineNo">608</span> } catch (Exception e) {<a name="line.608"></a> +<span class="sourceLineNo">609</span> cancel();<a name="line.609"></a> +<span class="sourceLineNo">610</span> } finally {<a name="line.610"></a> +<span class="sourceLineNo">611</span> // detect other types of Throwable and cancel this Timer<a name="line.611"></a> +<span class="sourceLineNo">612</span> if (!success) {<a name="line.612"></a> +<span class="sourceLineNo">613</span> cancel();<a name="line.613"></a> +<span class="sourceLineNo">614</span> }<a name="line.614"></a> +<span class="sourceLineNo">615</span> }<a name="line.615"></a> +<span class="sourceLineNo">616</span> }<a name="line.616"></a> +<span class="sourceLineNo">617</span><a name="line.617"></a> +<span class="sourceLineNo">618</span> /**<a name="line.618"></a> +<span class="sourceLineNo">619</span> * {@inheritDoc}<a name="line.619"></a> +<span class="sourceLineNo">620</span> */<a name="line.620"></a> +<span class="sourceLineNo">621</span> @Override<a name="line.621"></a> +<span class="sourceLineNo">622</span> public String toString() {<a name="line.622"></a> +<span class="sourceLineNo">623</span> final StringBuilder sb = new StringBuilder();<a name="line.623"></a> +<span class="sourceLineNo">624</span> sb.append("ObjectPoolMinIdleTimerTask");<a name="line.624"></a> +<span class="sourceLineNo">625</span> sb.append("{minIdle=").append(minIdle);<a name="line.625"></a> +<span class="sourceLineNo">626</span> sb.append(", pool=").append(pool);<a name="line.626"></a> +<span class="sourceLineNo">627</span> sb.append('}');<a name="line.627"></a> +<span class="sourceLineNo">628</span> return sb.toString();<a name="line.628"></a> +<span class="sourceLineNo">629</span> }<a name="line.629"></a> +<span class="sourceLineNo">630</span> }<a name="line.630"></a> +<span class="sourceLineNo">631</span><a name="line.631"></a> +<span class="sourceLineNo">632</span> /**<a name="line.632"></a> +<span class="sourceLineNo">633</span> * Timer task that adds objects to the pool until the number of idle<a name="line.633"></a> +<span class="sourceLineNo">634</span> * instances for the given key reaches the configured minIdle. Note that<a name="line.634"></a> +<span class="sourceLineNo">635</span> * this is not the same as the pool's minIdle setting.<a name="line.635"></a> +<span class="sourceLineNo">636</span> */<a name="line.636"></a> +<span class="sourceLineNo">637</span> private static class KeyedObjectPoolMinIdleTimerTask<K, V> extends<a name="line.637"></a> +<span class="sourceLineNo">638</span> TimerTask {<a name="line.638"></a> +<span class="sourceLineNo">639</span> /** Minimum number of idle instances. Not the same as pool.getMinIdle(). */<a name="line.639"></a> +<span class="sourceLineNo">640</span> private final int minIdle;<a name="line.640"></a> +<span class="sourceLineNo">641</span><a name="line.641"></a> +<span class="sourceLineNo">642</span> /** Key to ensure minIdle for */<a name="line.642"></a> +<span class="sourceLineNo">643</span> private final K key;<a name="line.643"></a> +<span class="sourceLineNo">644</span><a name="line.644"></a> +<span class="sourceLineNo">645</span> /** Keyed object pool */<a name="line.645"></a> +<span class="sourceLineNo">646</span> private final KeyedObjectPool<K, V> keyedPool;<a name="line.646"></a> +<span class="sourceLineNo">647</span><a name="line.647"></a> +<span class="sourceLineNo">648</span> /**<a name="line.648"></a> +<span class="sourceLineNo">649</span> * Create a new KeyedObjecPoolMinIdleTimerTask.<a name="line.649"></a> +<span class="sourceLineNo">650</span> *<a name="line.650"></a> +<span class="sourceLineNo">651</span> * @param keyedPool<a name="line.651"></a> +<span class="sourceLineNo">652</span> * keyed object pool<a name="line.652"></a> +<span class="sourceLineNo">653</span> * @param key<a name="line.653"></a> +<span class="sourceLineNo">654</span> * key to ensure minimum number of idle instances<a name="line.654"></a> +<span class="sourceLineNo">655</span> * @param minIdle<a name="line.655"></a> +<span class="sourceLineNo">656</span> * minimum number of idle instances<a name="line.656"></a> +<span class="sourceLineNo">657</span> * @throws IllegalArgumentException<a name="line.657"></a> +<span class="sourceLineNo">658</span> * if the key is null<a name="line.658"></a> +<span class="sourceLineNo">659</span> */<a name="line.659"></a> +<span class="sourceLineNo">660</span> KeyedObjectPoolMinIdleTimerTask(final KeyedObjectPool<K, V> keyedPool,<a name="line.660"></a> +<span class="sourceLineNo">661</span> final K key, final int minIdle) throws IllegalArgumentException {<a name="line.661"></a> +<span class="sourceLineNo">662</span> if (keyedPool == null) {<a name="line.662"></a> +<span class="sourceLineNo">663</span> throw new IllegalArgumentException(<a name="line.663"></a> +<span class="sourceLineNo">664</span> "keyedPool must not be null.");<a name="line.664"></a> +<span class="sourceLineNo">665</span> }<a name="line.665"></a> +<span class="sourceLineNo">666</span> this.keyedPool = keyedPool;<a name="line.666"></a> +<span class="sourceLineNo">667</span> this.key = key;<a name="line.667"></a> +<span class="sourceLineNo">668</span> this.minIdle = minIdle;<a name="line.668"></a> +<span class="sourceLineNo">669</span> }<a name="line.669"></a> +<span class="sourceLineNo">670</span><a name="line.670"></a> +<span class="sourceLineNo">671</span> /**<a name="line.671"></a> +<span class="sourceLineNo">672</span> * {@inheritDoc}<a name="line.672"></a> +<span class="sourceLineNo">673</span> */<a name="line.673"></a> +<span class="sourceLineNo">674</span> @Override<a name="line.674"></a> +<span class="sourceLineNo">675</span> public void run() {<a name="line.675"></a> +<span class="sourceLineNo">676</span> boolean success = false;<a name="line.676"></a> +<span class="sourceLineNo">677</span> try {<a name="line.677"></a> +<span class="sourceLineNo">678</span> if (keyedPool.getNumIdle(key) < minIdle) {<a name="line.678"></a> +<span class="sourceLineNo">679</span> keyedPool.addObject(key);<a name="line.679"></a> +<span class="sourceLineNo">680</span> }<a name="line.680"></a> +<span class="sourceLineNo">681</span> success = true;<a name="line.681"></a> +<span class="sourceLineNo">682</span><a name="line.682"></a> +<span class="sourceLineNo">683</span> } catch (Exception e) {<a name="line.683"></a> +<span class="sourceLineNo">684</span> cancel();<a name="line.684"></a> +<span class="sourceLineNo">685</span><a name="line.685"></a> +<span class="sourceLineNo">686</span> } finally {<a name="line.686"></a> +<span class="sourceLineNo">687</span> // detect other types of Throwable and cancel this Timer<a name="line.687"></a> +<span class="sourceLineNo">688</span> if (!success) {<a name="line.688"></a> +<span class="sourceLineNo">689</span> cancel();<a name="line.689"></a> +<span class="sourceLineNo">690</span> }<a name="line.690"></a> +<span class="sourceLineNo">691</span> }<a name="line.691"></a> +<span class="sourceLineNo">692</span> }<a name="line.692"></a> +<span class="sourceLineNo">693</span><a name="line.693"></a> +<span class="sourceLineNo">694</span> /**<a name="line.694"></a> +<span class="sourceLineNo">695</span> * {@inheritDoc}<a name="line.695"></a> +<span class="sourceLineNo">696</span> */<a name="line.696"></a> +<span class="sourceLineNo">697</span> @Override<a name="line.697"></a> +<span class="sourceLineNo">698</span> public String toString() {<a name="line.698"></a> +<span class="sourceLineNo">699</span> final StringBuilder sb = new StringBuilder();<a name="line.699"></a> +<span class="sourceLineNo">700</span> sb.append("KeyedObjectPoolMinIdleTimerTask");<a name="line.700"></a> +<span class="sourceLineNo">701</span> sb.append("{minIdle=").append(minIdle);<a name="line.701"></a> +<span class="sourceLineNo">702</span> sb.append(", key=").append(key);<a name="line.702"></a> +<span class="sourceLineNo">703</span> sb.append(", keyedPool=").append(keyedPool);<a name="line.703"></a> +<span class="sourceLineNo">704</span> sb.append('}');<a name="line.704"></a> +<span class="sourceLineNo">705</span> return sb.toString();<a name="line.705"></a> +<span class="sourceLineNo">706</span> }<a name="line.706"></a> +<span class="sourceLineNo">707</span> }<a name="line.707"></a> +<span class="sourceLineNo">708</span><a name="line.708"></a> +<span class="sourceLineNo">709</span> /**<a name="line.709"></a> +<span class="sourceLineNo">710</span> * A synchronized (thread-safe) ObjectPool backed by the specified<a name="line.710"></a> +<span class="sourceLineNo">711</span> * ObjectPool.<a name="line.711"></a> +<span class="sourceLineNo">712</span> * <p><a name="line.712"></a> +<span class="sourceLineNo">713</span> * <b>Note:</b> This should not be used on pool implementations that already<a name="line.713"></a> +<span class="sourceLineNo">714</span> * provide proper synchronization such as the pools provided in the Commons<a name="line.714"></a> +<span class="sourceLineNo">715</span> * Pool library. Wrapping a pool that {@link #wait() waits} for poolable<a name="line.715"></a> +<span class="sourceLineNo">716</span> * objects to be returned before allowing another one to be borrowed with<a name="line.716"></a> +<span class="sourceLineNo">717</span> * another layer of synchronization will cause liveliness issues or a<a name="line.717"></a> +<span class="sourceLineNo">718</span> * deadlock.<a name="line.718"></a> +<span class="sourceLineNo">719</span> * </p><a name="line.719"></a> +<span class="sourceLineNo">720</span> */<a name="line.720"></a> +<span class="sourceLineNo">721</span> private static class SynchronizedObjectPool<T> implements ObjectPool<T> {<a name="line.721"></a> +<span class="sourceLineNo">722</span><a name="line.722"></a> +<span class="sourceLineNo">723</span> /**<a name="line.723"></a> +<span class="sourceLineNo">724</span> * Object whose monitor is used to synchronize methods on the wrapped<a name="line.724"></a> +<span class="sourceLineNo">725</span> * pool.<a name="line.725"></a> +<span class="sourceLineNo">726</span> */<a name="line.726"></a> +<span class="sourceLineNo">727</span> private final ReentrantReadWriteLock readWriteLock = new ReentrantReadWriteLock();<a name="line.727"></a> +<span class="sourceLineNo">728</span><a name="line.728"></a> +<span class="sourceLineNo">729</span> /** the underlying object pool */<a name="line.729"></a> +<span class="sourceLineNo">730</span> private final ObjectPool<T> pool;<a name="line.730"></a> +<span class="sourceLineNo">731</span><a name="line.731"></a> +<span class="sourceLineNo">732</span> /**<a name="line.732"></a> +<span class="sourceLineNo">733</span> * Create a new SynchronizedObjectPool wrapping the given pool.<a name="line.733"></a> +<span class="sourceLineNo">734</span> *<a name="line.734"></a> +<span class="sourceLineNo">735</span> * @param pool<a name="line.735"></a> +<span class="sourceLineNo">736</span> * the ObjectPool to be "wrapped" in a synchronized<a name="line.736"></a> +<span class="sourceLineNo">737</span> * ObjectPool.<a name="line.737"></a> +<span class="sourceLineNo">738</span> * @throws IllegalArgumentException<a name="line.738"></a> +<span class="sourceLineNo">739</span> * if the pool is null<a name="line.739"></a> +<span class="sourceLineNo">740</span> */<a name="line.740"></a> +<span class="sourceLineNo">741</span> SynchronizedObjectPool(final ObjectPool<T> pool)<a name="line.741"></a> +<span class="sourceLineNo">742</span> throws IllegalArgumentException {<a name="line.742"></a> +<span class="sourceLineNo">743</span> if (pool == null) {<a name="line.743"></a> +<span class="sourceLineNo">744</span> throw new IllegalArgumentException("pool must not be null.");<a name="line.744"></a> +<span class="sourceLineNo">745</span> }<a name="line.745"></a> +<span class="sourceLineNo">746</span> this.pool = pool;<a name="line.746"></a> +<span class="sourceLineNo">747</span> }<a name="line.747"></a> +<span class="sourceLineNo">748</span><a name="line.748"></a> +<span class="sourceLineNo">749</span> /**<a name="line.749"></a> +<span class="sourceLineNo">750</span> * {@inheritDoc}<a name="line.750"></a> +<span class="sourceLineNo">751</span> */<a name="line.751"></a> +<span class="sourceLineNo">752</span> @Override<a name="line.752"></a> +<span class="sourceLineNo">753</span> public T borrowObject() throws Exception, NoSuchElementException,<a name="line.753"></a> +<span class="sourceLineNo">754</span> IllegalStateException {<a name="line.754"></a> +<span class="sourceLineNo">755</span> WriteLock writeLock = readWriteLock.writeLock();<a name="line.755"></a> +<span class="sourceLineNo">756</span> writeLock.lock();<a name="line.756"></a> +<span class="sourceLineNo">757</span> try {<a name="line.757"></a> +<span class="sourceLineNo">758</span> return pool.borrowObject();<a name="line.758"></a> +<span class="sourceLineNo">759</span> } finally {<a name="line.759"></a> +<span class="sourceLineNo">760</span> writeLock.unlock();<a name="line.760"></a> +<span class="sourceLineNo">761</span> }<a name="line.761"></a> +<span class="sourceLineNo">762</span> }<a name="line.762"></a> +<span class="sourceLineNo">763</span><a name="line.763"></a> +<span class="sourceLineNo">764</span> /**<a name="line.764"></a> +<span class="sourceLineNo">765</span> * {@inheritDoc}<a name="line.765"></a> +<span class="sourceLineNo">766</span> */<a name="line.766"></a> +<span class="sourceLineNo">767</span> @Override<a name="line.767"></a> +<span class="sourceLineNo">768</span> public void returnObject(final T obj) {<a name="line.768"></a> +<span class="sourceLineNo">769</span> WriteLock writeLock = readWriteLock.writeLock();<a name="line.769"></a> +<span class="sourceLineNo">770</span> writeLock.lock();<a name="line.770"></a> +<span class="sourceLineNo">771</span> try {<a name="line.771"></a> +<span class="sourceLineNo">772</span> pool.returnObject(obj);<a name="line.772"></a> +<span class="sourceLineNo">773</span> } catch (Exception e) {<a name="line.773"></a> +<span class="sourceLineNo">774</span> // swallowed as of Pool 2<a name="line.774"></a> +<span class="sourceLineNo">775</span> } finally {<a name="line.775"></a> +<span class="sourceLineNo">776</span> writeLock.unlock();<a name="line.776"></a> +<span class="sourceLineNo">777</span> }<a name="line.777"></a> +<span class="sourceLineNo">778</span> }<a name="line.778"></a> +<span class="sourceLineNo">779</span><a name="line.779"></a> +<span class="sourceLineNo">780</span> /**<a name="line.780"></a> +<span class="sourceLineNo">781</span> * {@inheritDoc}<a name="line.781"></a> +<span class="sourceLineNo">782</span> */<a name="line.782"></a> +<span class="sourceLineNo">783</span> @Override<a name="line.783"></a> +<span class="sourceLineNo">784</span> public void invalidateObject(final T obj) {<a name="line.784"></a> +<span class="sourceLineNo">785</span> WriteLock writeLock = readWriteLock.writeLock();<a name="line.785"></a> +<span class="sourceLineNo">786</span> writeLock.lock();<a name="line.786"></a> +<span class="sourceLineNo">787</span> try {<a name="line.787"></a> +<span class="sourceLineNo">788</span> pool.invalidateObject(obj);<a name="line.788"></a> +<span class="sourceLineNo">789</span> } catch (Exception e) {<a name="line.789"></a> +<span class="sourceLineNo">790</span> // swallowed as of Pool 2<a name="line.790"></a> +<span class="sourceLineNo">791</span> } finally {<a name="line.791"></a> +<span class="sourceLineNo">792</span> writeLock.unlock();<a name="line.792"></a> +<span class="sourceLineNo">793</span> }<a name="line.793"></a> +<span class="sourceLineNo">794</span> }<a name="line.794"></a> +<span class="sourceLineNo">795</span><a name="line.795"></a> +<span class="sourceLineNo">796</span> /**<a name="line.796"></a> +<span class="sourceLineNo">797</span> * {@inheritDoc}<a name="line.797"></a> +<span class="sourceLineNo">798</span> */<a name="line.798"></a> +<span class="sourceLineNo">799</span> @Override<a name="line.799"></a> +<span class="sourceLineNo">800</span> public void addObject() throws Exception, IllegalStateException,<a name="line.800"></a> +<span class="sourceLineNo">801</span> UnsupportedOperationException {<a name="line.801"></a> +<span class="sourceLineNo">802</span> WriteLock writeLock = readWriteLock.writeLock();<a name="line.802"></a> +<span class="sourceLineNo">803</span> writeLock.lock();<a name="line.803"></a> +<span class="sourceLineNo">804</span> try {<a name="line.804"></a> +<span class="sourceLineNo">805</span> pool.addObject();<a name="line.805"></a> +<span class="sourceLineNo">806</span> } finally {<a name="line.806"></a> +<span class="sourceLineNo">807</span> writeLock.unlock();<a name="line.807"></a> +<span class="sourceLineNo">808</span> }<a name="line.808"></a> +<span class="sourceLineNo">809</span> }<a name="line.809"></a> +<span class="sourceLineNo">810</span><a name="line.810"></a> +<span class="sourceLineNo">811</span> /**<a name="line.811"></a> +<span class="sourceLineNo">812</span> * {@inheritDoc}<a name="line.812"></a> +<span class="sourceLineNo">813</span> */<a name="line.813"></a> +<span class="sourceLineNo">814</span> @Override<a name="line.814"></a> +<span class="sourceLineNo">815</span> public int getNumIdle() {<a name="line.815"></a> +<span class="sourceLineNo">816</span> ReadLock readLock = readWriteLock.readLock();<a name="line.816"></a> +<span class="sourceLineNo">817</span> readLock.lock();<a name="line.817"></a> +<span class="sourceLineNo">818</span> try {<a name="line.818"></a> +<span class="sourceLineNo">819</span> return pool.getNumIdle();<a name="line.819"></a> +<span class="sourceLineNo">820</span> } finally {<a name="line.820"></a> +<span class="sourceLineNo">821</span> readLock.unlock();<a name="line.821"></a> +<span class="sourceLineNo">822</span> }<a name="line.822"></a> +<span class="sourceLineNo">823</span> }<a name="line.823"></a> +<span class="sourceLineNo">824</span><a name="line.824"></a> +<span class="sourceLineNo">825</span> /**<a name="line.825"></a> +<span class="sourceLineNo">826</span> * {@inheritDoc}<a name="line.826"></a> +<span class="sourceLineNo">827</span> */<a name="line.827"></a> +<span class="sourceLineNo">828</span> @Override<a name="line.828"></a> +<span class="sourceLineNo">829</span> public int getNumActive() {<a name="line.829"></a> +<span class="sourceLineNo">830</span> ReadLock readLock = readWriteLock.readLock();<a name="line.830"></a> +<span class="sourceLineNo">831</span> readLock.lock();<a name="line.831"></a> +<span class="sourceLineNo">832</span> try {<a name="line.832"></a> +<span class="sourceLineNo">833</span> return pool.getNumActive();<a name="line.833"></a> +<span class="sourceLineNo">834</span> } finally {<a name="line.834"></a> +<span class="sourceLineNo">835</span> readLock.unlock();<a name="line.835"></a> +<span class="sourceLineNo">836</span> }<a name="line.836"></a> +<span class="sourceLineNo">837</span> }<a name="line.837"></a> +<span class="sourceLineNo">838</span><a name="line.838"></a> +<span class="sourceLineNo">839</span> /**<a name="line.839"></a> +<span class="sourceLineNo">840</span> * {@inheritDoc}<a name="line.840"></a> +<span class="sourceLineNo">841</span> */<a name="line.841"></a> +<span class="sourceLineNo">842</span> @Override<a name="line.842"></a> +<span class="sourceLineNo">843</span> public void clear() throws Exception, UnsupportedOperationException {<a name="line.843"></a> +<span class="sourceLineNo">844</span> WriteLock writeLock = readWriteLock.writeLock();<a name="line.844"></a> +<span class="sourceLineNo">845</span> writeLock.lock();<a name="line.845"></a> +<span class="sourceLineNo">846</span> try {<a name="line.846"></a> +<span class="sourceLineNo">847</span> pool.clear();<a name="line.847"></a> +<span class="sourceLineNo">848</span> } finally {<a name="line.848"></a> +<span class="sourceLineNo">849</span> writeLock.unlock();<a name="line.849"></a> +<span class="sourceLineNo">850</span> }<a name="line.850"></a> +<span class="sourceLineNo">851</span> }<a name="line.851"></a> +<span class="sourceLineNo">852</span><a name="line.852"></a> +<span class="sourceLineNo">853</span> /**<a name="line.853"></a> +<span class="sourceLineNo">854</span> * {@inheritDoc}<a name="line.854"></a> +<span class="sourceLineNo">855</span> */<a name="line.855"></a> +<span class="sourceLineNo">856</span> @Override<a name="line.856"></a> +<span class="sourceLineNo">857</span> public void close() {<a name="line.857"></a> +<span class="sourceLineNo">858</span> WriteLock writeLock = readWriteLock.writeLock();<a name="line.858"></a> +<span class="sourceLineNo">859</span> writeLock.lock();<a name="line.859"></a> +<span class="sourceLineNo">860</span> try {<a name="line.860"></a> +<span class="sourceLineNo">861</span> pool.close();<a name="line.861"></a> +<span class="sourceLineNo">862</span> } catch (Exception e) {<a name="line.862"></a> +<span class="sourceLineNo">863</span> // swallowed as of Pool 2<a name="line.863"></a> +<span class="sourceLineNo">864</span> } finally {<a name="line.864"></a> +<span class="sourceLineNo">865</span> writeLock.unlock();<a name="line.865"></a> +<span class="sourceLineNo">866</span> }<a name="line.866"></a> +<span class="sourceLineNo">867</span> }<a name="line.867"></a> +<span class="sourceLineNo">868</span><a name="line.868"></a> +<span class="sourceLineNo">869</span> /**<a name="line.869"></a> +<span class="sourceLineNo">870</span> * {@inheritDoc}<a name="line.870"></a> +<span class="sourceLineNo">871</span> */<a name="line.871"></a> +<span class="sourceLineNo">872</span> @Override<a name="line.872"></a> +<span class="sourceLineNo">873</span> public String toString() {<a name="line.873"></a> +<span class="sourceLineNo">874</span> final StringBuilder sb = new StringBuilder();<a name="line.874"></a> +<span class="sourceLineNo">875</span> sb.append("SynchronizedObjectPool");<a name="line.875"></a> +<span class="sourceLineNo">876</span> sb.append("{pool=").append(pool);<a name="line.876"></a> +<span class="sourceLineNo">877</span> sb.append('}');<a name="line.877"></a> +<span class="sourceLineNo">878</span> return sb.toString();<a name="line.878"></a> +<span class="sourceLineNo">879</span> }<a name="line.879"></a> +<span class="sourceLineNo">880</span> }<a name="line.880"></a> +<span class="sourceLineNo">881</span><a name="line.881"></a> +<span class="sourceLineNo">882</span> /**<a name="line.882"></a> +<span class="sourceLineNo">883</span> * A synchronized (thread-safe) KeyedObjectPool backed by the specified<a name="line.883"></a> +<span class="sourceLineNo">884</span> * KeyedObjectPool.<a name="line.884"></a> +<span class="sourceLineNo">885</span> * <p><a name="line.885"></a> +<span class="sourceLineNo">886</span> * <b>Note:</b> This should not be used on pool implementations that already<a name="line.886"></a> +<span class="sourceLineNo">887</span> * provide proper synchronization such as the pools provided in the Commons<a name="line.887"></a>
[... 982 lines stripped ...]
