Added: websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/BaseGenericObjectPool.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/BaseGenericObjectPool.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/BaseGenericObjectPool.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,1175 @@ +<!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.impl;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.io.PrintWriter;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.io.StringWriter;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.io.Writer;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.lang.management.ManagementFactory;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.lang.ref.WeakReference;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.util.Iterator;<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.concurrent.atomic.AtomicLong;<a name="line.26"></a> +<span class="sourceLineNo">027</span><a name="line.27"></a> +<span class="sourceLineNo">028</span>import javax.management.InstanceAlreadyExistsException;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import javax.management.InstanceNotFoundException;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import javax.management.MBeanRegistrationException;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import javax.management.MBeanServer;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import javax.management.MalformedObjectNameException;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import javax.management.NotCompliantMBeanException;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import javax.management.ObjectName;<a name="line.34"></a> +<span class="sourceLineNo">035</span><a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.commons.pool2.PooledObject;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import org.apache.commons.pool2.SwallowedExceptionListener;<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> * Base class that provides common functionality for {@link GenericObjectPool}<a name="line.40"></a> +<span class="sourceLineNo">041</span> * and {@link GenericKeyedObjectPool}. The primary reason this class exists is<a name="line.41"></a> +<span class="sourceLineNo">042</span> * reduce code duplication between the two pool implementations.<a name="line.42"></a> +<span class="sourceLineNo">043</span> *<a name="line.43"></a> +<span class="sourceLineNo">044</span> * @param <T> Type of element pooled in this pool.<a name="line.44"></a> +<span class="sourceLineNo">045</span> *<a name="line.45"></a> +<span class="sourceLineNo">046</span> * This class is intended to be thread-safe.<a name="line.46"></a> +<span class="sourceLineNo">047</span> *<a name="line.47"></a> +<span class="sourceLineNo">048</span> * @version $Revision: $<a name="line.48"></a> +<span class="sourceLineNo">049</span> *<a name="line.49"></a> +<span class="sourceLineNo">050</span> * @since 2.0<a name="line.50"></a> +<span class="sourceLineNo">051</span> */<a name="line.51"></a> +<span class="sourceLineNo">052</span>public abstract class BaseGenericObjectPool<T> {<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> // Constants<a name="line.54"></a> +<span class="sourceLineNo">055</span> /**<a name="line.55"></a> +<span class="sourceLineNo">056</span> * The size of the caches used to store historical data for some attributes<a name="line.56"></a> +<span class="sourceLineNo">057</span> * so that rolling means may be calculated.<a name="line.57"></a> +<span class="sourceLineNo">058</span> */<a name="line.58"></a> +<span class="sourceLineNo">059</span> public static final int MEAN_TIMING_STATS_CACHE_SIZE = 100;<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> // Configuration attributes<a name="line.61"></a> +<span class="sourceLineNo">062</span> private volatile int maxTotal =<a name="line.62"></a> +<span class="sourceLineNo">063</span> GenericKeyedObjectPoolConfig.DEFAULT_MAX_TOTAL;<a name="line.63"></a> +<span class="sourceLineNo">064</span> private volatile boolean blockWhenExhausted =<a name="line.64"></a> +<span class="sourceLineNo">065</span> BaseObjectPoolConfig.DEFAULT_BLOCK_WHEN_EXHAUSTED;<a name="line.65"></a> +<span class="sourceLineNo">066</span> private volatile long maxWaitMillis =<a name="line.66"></a> +<span class="sourceLineNo">067</span> BaseObjectPoolConfig.DEFAULT_MAX_WAIT_MILLIS;<a name="line.67"></a> +<span class="sourceLineNo">068</span> private volatile boolean lifo = BaseObjectPoolConfig.DEFAULT_LIFO;<a name="line.68"></a> +<span class="sourceLineNo">069</span> private final boolean fairness;<a name="line.69"></a> +<span class="sourceLineNo">070</span> private volatile boolean testOnCreate =<a name="line.70"></a> +<span class="sourceLineNo">071</span> BaseObjectPoolConfig.DEFAULT_TEST_ON_CREATE;<a name="line.71"></a> +<span class="sourceLineNo">072</span> private volatile boolean testOnBorrow =<a name="line.72"></a> +<span class="sourceLineNo">073</span> BaseObjectPoolConfig.DEFAULT_TEST_ON_BORROW;<a name="line.73"></a> +<span class="sourceLineNo">074</span> private volatile boolean testOnReturn =<a name="line.74"></a> +<span class="sourceLineNo">075</span> BaseObjectPoolConfig.DEFAULT_TEST_ON_RETURN;<a name="line.75"></a> +<span class="sourceLineNo">076</span> private volatile boolean testWhileIdle =<a name="line.76"></a> +<span class="sourceLineNo">077</span> BaseObjectPoolConfig.DEFAULT_TEST_WHILE_IDLE;<a name="line.77"></a> +<span class="sourceLineNo">078</span> private volatile long timeBetweenEvictionRunsMillis =<a name="line.78"></a> +<span class="sourceLineNo">079</span> BaseObjectPoolConfig.DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS;<a name="line.79"></a> +<span class="sourceLineNo">080</span> private volatile int numTestsPerEvictionRun =<a name="line.80"></a> +<span class="sourceLineNo">081</span> BaseObjectPoolConfig.DEFAULT_NUM_TESTS_PER_EVICTION_RUN;<a name="line.81"></a> +<span class="sourceLineNo">082</span> private volatile long minEvictableIdleTimeMillis =<a name="line.82"></a> +<span class="sourceLineNo">083</span> BaseObjectPoolConfig.DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS;<a name="line.83"></a> +<span class="sourceLineNo">084</span> private volatile long softMinEvictableIdleTimeMillis =<a name="line.84"></a> +<span class="sourceLineNo">085</span> BaseObjectPoolConfig.DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS;<a name="line.85"></a> +<span class="sourceLineNo">086</span> private volatile EvictionPolicy<T> evictionPolicy;<a name="line.86"></a> +<span class="sourceLineNo">087</span><a name="line.87"></a> +<span class="sourceLineNo">088</span><a name="line.88"></a> +<span class="sourceLineNo">089</span> // Internal (primarily state) attributes<a name="line.89"></a> +<span class="sourceLineNo">090</span> final Object closeLock = new Object();<a name="line.90"></a> +<span class="sourceLineNo">091</span> volatile boolean closed = false;<a name="line.91"></a> +<span class="sourceLineNo">092</span> final Object evictionLock = new Object();<a name="line.92"></a> +<span class="sourceLineNo">093</span> private Evictor evictor = null; // @GuardedBy("evictionLock")<a name="line.93"></a> +<span class="sourceLineNo">094</span> Iterator<PooledObject<T>> evictionIterator = null; // @GuardedBy("evictionLock")<a name="line.94"></a> +<span class="sourceLineNo">095</span> /*<a name="line.95"></a> +<span class="sourceLineNo">096</span> * Class loader for evictor thread to use since, in a JavaEE or similar<a name="line.96"></a> +<span class="sourceLineNo">097</span> * environment, the context class loader for the evictor thread may not have<a name="line.97"></a> +<span class="sourceLineNo">098</span> * visibility of the correct factory. See POOL-161. Uses a weak reference to<a name="line.98"></a> +<span class="sourceLineNo">099</span> * avoid potential memory leaks if the Pool is discarded rather than closed.<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> private final WeakReference<ClassLoader> factoryClassLoader;<a name="line.101"></a> +<span class="sourceLineNo">102</span><a name="line.102"></a> +<span class="sourceLineNo">103</span><a name="line.103"></a> +<span class="sourceLineNo">104</span> // Monitoring (primarily JMX) attributes<a name="line.104"></a> +<span class="sourceLineNo">105</span> private final ObjectName oname;<a name="line.105"></a> +<span class="sourceLineNo">106</span> private final String creationStackTrace;<a name="line.106"></a> +<span class="sourceLineNo">107</span> private final AtomicLong borrowedCount = new AtomicLong(0);<a name="line.107"></a> +<span class="sourceLineNo">108</span> private final AtomicLong returnedCount = new AtomicLong(0);<a name="line.108"></a> +<span class="sourceLineNo">109</span> final AtomicLong createdCount = new AtomicLong(0);<a name="line.109"></a> +<span class="sourceLineNo">110</span> final AtomicLong destroyedCount = new AtomicLong(0);<a name="line.110"></a> +<span class="sourceLineNo">111</span> final AtomicLong destroyedByEvictorCount = new AtomicLong(0);<a name="line.111"></a> +<span class="sourceLineNo">112</span> final AtomicLong destroyedByBorrowValidationCount = new AtomicLong(0);<a name="line.112"></a> +<span class="sourceLineNo">113</span> private final StatsStore activeTimes = new StatsStore(MEAN_TIMING_STATS_CACHE_SIZE);<a name="line.113"></a> +<span class="sourceLineNo">114</span> private final StatsStore idleTimes = new StatsStore(MEAN_TIMING_STATS_CACHE_SIZE);<a name="line.114"></a> +<span class="sourceLineNo">115</span> private final StatsStore waitTimes = new StatsStore(MEAN_TIMING_STATS_CACHE_SIZE);<a name="line.115"></a> +<span class="sourceLineNo">116</span> private final AtomicLong maxBorrowWaitTimeMillis = new AtomicLong(0L);<a name="line.116"></a> +<span class="sourceLineNo">117</span> private volatile SwallowedExceptionListener swallowedExceptionListener = null;<a name="line.117"></a> +<span class="sourceLineNo">118</span><a name="line.118"></a> +<span class="sourceLineNo">119</span><a name="line.119"></a> +<span class="sourceLineNo">120</span> /**<a name="line.120"></a> +<span class="sourceLineNo">121</span> * Handles JMX registration (if required) and the initialization required for<a name="line.121"></a> +<span class="sourceLineNo">122</span> * monitoring.<a name="line.122"></a> +<span class="sourceLineNo">123</span> *<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @param config Pool configuration<a name="line.124"></a> +<span class="sourceLineNo">125</span> * @param jmxNameBase The default base JMX name for the new pool unless<a name="line.125"></a> +<span class="sourceLineNo">126</span> * overridden by the config<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @param jmxNamePrefix Prefix to be used for JMX name for the new pool<a name="line.127"></a> +<span class="sourceLineNo">128</span> */<a name="line.128"></a> +<span class="sourceLineNo">129</span> public BaseGenericObjectPool(BaseObjectPoolConfig config,<a name="line.129"></a> +<span class="sourceLineNo">130</span> String jmxNameBase, String jmxNamePrefix) {<a name="line.130"></a> +<span class="sourceLineNo">131</span> if (config.getJmxEnabled()) {<a name="line.131"></a> +<span class="sourceLineNo">132</span> this.oname = jmxRegister(config, jmxNameBase, jmxNamePrefix);<a name="line.132"></a> +<span class="sourceLineNo">133</span> } else {<a name="line.133"></a> +<span class="sourceLineNo">134</span> this.oname = null;<a name="line.134"></a> +<span class="sourceLineNo">135</span> }<a name="line.135"></a> +<span class="sourceLineNo">136</span><a name="line.136"></a> +<span class="sourceLineNo">137</span> // Populate the creation stack trace<a name="line.137"></a> +<span class="sourceLineNo">138</span> this.creationStackTrace = getStackTrace(new Exception());<a name="line.138"></a> +<span class="sourceLineNo">139</span><a name="line.139"></a> +<span class="sourceLineNo">140</span> // save the current TCCL (if any) to be used later by the evictor Thread<a name="line.140"></a> +<span class="sourceLineNo">141</span> ClassLoader cl = Thread.currentThread().getContextClassLoader();<a name="line.141"></a> +<span class="sourceLineNo">142</span> if (cl == null) {<a name="line.142"></a> +<span class="sourceLineNo">143</span> factoryClassLoader = null;<a name="line.143"></a> +<span class="sourceLineNo">144</span> } else {<a name="line.144"></a> +<span class="sourceLineNo">145</span> factoryClassLoader = new WeakReference<ClassLoader>(cl);<a name="line.145"></a> +<span class="sourceLineNo">146</span> }<a name="line.146"></a> +<span class="sourceLineNo">147</span><a name="line.147"></a> +<span class="sourceLineNo">148</span> fairness = config.getFairness();<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><a name="line.151"></a> +<span class="sourceLineNo">152</span> /**<a name="line.152"></a> +<span class="sourceLineNo">153</span> * Returns the maximum number of objects that can be allocated by the pool<a name="line.153"></a> +<span class="sourceLineNo">154</span> * (checked out to clients, or idle awaiting checkout) at a given time. When<a name="line.154"></a> +<span class="sourceLineNo">155</span> * negative, there is no limit to the number of objects that can be<a name="line.155"></a> +<span class="sourceLineNo">156</span> * managed by the pool at one time.<a name="line.156"></a> +<span class="sourceLineNo">157</span> *<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @return the cap on the total number of object instances managed by the<a name="line.158"></a> +<span class="sourceLineNo">159</span> * pool.<a name="line.159"></a> +<span class="sourceLineNo">160</span> *<a name="line.160"></a> +<span class="sourceLineNo">161</span> * @see #setMaxTotal<a name="line.161"></a> +<span class="sourceLineNo">162</span> */<a name="line.162"></a> +<span class="sourceLineNo">163</span> public final int getMaxTotal() {<a name="line.163"></a> +<span class="sourceLineNo">164</span> return maxTotal;<a name="line.164"></a> +<span class="sourceLineNo">165</span> }<a name="line.165"></a> +<span class="sourceLineNo">166</span><a name="line.166"></a> +<span class="sourceLineNo">167</span> /**<a name="line.167"></a> +<span class="sourceLineNo">168</span> * Sets the cap on the number of objects that can be allocated by the pool<a name="line.168"></a> +<span class="sourceLineNo">169</span> * (checked out to clients, or idle awaiting checkout) at a given time. Use<a name="line.169"></a> +<span class="sourceLineNo">170</span> * a negative value for no limit.<a name="line.170"></a> +<span class="sourceLineNo">171</span> *<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @param maxTotal The cap on the total number of object instances managed<a name="line.172"></a> +<span class="sourceLineNo">173</span> * by the pool. Negative values mean that there is no limit<a name="line.173"></a> +<span class="sourceLineNo">174</span> * to the number of objects allocated by the pool.<a name="line.174"></a> +<span class="sourceLineNo">175</span> *<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @see #getMaxTotal<a name="line.176"></a> +<span class="sourceLineNo">177</span> */<a name="line.177"></a> +<span class="sourceLineNo">178</span> public final void setMaxTotal(int maxTotal) {<a name="line.178"></a> +<span class="sourceLineNo">179</span> this.maxTotal = maxTotal;<a name="line.179"></a> +<span class="sourceLineNo">180</span> }<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> * Returns whether to block when the <code>borrowObject()</code> method is<a name="line.183"></a> +<span class="sourceLineNo">184</span> * invoked when the pool is exhausted (the maximum number of "active"<a name="line.184"></a> +<span class="sourceLineNo">185</span> * objects has been reached).<a name="line.185"></a> +<span class="sourceLineNo">186</span> *<a name="line.186"></a> +<span class="sourceLineNo">187</span> * @return <code>true</code> if <code>borrowObject()</code> should block<a name="line.187"></a> +<span class="sourceLineNo">188</span> * when the pool is exhausted<a name="line.188"></a> +<span class="sourceLineNo">189</span> *<a name="line.189"></a> +<span class="sourceLineNo">190</span> * @see #setBlockWhenExhausted<a name="line.190"></a> +<span class="sourceLineNo">191</span> */<a name="line.191"></a> +<span class="sourceLineNo">192</span> public final boolean getBlockWhenExhausted() {<a name="line.192"></a> +<span class="sourceLineNo">193</span> return blockWhenExhausted;<a name="line.193"></a> +<span class="sourceLineNo">194</span> }<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * Sets whether to block when the <code>borrowObject()</code> method is<a name="line.197"></a> +<span class="sourceLineNo">198</span> * invoked when the pool is exhausted (the maximum number of "active"<a name="line.198"></a> +<span class="sourceLineNo">199</span> * objects has been reached).<a name="line.199"></a> +<span class="sourceLineNo">200</span> *<a name="line.200"></a> +<span class="sourceLineNo">201</span> * @param blockWhenExhausted <code>true</code> if<a name="line.201"></a> +<span class="sourceLineNo">202</span> * <code>borrowObject()</code> should block<a name="line.202"></a> +<span class="sourceLineNo">203</span> * when the pool is exhausted<a name="line.203"></a> +<span class="sourceLineNo">204</span> *<a name="line.204"></a> +<span class="sourceLineNo">205</span> * @see #getBlockWhenExhausted<a name="line.205"></a> +<span class="sourceLineNo">206</span> */<a name="line.206"></a> +<span class="sourceLineNo">207</span> public final void setBlockWhenExhausted(boolean blockWhenExhausted) {<a name="line.207"></a> +<span class="sourceLineNo">208</span> this.blockWhenExhausted = blockWhenExhausted;<a name="line.208"></a> +<span class="sourceLineNo">209</span> }<a name="line.209"></a> +<span class="sourceLineNo">210</span><a name="line.210"></a> +<span class="sourceLineNo">211</span> /**<a name="line.211"></a> +<span class="sourceLineNo">212</span> * Returns the maximum amount of time (in milliseconds) the<a name="line.212"></a> +<span class="sourceLineNo">213</span> * <code>borrowObject()</code> method should block before throwing an<a name="line.213"></a> +<span class="sourceLineNo">214</span> * exception when the pool is exhausted and<a name="line.214"></a> +<span class="sourceLineNo">215</span> * {@link #getBlockWhenExhausted} is true. When less than 0, the<a name="line.215"></a> +<span class="sourceLineNo">216</span> * <code>borrowObject()</code> method may block indefinitely.<a name="line.216"></a> +<span class="sourceLineNo">217</span> *<a name="line.217"></a> +<span class="sourceLineNo">218</span> * @return the maximum number of milliseconds <code>borrowObject()</code><a name="line.218"></a> +<span class="sourceLineNo">219</span> * will block.<a name="line.219"></a> +<span class="sourceLineNo">220</span> *<a name="line.220"></a> +<span class="sourceLineNo">221</span> * @see #setMaxWaitMillis<a name="line.221"></a> +<span class="sourceLineNo">222</span> * @see #setBlockWhenExhausted<a name="line.222"></a> +<span class="sourceLineNo">223</span> */<a name="line.223"></a> +<span class="sourceLineNo">224</span> public final long getMaxWaitMillis() {<a name="line.224"></a> +<span class="sourceLineNo">225</span> return maxWaitMillis;<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> * Sets the maximum amount of time (in milliseconds) the<a name="line.229"></a> +<span class="sourceLineNo">230</span> * <code>borrowObject()</code> method should block before throwing an<a name="line.230"></a> +<span class="sourceLineNo">231</span> * exception when the pool is exhausted and<a name="line.231"></a> +<span class="sourceLineNo">232</span> * {@link #getBlockWhenExhausted} is true. When less than 0, the<a name="line.232"></a> +<span class="sourceLineNo">233</span> * <code>borrowObject()</code> method may block indefinitely.<a name="line.233"></a> +<span class="sourceLineNo">234</span> *<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @param maxWaitMillis the maximum number of milliseconds<a name="line.235"></a> +<span class="sourceLineNo">236</span> * <code>borrowObject()</code> will block or negative<a name="line.236"></a> +<span class="sourceLineNo">237</span> * for indefinitely.<a name="line.237"></a> +<span class="sourceLineNo">238</span> *<a name="line.238"></a> +<span class="sourceLineNo">239</span> * @see #getMaxWaitMillis<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @see #setBlockWhenExhausted<a name="line.240"></a> +<span class="sourceLineNo">241</span> */<a name="line.241"></a> +<span class="sourceLineNo">242</span> public final void setMaxWaitMillis(long maxWaitMillis) {<a name="line.242"></a> +<span class="sourceLineNo">243</span> this.maxWaitMillis = maxWaitMillis;<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> /**<a name="line.246"></a> +<span class="sourceLineNo">247</span> * Returns whether the pool has LIFO (last in, first out) behaviour with<a name="line.247"></a> +<span class="sourceLineNo">248</span> * respect to idle objects - always returning the most recently used object<a name="line.248"></a> +<span class="sourceLineNo">249</span> * from the pool, or as a FIFO (first in, first out) queue, where the pool<a name="line.249"></a> +<span class="sourceLineNo">250</span> * always returns the oldest object in the idle object pool.<a name="line.250"></a> +<span class="sourceLineNo">251</span> *<a name="line.251"></a> +<span class="sourceLineNo">252</span> * @return <code>true</code> if the pool is configured with LIFO behaviour<a name="line.252"></a> +<span class="sourceLineNo">253</span> * or <code>false</code> if the pool is configured with FIFO<a name="line.253"></a> +<span class="sourceLineNo">254</span> * behaviour<a name="line.254"></a> +<span class="sourceLineNo">255</span> *<a name="line.255"></a> +<span class="sourceLineNo">256</span> * @see #setLifo<a name="line.256"></a> +<span class="sourceLineNo">257</span> */<a name="line.257"></a> +<span class="sourceLineNo">258</span> public final boolean getLifo() {<a name="line.258"></a> +<span class="sourceLineNo">259</span> return lifo;<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> /**<a name="line.262"></a> +<span class="sourceLineNo">263</span> * Returns whether or not the pool serves threads waiting to borrow objects fairly.<a name="line.263"></a> +<span class="sourceLineNo">264</span> * True means that waiting threads are served as if waiting in a FIFO queue.<a name="line.264"></a> +<span class="sourceLineNo">265</span> *<a name="line.265"></a> +<span class="sourceLineNo">266</span> * @return <code>true</code> if waiting threads are to be served<a name="line.266"></a> +<span class="sourceLineNo">267</span> * by the pool in arrival order<a name="line.267"></a> +<span class="sourceLineNo">268</span> */<a name="line.268"></a> +<span class="sourceLineNo">269</span> public final boolean getFairness() {<a name="line.269"></a> +<span class="sourceLineNo">270</span> return fairness;<a name="line.270"></a> +<span class="sourceLineNo">271</span> }<a name="line.271"></a> +<span class="sourceLineNo">272</span><a name="line.272"></a> +<span class="sourceLineNo">273</span> /**<a name="line.273"></a> +<span class="sourceLineNo">274</span> * Sets whether the pool has LIFO (last in, first out) behaviour with<a name="line.274"></a> +<span class="sourceLineNo">275</span> * respect to idle objects - always returning the most recently used object<a name="line.275"></a> +<span class="sourceLineNo">276</span> * from the pool, or as a FIFO (first in, first out) queue, where the pool<a name="line.276"></a> +<span class="sourceLineNo">277</span> * always returns the oldest object in the idle object pool.<a name="line.277"></a> +<span class="sourceLineNo">278</span> *<a name="line.278"></a> +<span class="sourceLineNo">279</span> * @param lifo <code>true</code> if the pool is to be configured with LIFO<a name="line.279"></a> +<span class="sourceLineNo">280</span> * behaviour or <code>false</code> if the pool is to be<a name="line.280"></a> +<span class="sourceLineNo">281</span> * configured with FIFO behaviour<a name="line.281"></a> +<span class="sourceLineNo">282</span> *<a name="line.282"></a> +<span class="sourceLineNo">283</span> * @see #getLifo()<a name="line.283"></a> +<span class="sourceLineNo">284</span> */<a name="line.284"></a> +<span class="sourceLineNo">285</span> public final void setLifo(boolean lifo) {<a name="line.285"></a> +<span class="sourceLineNo">286</span> this.lifo = lifo;<a name="line.286"></a> +<span class="sourceLineNo">287</span> }<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> * Returns whether objects created for the pool will be validated before<a name="line.290"></a> +<span class="sourceLineNo">291</span> * being returned from the <code>borrowObject()</code> method. Validation is<a name="line.291"></a> +<span class="sourceLineNo">292</span> * performed by the <code>validateObject()</code> method of the factory<a name="line.292"></a> +<span class="sourceLineNo">293</span> * associated with the pool. If the object fails to validate, then<a name="line.293"></a> +<span class="sourceLineNo">294</span> * <code>borrowObject()</code> will fail.<a name="line.294"></a> +<span class="sourceLineNo">295</span> *<a name="line.295"></a> +<span class="sourceLineNo">296</span> * @return <code>true</code> if newly created objects are validated before<a name="line.296"></a> +<span class="sourceLineNo">297</span> * being returned from the <code>borrowObject()</code> method<a name="line.297"></a> +<span class="sourceLineNo">298</span> *<a name="line.298"></a> +<span class="sourceLineNo">299</span> * @see #setTestOnCreate<a name="line.299"></a> +<span class="sourceLineNo">300</span> *<a name="line.300"></a> +<span class="sourceLineNo">301</span> * @since 2.2<a name="line.301"></a> +<span class="sourceLineNo">302</span> */<a name="line.302"></a> +<span class="sourceLineNo">303</span> public final boolean getTestOnCreate() {<a name="line.303"></a> +<span class="sourceLineNo">304</span> return testOnCreate;<a name="line.304"></a> +<span class="sourceLineNo">305</span> }<a name="line.305"></a> +<span class="sourceLineNo">306</span><a name="line.306"></a> +<span class="sourceLineNo">307</span> /**<a name="line.307"></a> +<span class="sourceLineNo">308</span> * Sets whether objects created for the pool will be validated before<a name="line.308"></a> +<span class="sourceLineNo">309</span> * being returned from the <code>borrowObject()</code> method. Validation is<a name="line.309"></a> +<span class="sourceLineNo">310</span> * performed by the <code>validateObject()</code> method of the factory<a name="line.310"></a> +<span class="sourceLineNo">311</span> * associated with the pool. If the object fails to validate, then<a name="line.311"></a> +<span class="sourceLineNo">312</span> * <code>borrowObject()</code> will fail.<a name="line.312"></a> +<span class="sourceLineNo">313</span> *<a name="line.313"></a> +<span class="sourceLineNo">314</span> * @param testOnCreate <code>true</code> if newly created objects should be<a name="line.314"></a> +<span class="sourceLineNo">315</span> * validated before being returned from the<a name="line.315"></a> +<span class="sourceLineNo">316</span> * <code>borrowObject()</code> method<a name="line.316"></a> +<span class="sourceLineNo">317</span> *<a name="line.317"></a> +<span class="sourceLineNo">318</span> * @see #getTestOnCreate<a name="line.318"></a> +<span class="sourceLineNo">319</span> *<a name="line.319"></a> +<span class="sourceLineNo">320</span> * @since 2.2<a name="line.320"></a> +<span class="sourceLineNo">321</span> */<a name="line.321"></a> +<span class="sourceLineNo">322</span> public final void setTestOnCreate(boolean testOnCreate) {<a name="line.322"></a> +<span class="sourceLineNo">323</span> this.testOnCreate = testOnCreate;<a name="line.323"></a> +<span class="sourceLineNo">324</span> }<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> * Returns whether objects borrowed from the pool will be validated before<a name="line.327"></a> +<span class="sourceLineNo">328</span> * being returned from the <code>borrowObject()</code> method. Validation is<a name="line.328"></a> +<span class="sourceLineNo">329</span> * performed by the <code>validateObject()</code> method of the factory<a name="line.329"></a> +<span class="sourceLineNo">330</span> * associated with the pool. If the object fails to validate, it will be<a name="line.330"></a> +<span class="sourceLineNo">331</span> * removed from the pool and destroyed, and a new attempt will be made to<a name="line.331"></a> +<span class="sourceLineNo">332</span> * borrow an object from the pool.<a name="line.332"></a> +<span class="sourceLineNo">333</span> *<a name="line.333"></a> +<span class="sourceLineNo">334</span> * @return <code>true</code> if objects are validated before being returned<a name="line.334"></a> +<span class="sourceLineNo">335</span> * from the <code>borrowObject()</code> method<a name="line.335"></a> +<span class="sourceLineNo">336</span> *<a name="line.336"></a> +<span class="sourceLineNo">337</span> * @see #setTestOnBorrow<a name="line.337"></a> +<span class="sourceLineNo">338</span> */<a name="line.338"></a> +<span class="sourceLineNo">339</span> public final boolean getTestOnBorrow() {<a name="line.339"></a> +<span class="sourceLineNo">340</span> return testOnBorrow;<a name="line.340"></a> +<span class="sourceLineNo">341</span> }<a name="line.341"></a> +<span class="sourceLineNo">342</span><a name="line.342"></a> +<span class="sourceLineNo">343</span> /**<a name="line.343"></a> +<span class="sourceLineNo">344</span> * Sets whether objects borrowed from the pool will be validated before<a name="line.344"></a> +<span class="sourceLineNo">345</span> * being returned from the <code>borrowObject()</code> method. Validation is<a name="line.345"></a> +<span class="sourceLineNo">346</span> * performed by the <code>validateObject()</code> method of the factory<a name="line.346"></a> +<span class="sourceLineNo">347</span> * associated with the pool. If the object fails to validate, it will be<a name="line.347"></a> +<span class="sourceLineNo">348</span> * removed from the pool and destroyed, and a new attempt will be made to<a name="line.348"></a> +<span class="sourceLineNo">349</span> * borrow an object from the pool.<a name="line.349"></a> +<span class="sourceLineNo">350</span> *<a name="line.350"></a> +<span class="sourceLineNo">351</span> * @param testOnBorrow <code>true</code> if objects should be validated<a name="line.351"></a> +<span class="sourceLineNo">352</span> * before being returned from the<a name="line.352"></a> +<span class="sourceLineNo">353</span> * <code>borrowObject()</code> method<a name="line.353"></a> +<span class="sourceLineNo">354</span> *<a name="line.354"></a> +<span class="sourceLineNo">355</span> * @see #getTestOnBorrow<a name="line.355"></a> +<span class="sourceLineNo">356</span> */<a name="line.356"></a> +<span class="sourceLineNo">357</span> public final void setTestOnBorrow(boolean testOnBorrow) {<a name="line.357"></a> +<span class="sourceLineNo">358</span> this.testOnBorrow = testOnBorrow;<a name="line.358"></a> +<span class="sourceLineNo">359</span> }<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> * Returns whether objects borrowed from the pool will be validated when<a name="line.362"></a> +<span class="sourceLineNo">363</span> * they are returned to the pool via the <code>returnObject()</code> method.<a name="line.363"></a> +<span class="sourceLineNo">364</span> * Validation is performed by the <code>validateObject()</code> method of<a name="line.364"></a> +<span class="sourceLineNo">365</span> * the factory associated with the pool. Returning objects that fail validation<a name="line.365"></a> +<span class="sourceLineNo">366</span> * are destroyed rather then being returned the pool.<a name="line.366"></a> +<span class="sourceLineNo">367</span> *<a name="line.367"></a> +<span class="sourceLineNo">368</span> * @return <code>true</code> if objects are validated on return to<a name="line.368"></a> +<span class="sourceLineNo">369</span> * the pool via the <code>returnObject()</code> method<a name="line.369"></a> +<span class="sourceLineNo">370</span> *<a name="line.370"></a> +<span class="sourceLineNo">371</span> * @see #setTestOnReturn<a name="line.371"></a> +<span class="sourceLineNo">372</span> */<a name="line.372"></a> +<span class="sourceLineNo">373</span> public final boolean getTestOnReturn() {<a name="line.373"></a> +<span class="sourceLineNo">374</span> return testOnReturn;<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> * Sets whether objects borrowed from the pool will be validated when<a name="line.378"></a> +<span class="sourceLineNo">379</span> * they are returned to the pool via the <code>returnObject()</code> method.<a name="line.379"></a> +<span class="sourceLineNo">380</span> * Validation is performed by the <code>validateObject()</code> method of<a name="line.380"></a> +<span class="sourceLineNo">381</span> * the factory associated with the pool. Returning objects that fail validation<a name="line.381"></a> +<span class="sourceLineNo">382</span> * are destroyed rather then being returned the pool.<a name="line.382"></a> +<span class="sourceLineNo">383</span> *<a name="line.383"></a> +<span class="sourceLineNo">384</span> * @param testOnReturn <code>true</code> if objects are validated on<a name="line.384"></a> +<span class="sourceLineNo">385</span> * return to the pool via the<a name="line.385"></a> +<span class="sourceLineNo">386</span> * <code>returnObject()</code> method<a name="line.386"></a> +<span class="sourceLineNo">387</span> *<a name="line.387"></a> +<span class="sourceLineNo">388</span> * @see #getTestOnReturn<a name="line.388"></a> +<span class="sourceLineNo">389</span> */<a name="line.389"></a> +<span class="sourceLineNo">390</span> public final void setTestOnReturn(boolean testOnReturn) {<a name="line.390"></a> +<span class="sourceLineNo">391</span> this.testOnReturn = testOnReturn;<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> /**<a name="line.394"></a> +<span class="sourceLineNo">395</span> * Returns whether objects sitting idle in the pool will be validated by the<a name="line.395"></a> +<span class="sourceLineNo">396</span> * idle object evictor (if any - see<a name="line.396"></a> +<span class="sourceLineNo">397</span> * {@link #setTimeBetweenEvictionRunsMillis(long)}). Validation is performed<a name="line.397"></a> +<span class="sourceLineNo">398</span> * by the <code>validateObject()</code> method of the factory associated<a name="line.398"></a> +<span class="sourceLineNo">399</span> * with the pool. If the object fails to validate, it will be removed from<a name="line.399"></a> +<span class="sourceLineNo">400</span> * the pool and destroyed.<a name="line.400"></a> +<span class="sourceLineNo">401</span> *<a name="line.401"></a> +<span class="sourceLineNo">402</span> * @return <code>true</code> if objects will be validated by the evictor<a name="line.402"></a> +<span class="sourceLineNo">403</span> *<a name="line.403"></a> +<span class="sourceLineNo">404</span> * @see #setTestWhileIdle<a name="line.404"></a> +<span class="sourceLineNo">405</span> * @see #setTimeBetweenEvictionRunsMillis<a name="line.405"></a> +<span class="sourceLineNo">406</span> */<a name="line.406"></a> +<span class="sourceLineNo">407</span> public final boolean getTestWhileIdle() {<a name="line.407"></a> +<span class="sourceLineNo">408</span> return testWhileIdle;<a name="line.408"></a> +<span class="sourceLineNo">409</span> }<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> * Returns whether objects sitting idle in the pool will be validated by the<a name="line.412"></a> +<span class="sourceLineNo">413</span> * idle object evictor (if any - see<a name="line.413"></a> +<span class="sourceLineNo">414</span> * {@link #setTimeBetweenEvictionRunsMillis(long)}). Validation is performed<a name="line.414"></a> +<span class="sourceLineNo">415</span> * by the <code>validateObject()</code> method of the factory associated<a name="line.415"></a> +<span class="sourceLineNo">416</span> * with the pool. If the object fails to validate, it will be removed from<a name="line.416"></a> +<span class="sourceLineNo">417</span> * the pool and destroyed. Note that setting this property has no effect<a name="line.417"></a> +<span class="sourceLineNo">418</span> * unless the idle object evictor is enabled by setting<a name="line.418"></a> +<span class="sourceLineNo">419</span> * <code>timeBetweenEvictionRunsMillis</code> to a positive value.<a name="line.419"></a> +<span class="sourceLineNo">420</span> *<a name="line.420"></a> +<span class="sourceLineNo">421</span> * @param testWhileIdle<a name="line.421"></a> +<span class="sourceLineNo">422</span> * <code>true</code> so objects will be validated by the evictor<a name="line.422"></a> +<span class="sourceLineNo">423</span> *<a name="line.423"></a> +<span class="sourceLineNo">424</span> * @see #getTestWhileIdle<a name="line.424"></a> +<span class="sourceLineNo">425</span> * @see #setTimeBetweenEvictionRunsMillis<a name="line.425"></a> +<span class="sourceLineNo">426</span> */<a name="line.426"></a> +<span class="sourceLineNo">427</span> public final void setTestWhileIdle(boolean testWhileIdle) {<a name="line.427"></a> +<span class="sourceLineNo">428</span> this.testWhileIdle = testWhileIdle;<a name="line.428"></a> +<span class="sourceLineNo">429</span> }<a name="line.429"></a> +<span class="sourceLineNo">430</span><a name="line.430"></a> +<span class="sourceLineNo">431</span> /**<a name="line.431"></a> +<span class="sourceLineNo">432</span> * Returns the number of milliseconds to sleep between runs of the idle<a name="line.432"></a> +<span class="sourceLineNo">433</span> * object evictor thread. When non-positive, no idle object evictor thread<a name="line.433"></a> +<span class="sourceLineNo">434</span> * will be run.<a name="line.434"></a> +<span class="sourceLineNo">435</span> *<a name="line.435"></a> +<span class="sourceLineNo">436</span> * @return number of milliseconds to sleep between evictor runs<a name="line.436"></a> +<span class="sourceLineNo">437</span> *<a name="line.437"></a> +<span class="sourceLineNo">438</span> * @see #setTimeBetweenEvictionRunsMillis<a name="line.438"></a> +<span class="sourceLineNo">439</span> */<a name="line.439"></a> +<span class="sourceLineNo">440</span> public final long getTimeBetweenEvictionRunsMillis() {<a name="line.440"></a> +<span class="sourceLineNo">441</span> return timeBetweenEvictionRunsMillis;<a name="line.441"></a> +<span class="sourceLineNo">442</span> }<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> * Sets the number of milliseconds to sleep between runs of the idle<a name="line.445"></a> +<span class="sourceLineNo">446</span> * object evictor thread. When non-positive, no idle object evictor thread<a name="line.446"></a> +<span class="sourceLineNo">447</span> * will be run.<a name="line.447"></a> +<span class="sourceLineNo">448</span> *<a name="line.448"></a> +<span class="sourceLineNo">449</span> * @param timeBetweenEvictionRunsMillis<a name="line.449"></a> +<span class="sourceLineNo">450</span> * number of milliseconds to sleep between evictor runs<a name="line.450"></a> +<span class="sourceLineNo">451</span> *<a name="line.451"></a> +<span class="sourceLineNo">452</span> * @see #getTimeBetweenEvictionRunsMillis<a name="line.452"></a> +<span class="sourceLineNo">453</span> */<a name="line.453"></a> +<span class="sourceLineNo">454</span> public final void setTimeBetweenEvictionRunsMillis(<a name="line.454"></a> +<span class="sourceLineNo">455</span> long timeBetweenEvictionRunsMillis) {<a name="line.455"></a> +<span class="sourceLineNo">456</span> this.timeBetweenEvictionRunsMillis = timeBetweenEvictionRunsMillis;<a name="line.456"></a> +<span class="sourceLineNo">457</span> startEvictor(timeBetweenEvictionRunsMillis);<a name="line.457"></a> +<span class="sourceLineNo">458</span> }<a name="line.458"></a> +<span class="sourceLineNo">459</span><a name="line.459"></a> +<span class="sourceLineNo">460</span> /**<a name="line.460"></a> +<span class="sourceLineNo">461</span> * Returns the maximum number of objects to examine during each run (if any)<a name="line.461"></a> +<span class="sourceLineNo">462</span> * of the idle object evictor thread. When positive, the number of tests<a name="line.462"></a> +<span class="sourceLineNo">463</span> * performed for a run will be the minimum of the configured value and the<a name="line.463"></a> +<span class="sourceLineNo">464</span> * number of idle instances in the pool. When negative, the number of tests<a name="line.464"></a> +<span class="sourceLineNo">465</span> * performed will be <code>ceil({@link #getNumIdle}/<a name="line.465"></a> +<span class="sourceLineNo">466</span> * abs({@link #getNumTestsPerEvictionRun}))</code> which means that when the<a name="line.466"></a> +<span class="sourceLineNo">467</span> * value is <code>-n</code> roughly one nth of the idle objects will be<a name="line.467"></a> +<span class="sourceLineNo">468</span> * tested per run.<a name="line.468"></a> +<span class="sourceLineNo">469</span> *<a name="line.469"></a> +<span class="sourceLineNo">470</span> * @return max number of objects to examine during each evictor run<a name="line.470"></a> +<span class="sourceLineNo">471</span> *<a name="line.471"></a> +<span class="sourceLineNo">472</span> * @see #setNumTestsPerEvictionRun<a name="line.472"></a> +<span class="sourceLineNo">473</span> * @see #setTimeBetweenEvictionRunsMillis<a name="line.473"></a> +<span class="sourceLineNo">474</span> */<a name="line.474"></a> +<span class="sourceLineNo">475</span> public final int getNumTestsPerEvictionRun() {<a name="line.475"></a> +<span class="sourceLineNo">476</span> return numTestsPerEvictionRun;<a name="line.476"></a> +<span class="sourceLineNo">477</span> }<a name="line.477"></a> +<span class="sourceLineNo">478</span><a name="line.478"></a> +<span class="sourceLineNo">479</span> /**<a name="line.479"></a> +<span class="sourceLineNo">480</span> * Sets the maximum number of objects to examine during each run (if any)<a name="line.480"></a> +<span class="sourceLineNo">481</span> * of the idle object evictor thread. When positive, the number of tests<a name="line.481"></a> +<span class="sourceLineNo">482</span> * performed for a run will be the minimum of the configured value and the<a name="line.482"></a> +<span class="sourceLineNo">483</span> * number of idle instances in the pool. When negative, the number of tests<a name="line.483"></a> +<span class="sourceLineNo">484</span> * performed will be <code>ceil({@link #getNumIdle}/<a name="line.484"></a> +<span class="sourceLineNo">485</span> * abs({@link #getNumTestsPerEvictionRun}))</code> which means that when the<a name="line.485"></a> +<span class="sourceLineNo">486</span> * value is <code>-n</code> roughly one nth of the idle objects will be<a name="line.486"></a> +<span class="sourceLineNo">487</span> * tested per run.<a name="line.487"></a> +<span class="sourceLineNo">488</span> *<a name="line.488"></a> +<span class="sourceLineNo">489</span> * @param numTestsPerEvictionRun<a name="line.489"></a> +<span class="sourceLineNo">490</span> * max number of objects to examine during each evictor run<a name="line.490"></a> +<span class="sourceLineNo">491</span> *<a name="line.491"></a> +<span class="sourceLineNo">492</span> * @see #getNumTestsPerEvictionRun<a name="line.492"></a> +<span class="sourceLineNo">493</span> * @see #setTimeBetweenEvictionRunsMillis<a name="line.493"></a> +<span class="sourceLineNo">494</span> */<a name="line.494"></a> +<span class="sourceLineNo">495</span> public final void setNumTestsPerEvictionRun(int numTestsPerEvictionRun) {<a name="line.495"></a> +<span class="sourceLineNo">496</span> this.numTestsPerEvictionRun = numTestsPerEvictionRun;<a name="line.496"></a> +<span class="sourceLineNo">497</span> }<a name="line.497"></a> +<span class="sourceLineNo">498</span><a name="line.498"></a> +<span class="sourceLineNo">499</span> /**<a name="line.499"></a> +<span class="sourceLineNo">500</span> * Returns the minimum amount of time an object may sit idle in the pool<a name="line.500"></a> +<span class="sourceLineNo">501</span> * before it is eligible for eviction by the idle object evictor (if any -<a name="line.501"></a> +<span class="sourceLineNo">502</span> * see {@link #setTimeBetweenEvictionRunsMillis(long)}). When non-positive,<a name="line.502"></a> +<span class="sourceLineNo">503</span> * no objects will be evicted from the pool due to idle time alone.<a name="line.503"></a> +<span class="sourceLineNo">504</span> *<a name="line.504"></a> +<span class="sourceLineNo">505</span> * @return minimum amount of time an object may sit idle in the pool before<a name="line.505"></a> +<span class="sourceLineNo">506</span> * it is eligible for eviction<a name="line.506"></a> +<span class="sourceLineNo">507</span> *<a name="line.507"></a> +<span class="sourceLineNo">508</span> * @see #setMinEvictableIdleTimeMillis<a name="line.508"></a> +<span class="sourceLineNo">509</span> * @see #setTimeBetweenEvictionRunsMillis<a name="line.509"></a> +<span class="sourceLineNo">510</span> */<a name="line.510"></a> +<span class="sourceLineNo">511</span> public final long getMinEvictableIdleTimeMillis() {<a name="line.511"></a> +<span class="sourceLineNo">512</span> return minEvictableIdleTimeMillis;<a name="line.512"></a> +<span class="sourceLineNo">513</span> }<a name="line.513"></a> +<span class="sourceLineNo">514</span><a name="line.514"></a> +<span class="sourceLineNo">515</span> /**<a name="line.515"></a> +<span class="sourceLineNo">516</span> * Sets the minimum amount of time an object may sit idle in the pool<a name="line.516"></a> +<span class="sourceLineNo">517</span> * before it is eligible for eviction by the idle object evictor (if any -<a name="line.517"></a> +<span class="sourceLineNo">518</span> * see {@link #setTimeBetweenEvictionRunsMillis(long)}). When non-positive,<a name="line.518"></a> +<span class="sourceLineNo">519</span> * no objects will be evicted from the pool due to idle time alone.<a name="line.519"></a> +<span class="sourceLineNo">520</span> *<a name="line.520"></a> +<span class="sourceLineNo">521</span> * @param minEvictableIdleTimeMillis<a name="line.521"></a> +<span class="sourceLineNo">522</span> * minimum amount of time an object may sit idle in the pool<a name="line.522"></a> +<span class="sourceLineNo">523</span> * before it is eligible for eviction<a name="line.523"></a> +<span class="sourceLineNo">524</span> *<a name="line.524"></a> +<span class="sourceLineNo">525</span> * @see #getMinEvictableIdleTimeMillis<a name="line.525"></a> +<span class="sourceLineNo">526</span> * @see #setTimeBetweenEvictionRunsMillis<a name="line.526"></a> +<span class="sourceLineNo">527</span> */<a name="line.527"></a> +<span class="sourceLineNo">528</span> public final void setMinEvictableIdleTimeMillis(<a name="line.528"></a> +<span class="sourceLineNo">529</span> long minEvictableIdleTimeMillis) {<a name="line.529"></a> +<span class="sourceLineNo">530</span> this.minEvictableIdleTimeMillis = minEvictableIdleTimeMillis;<a name="line.530"></a> +<span class="sourceLineNo">531</span> }<a name="line.531"></a> +<span class="sourceLineNo">532</span><a name="line.532"></a> +<span class="sourceLineNo">533</span> /**<a name="line.533"></a> +<span class="sourceLineNo">534</span> * Returns the minimum amount of time an object may sit idle in the pool<a name="line.534"></a> +<span class="sourceLineNo">535</span> * before it is eligible for eviction by the idle object evictor (if any -<a name="line.535"></a> +<span class="sourceLineNo">536</span> * see {@link #setTimeBetweenEvictionRunsMillis(long)}),<a name="line.536"></a> +<span class="sourceLineNo">537</span> * with the extra condition that at least <code>minIdle</code> object<a name="line.537"></a> +<span class="sourceLineNo">538</span> * instances remain in the pool. This setting is overridden by<a name="line.538"></a> +<span class="sourceLineNo">539</span> * {@link #getMinEvictableIdleTimeMillis} (that is, if<a name="line.539"></a> +<span class="sourceLineNo">540</span> * {@link #getMinEvictableIdleTimeMillis} is positive, then<a name="line.540"></a> +<span class="sourceLineNo">541</span> * {@link #getSoftMinEvictableIdleTimeMillis} is ignored).<a name="line.541"></a> +<span class="sourceLineNo">542</span> *<a name="line.542"></a> +<span class="sourceLineNo">543</span> * @return minimum amount of time an object may sit idle in the pool before<a name="line.543"></a> +<span class="sourceLineNo">544</span> * it is eligible for eviction if minIdle instances are available<a name="line.544"></a> +<span class="sourceLineNo">545</span> *<a name="line.545"></a> +<span class="sourceLineNo">546</span> * @see #setSoftMinEvictableIdleTimeMillis<a name="line.546"></a> +<span class="sourceLineNo">547</span> */<a name="line.547"></a> +<span class="sourceLineNo">548</span> public final long getSoftMinEvictableIdleTimeMillis() {<a name="line.548"></a> +<span class="sourceLineNo">549</span> return softMinEvictableIdleTimeMillis;<a name="line.549"></a> +<span class="sourceLineNo">550</span> }<a name="line.550"></a> +<span class="sourceLineNo">551</span><a name="line.551"></a> +<span class="sourceLineNo">552</span> /**<a name="line.552"></a> +<span class="sourceLineNo">553</span> * Sets the minimum amount of time an object may sit idle in the pool<a name="line.553"></a> +<span class="sourceLineNo">554</span> * before it is eligible for eviction by the idle object evictor (if any -<a name="line.554"></a> +<span class="sourceLineNo">555</span> * see {@link #setTimeBetweenEvictionRunsMillis(long)}),<a name="line.555"></a> +<span class="sourceLineNo">556</span> * with the extra condition that at least <code>minIdle</code> object<a name="line.556"></a> +<span class="sourceLineNo">557</span> * instances remain in the pool. This setting is overridden by<a name="line.557"></a> +<span class="sourceLineNo">558</span> * {@link #getMinEvictableIdleTimeMillis} (that is, if<a name="line.558"></a> +<span class="sourceLineNo">559</span> * {@link #getMinEvictableIdleTimeMillis} is positive, then<a name="line.559"></a> +<span class="sourceLineNo">560</span> * {@link #getSoftMinEvictableIdleTimeMillis} is ignored).<a name="line.560"></a> +<span class="sourceLineNo">561</span> *<a name="line.561"></a> +<span class="sourceLineNo">562</span> * @param softMinEvictableIdleTimeMillis<a name="line.562"></a> +<span class="sourceLineNo">563</span> * minimum amount of time an object may sit idle in the pool<a name="line.563"></a> +<span class="sourceLineNo">564</span> * before it is eligible for eviction if minIdle instances are<a name="line.564"></a> +<span class="sourceLineNo">565</span> * available<a name="line.565"></a> +<span class="sourceLineNo">566</span> *<a name="line.566"></a> +<span class="sourceLineNo">567</span> * @see #getSoftMinEvictableIdleTimeMillis<a name="line.567"></a> +<span class="sourceLineNo">568</span> */<a name="line.568"></a> +<span class="sourceLineNo">569</span> public final void setSoftMinEvictableIdleTimeMillis(<a name="line.569"></a> +<span class="sourceLineNo">570</span> long softMinEvictableIdleTimeMillis) {<a name="line.570"></a> +<span class="sourceLineNo">571</span> this.softMinEvictableIdleTimeMillis = softMinEvictableIdleTimeMillis;<a name="line.571"></a> +<span class="sourceLineNo">572</span> }<a name="line.572"></a> +<span class="sourceLineNo">573</span><a name="line.573"></a> +<span class="sourceLineNo">574</span> /**<a name="line.574"></a> +<span class="sourceLineNo">575</span> * Returns the name of the {@link EvictionPolicy} implementation that is<a name="line.575"></a> +<span class="sourceLineNo">576</span> * used by this pool.<a name="line.576"></a> +<span class="sourceLineNo">577</span> *<a name="line.577"></a> +<span class="sourceLineNo">578</span> * @return The fully qualified class name of the {@link EvictionPolicy}<a name="line.578"></a> +<span class="sourceLineNo">579</span> *<a name="line.579"></a> +<span class="sourceLineNo">580</span> * @see #setEvictionPolicyClassName(String)<a name="line.580"></a> +<span class="sourceLineNo">581</span> */<a name="line.581"></a> +<span class="sourceLineNo">582</span> public final String getEvictionPolicyClassName() {<a name="line.582"></a> +<span class="sourceLineNo">583</span> return evictionPolicy.getClass().getName();<a name="line.583"></a> +<span class="sourceLineNo">584</span> }<a name="line.584"></a> +<span class="sourceLineNo">585</span><a name="line.585"></a> +<span class="sourceLineNo">586</span> /**<a name="line.586"></a> +<span class="sourceLineNo">587</span> * Sets the name of the {@link EvictionPolicy} implementation that is<a name="line.587"></a> +<span class="sourceLineNo">588</span> * used by this pool.<a name="line.588"></a> +<span class="sourceLineNo">589</span> *<a name="line.589"></a> +<span class="sourceLineNo">590</span> * @param evictionPolicyClassName the fully qualified class name of the<a name="line.590"></a> +<span class="sourceLineNo">591</span> * new eviction policy<a name="line.591"></a> +<span class="sourceLineNo">592</span> *<a name="line.592"></a> +<span class="sourceLineNo">593</span> * @see #getEvictionPolicyClassName()<a name="line.593"></a> +<span class="sourceLineNo">594</span> */<a name="line.594"></a> +<span class="sourceLineNo">595</span> public final void setEvictionPolicyClassName(<a name="line.595"></a> +<span class="sourceLineNo">596</span> String evictionPolicyClassName) {<a name="line.596"></a> +<span class="sourceLineNo">597</span> try {<a name="line.597"></a> +<span class="sourceLineNo">598</span> Class<?> clazz = Class.forName(evictionPolicyClassName, true,<a name="line.598"></a> +<span class="sourceLineNo">599</span> Thread.currentThread().getContextClassLoader());<a name="line.599"></a> +<span class="sourceLineNo">600</span> Object policy = clazz.newInstance();<a name="line.600"></a> +<span class="sourceLineNo">601</span> if (policy instanceof EvictionPolicy<?>) {<a name="line.601"></a> +<span class="sourceLineNo">602</span> @SuppressWarnings("unchecked") // safe, because we just checked the class<a name="line.602"></a> +<span class="sourceLineNo">603</span> EvictionPolicy<T> evicPolicy = (EvictionPolicy<T>) policy;<a name="line.603"></a> +<span class="sourceLineNo">604</span> this.evictionPolicy = evicPolicy;<a name="line.604"></a> +<span class="sourceLineNo">605</span> }<a name="line.605"></a> +<span class="sourceLineNo">606</span> } catch (ClassNotFoundException e) {<a name="line.606"></a> +<span class="sourceLineNo">607</span> throw new IllegalArgumentException(<a name="line.607"></a> +<span class="sourceLineNo">608</span> "Unable to create EvictionPolicy instance of type " +<a name="line.608"></a> +<span class="sourceLineNo">609</span> evictionPolicyClassName, e);<a name="line.609"></a> +<span class="sourceLineNo">610</span> } catch (InstantiationException e) {<a name="line.610"></a> +<span class="sourceLineNo">611</span> throw new IllegalArgumentException(<a name="line.611"></a> +<span class="sourceLineNo">612</span> "Unable to create EvictionPolicy instance of type " +<a name="line.612"></a> +<span class="sourceLineNo">613</span> evictionPolicyClassName, e);<a name="line.613"></a> +<span class="sourceLineNo">614</span> } catch (IllegalAccessException e) {<a name="line.614"></a> +<span class="sourceLineNo">615</span> throw new IllegalArgumentException(<a name="line.615"></a> +<span class="sourceLineNo">616</span> "Unable to create EvictionPolicy instance of type " +<a name="line.616"></a> +<span class="sourceLineNo">617</span> evictionPolicyClassName, e);<a name="line.617"></a> +<span class="sourceLineNo">618</span> }<a name="line.618"></a> +<span class="sourceLineNo">619</span> }<a name="line.619"></a> +<span class="sourceLineNo">620</span><a name="line.620"></a> +<span class="sourceLineNo">621</span><a name="line.621"></a> +<span class="sourceLineNo">622</span> /**<a name="line.622"></a> +<span class="sourceLineNo">623</span> * Closes the pool, destroys the remaining idle objects and, if registered<a name="line.623"></a> +<span class="sourceLineNo">624</span> * in JMX, deregisters it.<a name="line.624"></a> +<span class="sourceLineNo">625</span> */<a name="line.625"></a> +<span class="sourceLineNo">626</span> public abstract void close();<a name="line.626"></a> +<span class="sourceLineNo">627</span><a name="line.627"></a> +<span class="sourceLineNo">628</span> /**<a name="line.628"></a> +<span class="sourceLineNo">629</span> * Has this pool instance been closed.<a name="line.629"></a> +<span class="sourceLineNo">630</span> * @return <code>true</code> when this pool has been closed.<a name="line.630"></a> +<span class="sourceLineNo">631</span> */<a name="line.631"></a> +<span class="sourceLineNo">632</span> public final boolean isClosed() {<a name="line.632"></a> +<span class="sourceLineNo">633</span> return closed;<a name="line.633"></a> +<span class="sourceLineNo">634</span> }<a name="line.634"></a> +<span class="sourceLineNo">635</span><a name="line.635"></a> +<span class="sourceLineNo">636</span> /**<a name="line.636"></a> +<span class="sourceLineNo">637</span> * <p>Perform <code>numTests</code> idle object eviction tests, evicting<a name="line.637"></a> +<span class="sourceLineNo">638</span> * examined objects that meet the criteria for eviction. If<a name="line.638"></a> +<span class="sourceLineNo">639</span> * <code>testWhileIdle</code> is true, examined objects are validated<a name="line.639"></a> +<span class="sourceLineNo">640</span> * when visited (and removed if invalid); otherwise only objects that<a name="line.640"></a> +<span class="sourceLineNo">641</span> * have been idle for more than <code>minEvicableIdleTimeMillis</code><a name="line.641"></a> +<span class="sourceLineNo">642</span> * are removed.</p><a name="line.642"></a> +<span class="sourceLineNo">643</span> *<a name="line.643"></a> +<span class="sourceLineNo">644</span> * @throws Exception when there is a problem evicting idle objects.<a name="line.644"></a> +<span class="sourceLineNo">645</span> */<a name="line.645"></a> +<span class="sourceLineNo">646</span> public abstract void evict() throws Exception;<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> * Returns the {@link EvictionPolicy} defined for this pool.<a name="line.649"></a> +<span class="sourceLineNo">650</span> * @return the eviction policy<a name="line.650"></a> +<span class="sourceLineNo">651</span> */<a name="line.651"></a> +<span class="sourceLineNo">652</span> final EvictionPolicy<T> getEvictionPolicy() {<a name="line.652"></a> +<span class="sourceLineNo">653</span> return evictionPolicy;<a name="line.653"></a> +<span class="sourceLineNo">654</span> }<a name="line.654"></a> +<span class="sourceLineNo">655</span><a name="line.655"></a> +<span class="sourceLineNo">656</span> /**<a name="line.656"></a> +<span class="sourceLineNo">657</span> * Verifies that the pool is open.<a name="line.657"></a> +<span class="sourceLineNo">658</span> * @throws IllegalStateException if the pool is closed.<a name="line.658"></a> +<span class="sourceLineNo">659</span> */<a name="line.659"></a> +<span class="sourceLineNo">660</span> final void assertOpen() throws IllegalStateException {<a name="line.660"></a> +<span class="sourceLineNo">661</span> if (isClosed()) {<a name="line.661"></a> +<span class="sourceLineNo">662</span> throw new IllegalStateException("Pool not open");<a name="line.662"></a> +<span class="sourceLineNo">663</span> }<a name="line.663"></a> +<span class="sourceLineNo">664</span> }<a name="line.664"></a> +<span class="sourceLineNo">665</span><a name="line.665"></a> +<span class="sourceLineNo">666</span> /**<a name="line.666"></a> +<span class="sourceLineNo">667</span> * <p>Starts the evictor with the given delay. If there is an evictor<a name="line.667"></a> +<span class="sourceLineNo">668</span> * running when this method is called, it is stopped and replaced with a<a name="line.668"></a> +<span class="sourceLineNo">669</span> * new evictor with the specified delay.</p><a name="line.669"></a> +<span class="sourceLineNo">670</span> *<a name="line.670"></a> +<span class="sourceLineNo">671</span> * <p>This method needs to be final, since it is called from a constructor.<a name="line.671"></a> +<span class="sourceLineNo">672</span> * See POOL-195.</p><a name="line.672"></a> +<span class="sourceLineNo">673</span> *<a name="line.673"></a> +<span class="sourceLineNo">674</span> * @param delay time in milliseconds before start and between eviction runs<a name="line.674"></a> +<span class="sourceLineNo">675</span> */<a name="line.675"></a> +<span class="sourceLineNo">676</span> final void startEvictor(long delay) {<a name="line.676"></a> +<span class="sourceLineNo">677</span> synchronized (evictionLock) {<a name="line.677"></a> +<span class="sourceLineNo">678</span> if (null != evictor) {<a name="line.678"></a> +<span class="sourceLineNo">679</span> EvictionTimer.cancel(evictor);<a name="line.679"></a> +<span class="sourceLineNo">680</span> evictor = null;<a name="line.680"></a> +<span class="sourceLineNo">681</span> evictionIterator = null;<a name="line.681"></a> +<span class="sourceLineNo">682</span> }<a name="line.682"></a> +<span class="sourceLineNo">683</span> if (delay > 0) {<a name="line.683"></a> +<span class="sourceLineNo">684</span> evictor = new Evictor();<a name="line.684"></a> +<span class="sourceLineNo">685</span> EvictionTimer.schedule(evictor, delay, delay);<a name="line.685"></a> +<span class="sourceLineNo">686</span> }<a name="line.686"></a> +<span class="sourceLineNo">687</span> }<a name="line.687"></a> +<span class="sourceLineNo">688</span> }<a name="line.688"></a> +<span class="sourceLineNo">689</span><a name="line.689"></a> +<span class="sourceLineNo">690</span> /**<a name="line.690"></a> +<span class="sourceLineNo">691</span> * Tries to ensure that the configured minimum number of idle instances are<a name="line.691"></a> +<span class="sourceLineNo">692</span> * available in the pool.<a name="line.692"></a> +<span class="sourceLineNo">693</span> * @throws Exception if an error occurs creating idle instances<a name="line.693"></a> +<span class="sourceLineNo">694</span> */<a name="line.694"></a> +<span class="sourceLineNo">695</span> abstract void ensureMinIdle() throws Exception;<a name="line.695"></a> +<span class="sourceLineNo">696</span><a name="line.696"></a> +<span class="sourceLineNo">697</span><a name="line.697"></a> +<span class="sourceLineNo">698</span> // Monitoring (primarily JMX) related methods<a name="line.698"></a> +<span class="sourceLineNo">699</span><a name="line.699"></a> +<span class="sourceLineNo">700</span> /**<a name="line.700"></a> +<span class="sourceLineNo">701</span> * Provides the name under which the pool has been registered with the<a name="line.701"></a> +<span class="sourceLineNo">702</span> * platform MBean server or <code>null</code> if the pool has not been<a name="line.702"></a> +<span class="sourceLineNo">703</span> * registered.<a name="line.703"></a> +<span class="sourceLineNo">704</span> * @return the JMX name<a name="line.704"></a> +<span class="sourceLineNo">705</span> */<a name="line.705"></a> +<span class="sourceLineNo">706</span> public final ObjectName getJmxName() {<a name="line.706"></a> +<span class="sourceLineNo">707</span> return oname;<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 name="line.710"></a> +<span class="sourceLineNo">711</span> * Provides the stack trace for the call that created this pool. JMX<a name="line.711"></a> +<span class="sourceLineNo">712</span> * registration may trigger a memory leak so it is important that pools are<a name="line.712"></a> +<span class="sourceLineNo">713</span> * deregistered when no longer used by calling the {@link #close()} method.<a name="line.713"></a> +<span class="sourceLineNo">714</span> * This method is provided to assist with identifying code that creates but<a name="line.714"></a> +<span class="sourceLineNo">715</span> * does not close it thereby creating a memory leak.<a name="line.715"></a> +<span class="sourceLineNo">716</span> * @return pool creation stack trace<a name="line.716"></a> +<span class="sourceLineNo">717</span> */<a name="line.717"></a> +<span class="sourceLineNo">718</span> public final String getCreationStackTrace() {<a name="line.718"></a> +<span class="sourceLineNo">719</span> return creationStackTrace;<a name="line.719"></a> +<span class="sourceLineNo">720</span> }<a name="line.720"></a> +<span class="sourceLineNo">721</span><a name="line.721"></a> +<span class="sourceLineNo">722</span> /**<a name="line.722"></a> +<span class="sourceLineNo">723</span> * The total number of objects successfully borrowed from this pool over the<a name="line.723"></a> +<span class="sourceLineNo">724</span> * lifetime of the pool.<a name="line.724"></a> +<span class="sourceLineNo">725</span> * @return the borrowed object count<a name="line.725"></a> +<span class="sourceLineNo">726</span> */<a name="line.726"></a> +<span class="sourceLineNo">727</span> public final long getBorrowedCount() {<a name="line.727"></a> +<span class="sourceLineNo">728</span> return borrowedCount.get();<a name="line.728"></a> +<span class="sourceLineNo">729</span> }<a name="line.729"></a> +<span class="sourceLineNo">730</span><a name="line.730"></a> +<span class="sourceLineNo">731</span> /**<a name="line.731"></a> +<span class="sourceLineNo">732</span> * The total number of objects returned to this pool over the lifetime of<a name="line.732"></a> +<span class="sourceLineNo">733</span> * the pool. This excludes attempts to return the same object multiple<a name="line.733"></a> +<span class="sourceLineNo">734</span> * times.<a name="line.734"></a> +<span class="sourceLineNo">735</span> * @return the returned object count<a name="line.735"></a> +<span class="sourceLineNo">736</span> */<a name="line.736"></a> +<span class="sourceLineNo">737</span> public final long getReturnedCount() {<a name="line.737"></a> +<span class="sourceLineNo">738</span> return returnedCount.get();<a name="line.738"></a> +<span class="sourceLineNo">739</span> }<a name="line.739"></a> +<span class="sourceLineNo">740</span><a name="line.740"></a> +<span class="sourceLineNo">741</span> /**<a name="line.741"></a> +<span class="sourceLineNo">742</span> * The total number of objects created for this pool over the lifetime of<a name="line.742"></a> +<span class="sourceLineNo">743</span> * the pool.<a name="line.743"></a> +<span class="sourceLineNo">744</span> * @return the created object count<a name="line.744"></a> +<span class="sourceLineNo">745</span> */<a name="line.745"></a> +<span class="sourceLineNo">746</span> public final long getCreatedCount() {<a name="line.746"></a> +<span class="sourceLineNo">747</span> return createdCount.get();<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> /**<a name="line.750"></a> +<span class="sourceLineNo">751</span> * The total number of objects destroyed by this pool over the lifetime of<a name="line.751"></a> +<span class="sourceLineNo">752</span> * the pool.<a name="line.752"></a> +<span class="sourceLineNo">753</span> * @return the destroyed object count<a name="line.753"></a> +<span class="sourceLineNo">754</span> */<a name="line.754"></a> +<span class="sourceLineNo">755</span> public final long getDestroyedCount() {<a name="line.755"></a> +<span class="sourceLineNo">756</span> return destroyedCount.get();<a name="line.756"></a> +<span class="sourceLineNo">757</span> }<a name="line.757"></a> +<span class="sourceLineNo">758</span><a name="line.758"></a> +<span class="sourceLineNo">759</span> /**<a name="line.759"></a> +<span class="sourceLineNo">760</span> * The total number of objects destroyed by the evictor associated with this<a name="line.760"></a> +<span class="sourceLineNo">761</span> * pool over the lifetime of the pool.<a name="line.761"></a> +<span class="sourceLineNo">762</span> * @return the evictor destroyed object count<a name="line.762"></a> +<span class="sourceLineNo">763</span> */<a name="line.763"></a> +<span class="sourceLineNo">764</span> public final long getDestroyedByEvictorCount() {<a name="line.764"></a> +<span class="sourceLineNo">765</span> return destroyedByEvictorCount.get();<a name="line.765"></a> +<span class="sourceLineNo">766</span> }<a name="line.766"></a> +<span class="sourceLineNo">767</span><a name="line.767"></a> +<span class="sourceLineNo">768</span> /**<a name="line.768"></a> +<span class="sourceLineNo">769</span> * The total number of objects destroyed by this pool as a result of failing<a name="line.769"></a> +<span class="sourceLineNo">770</span> * validation during <code>borrowObject()</code> over the lifetime of the<a name="line.770"></a> +<span class="sourceLineNo">771</span> * pool.<a name="line.771"></a> +<span class="sourceLineNo">772</span> * @return validation destroyed object count<a name="line.772"></a> +<span class="sourceLineNo">773</span> */<a name="line.773"></a> +<span class="sourceLineNo">774</span> public final long getDestroyedByBorrowValidationCount() {<a name="line.774"></a> +<span class="sourceLineNo">775</span> return destroyedByBorrowValidationCount.get();<a name="line.775"></a> +<span class="sourceLineNo">776</span> }<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> * The mean time objects are active for based on the last {@link<a name="line.779"></a> +<span class="sourceLineNo">780</span> * #MEAN_TIMING_STATS_CACHE_SIZE} objects returned to the pool.<a name="line.780"></a> +<span class="sourceLineNo">781</span> * @return mean time an object has been checked out from the pool among<a name="line.781"></a> +<span class="sourceLineNo">782</span> * recently returned objects<a name="line.782"></a> +<span class="sourceLineNo">783</span> */<a name="line.783"></a> +<span class="sourceLineNo">784</span> public final long getMeanActiveTimeMillis() {<a name="line.784"></a> +<span class="sourceLineNo">785</span> return activeTimes.getMean();<a name="line.785"></a> +<span class="sourceLineNo">786</span> }<a name="line.786"></a> +<span class="sourceLineNo">787</span><a name="line.787"></a> +<span class="sourceLineNo">788</span> /**<a name="line.788"></a> +<span class="sourceLineNo">789</span> * The mean time objects are idle for based on the last {@link<a name="line.789"></a> +<span class="sourceLineNo">790</span> * #MEAN_TIMING_STATS_CACHE_SIZE} objects borrowed from the pool.<a name="line.790"></a> +<span class="sourceLineNo">791</span> * @return mean time an object has been idle in the pool among recently<a name="line.791"></a> +<span class="sourceLineNo">792</span> * borrowed objects<a name="line.792"></a> +<span class="sourceLineNo">793</span> */<a name="line.793"></a> +<span class="sourceLineNo">794</span> public final long getMeanIdleTimeMillis() {<a name="line.794"></a> +<span class="sourceLineNo">795</span> return idleTimes.getMean();<a name="line.795"></a> +<span class="sourceLineNo">796</span> }<a name="line.796"></a> +<span class="sourceLineNo">797</span><a name="line.797"></a> +<span class="sourceLineNo">798</span> /**<a name="line.798"></a> +<span class="sourceLineNo">799</span> * The mean time threads wait to borrow an object based on the last {@link<a name="line.799"></a> +<span class="sourceLineNo">800</span> * #MEAN_TIMING_STATS_CACHE_SIZE} objects borrowed from the pool.<a name="line.800"></a> +<span class="sourceLineNo">801</span> * @return mean time in milliseconds that a recently served thread has had<a name="line.801"></a> +<span class="sourceLineNo">802</span> * to wait to borrow an object from the pool<a name="line.802"></a> +<span class="sourceLineNo">803</span> */<a name="line.803"></a> +<span class="sourceLineNo">804</span> public final long getMeanBorrowWaitTimeMillis() {<a name="line.804"></a> +<span class="sourceLineNo">805</span> return waitTimes.getMean();<a name="line.805"></a> +<span class="sourceLineNo">806</span> }<a name="line.806"></a> +<span class="sourceLineNo">807</span><a name="line.807"></a> +<span class="sourceLineNo">808</span> /**<a name="line.808"></a> +<span class="sourceLineNo">809</span> * The maximum time a thread has waited to borrow objects from the pool.<a name="line.809"></a> +<span class="sourceLineNo">810</span> * @return maximum wait time in milliseconds since the pool was created<a name="line.810"></a> +<span class="sourceLineNo">811</span> */<a name="line.811"></a> +<span class="sourceLineNo">812</span> public final long getMaxBorrowWaitTimeMillis() {<a name="line.812"></a> +<span class="sourceLineNo">813</span> return maxBorrowWaitTimeMillis.get();<a name="line.813"></a> +<span class="sourceLineNo">814</span> }<a name="line.814"></a> +<span class="sourceLineNo">815</span><a name="line.815"></a> +<span class="sourceLineNo">816</span> /**<a name="line.816"></a> +<span class="sourceLineNo">817</span> * The number of instances currently idle in this pool.<a name="line.817"></a> +<span class="sourceLineNo">818</span> * @return count of instances available for checkout from the pool<a name="line.818"></a> +<span class="sourceLineNo">819</span> */<a name="line.819"></a> +<span class="sourceLineNo">820</span> public abstract int getNumIdle();<a name="line.820"></a> +<span class="sourceLineNo">821</span><a name="line.821"></a> +<span class="sourceLineNo">822</span> /**<a name="line.822"></a> +<span class="sourceLineNo">823</span> * The listener used (if any) to receive notifications of exceptions<a name="line.823"></a> +<span class="sourceLineNo">824</span> * unavoidably swallowed by the pool.<a name="line.824"></a> +<span class="sourceLineNo">825</span> *<a name="line.825"></a> +<span class="sourceLineNo">826</span> * @return The listener or <code>null</code> for no listener<a name="line.826"></a> +<span class="sourceLineNo">827</span> */<a name="line.827"></a> +<span class="sourceLineNo">828</span> public final SwallowedExceptionListener getSwallowedExceptionListener() {<a name="line.828"></a> +<span class="sourceLineNo">829</span> return swallowedExceptionListener;<a name="line.829"></a> +<span class="sourceLineNo">830</span> }<a name="line.830"></a> +<span class="sourceLineNo">831</span><a name="line.831"></a> +<span class="sourceLineNo">832</span> /**<a name="line.832"></a> +<span class="sourceLineNo">833</span> * The listener used (if any) to receive notifications of exceptions<a name="line.833"></a> +<span class="sourceLineNo">834</span> * unavoidably swallowed by the pool.<a name="line.834"></a> +<span class="sourceLineNo">835</span> *<a name="line.835"></a> +<span class="sourceLineNo">836</span> * @param swallowedExceptionListener The listener or <code>null</code><a name="line.836"></a> +<span class="sourceLineNo">837</span> * for no listener<a name="line.837"></a> +<span class="sourceLineNo">838</span> */<a name="line.838"></a> +<span class="sourceLineNo">839</span> public final void setSwallowedExceptionListener(<a name="line.839"></a> +<span class="sourceLineNo">840</span> SwallowedExceptionListener swallowedExceptionListener) {<a name="line.840"></a> +<span class="sourceLineNo">841</span> this.swallowedExceptionListener = swallowedExceptionListener;<a name="line.841"></a> +<span class="sourceLineNo">842</span> }<a name="line.842"></a> +<span class="sourceLineNo">843</span><a name="line.843"></a> +<span class="sourceLineNo">844</span> /**<a name="line.844"></a> +<span class="sourceLineNo">845</span> * Swallows an exception and notifies the configured listener for swallowed<a name="line.845"></a> +<span class="sourceLineNo">846</span> * exceptions queue.<a name="line.846"></a> +<span class="sourceLineNo">847</span> *<a name="line.847"></a> +<span class="sourceLineNo">848</span> * @param e exception to be swallowed<a name="line.848"></a> +<span class="sourceLineNo">849</span> */<a name="line.849"></a> +<span class="sourceLineNo">850</span> final void swallowException(Exception e) {<a name="line.850"></a> +<span class="sourceLineNo">851</span> SwallowedExceptionListener listener = getSwallowedExceptionListener();<a name="line.851"></a> +<span class="sourceLineNo">852</span><a name="line.852"></a> +<span class="sourceLineNo">853</span> if (listener == null) {<a name="line.853"></a> +<span class="sourceLineNo">854</span> return;<a name="line.854"></a> +<span class="sourceLineNo">855</span> }<a name="line.855"></a> +<span class="sourceLineNo">856</span><a name="line.856"></a> +<span class="sourceLineNo">857</span> try {<a name="line.857"></a> +<span class="sourceLineNo">858</span> listener.onSwallowException(e);<a name="line.858"></a> +<span class="sourceLineNo">859</span> } catch (OutOfMemoryError oome) {<a name="line.859"></a> +<span class="sourceLineNo">860</span> throw oome;<a name="line.860"></a> +<span class="sourceLineNo">861</span> } catch (VirtualMachineError vme) {<a name="line.861"></a> +<span class="sourceLineNo">862</span> throw vme;<a name="line.862"></a> +<span class="sourceLineNo">863</span> } catch (Throwable t) {<a name="line.863"></a> +<span class="sourceLineNo">864</span> // Ignore. Enjoy the irony.<a name="line.864"></a> +<span class="sourceLineNo">865</span> }<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> * Updates statistics after an object is borrowed from the pool.<a name="line.869"></a> +<span class="sourceLineNo">870</span> * @param p object borrowed from the pool<a name="line.870"></a> +<span class="sourceLineNo">871</span> * @param waitTime time (in milliseconds) that the borrowing thread had to wait<a name="line.871"></a> +<span class="sourceLineNo">872</span> */<a name="line.872"></a> +<span class="sourceLineNo">873</span> final void updateStatsBorrow(PooledObject<T> p, long waitTime) {<a name="line.873"></a> +<span class="sourceLineNo">874</span> borrowedCount.incrementAndGet();<a name="line.874"></a> +<span class="sourceLineNo">875</span> idleTimes.add(p.getIdleTimeMillis());<a name="line.875"></a> +<span class="sourceLineNo">876</span> waitTimes.add(waitTime);<a name="line.876"></a> +<span class="sourceLineNo">877</span><a name="line.877"></a> +<span class="sourceLineNo">878</span> // lock-free optimistic-locking maximum<a name="line.878"></a> +<span class="sourceLineNo">879</span> long currentMax;<a name="line.879"></a> +<span class="sourceLineNo">880</span> do {<a name="line.880"></a> +<span class="sourceLineNo">881</span> currentMax = maxBorrowWaitTimeMillis.get();<a name="line.881"></a> +<span class="sourceLineNo">882</span> if (currentMax >= waitTime) {<a name="line.882"></a> +<span class="sourceLineNo">883</span> break;<a name="line.883"></a> +<span class="sourceLineNo">884</span> }<a name="line.884"></a> +<span class="sourceLineNo">885</span> } while (!maxBorrowWaitTimeMillis.compareAndSet(currentMax, waitTime));<a name="line.885"></a> +<span class="sourceLineNo">886</span> }<a name="line.886"></a> +<span class="sourceLineNo">887</span><a name="line.887"></a> +<span class="sourceLineNo">888</span> /**<a name="line.888"></a>
[... 281 lines stripped ...]
