Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PoolUtils.html
------------------------------------------------------------------------------
svn:eol-style = native
Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObject.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObject.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObject.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,280 @@
+<!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.io.PrintWriter;<a
name="line.19"></a>
+<span class="sourceLineNo">020</span>import java.util.Deque;<a
name="line.20"></a>
+<span class="sourceLineNo">021</span><a name="line.21"></a>
+<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * Defines the wrapper that is used to
track the additional information, such as<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * state, for the pooled objects.<a
name="line.24"></a>
+<span class="sourceLineNo">025</span> * <p><a name="line.25"></a>
+<span class="sourceLineNo">026</span> * Implementations of this class are
required to be thread-safe.<a name="line.26"></a>
+<span class="sourceLineNo">027</span> *<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * @param <T> the type of object in
the pool<a name="line.28"></a>
+<span class="sourceLineNo">029</span> *<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * @version $Revision: $<a
name="line.30"></a>
+<span class="sourceLineNo">031</span> *<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * @since 2.0<a name="line.32"></a>
+<span class="sourceLineNo">033</span> */<a name="line.33"></a>
+<span class="sourceLineNo">034</span>public interface PooledObject<T>
extends Comparable<PooledObject<T>> {<a name="line.34"></a>
+<span class="sourceLineNo">035</span><a name="line.35"></a>
+<span class="sourceLineNo">036</span> /**<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * Obtain the underlying object that
is wrapped by this instance of<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * {@link PooledObject}.<a
name="line.38"></a>
+<span class="sourceLineNo">039</span> *<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * @return The wrapped object<a
name="line.40"></a>
+<span class="sourceLineNo">041</span> */<a name="line.41"></a>
+<span class="sourceLineNo">042</span> T getObject();<a name="line.42"></a>
+<span class="sourceLineNo">043</span><a name="line.43"></a>
+<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * Obtain the time (using the same
basis as<a name="line.45"></a>
+<span class="sourceLineNo">046</span> * {@link
System#currentTimeMillis()}) that this object was created.<a name="line.46"></a>
+<span class="sourceLineNo">047</span> *<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * @return The creation time for the
wrapped object<a name="line.48"></a>
+<span class="sourceLineNo">049</span> */<a name="line.49"></a>
+<span class="sourceLineNo">050</span> long getCreateTime();<a
name="line.50"></a>
+<span class="sourceLineNo">051</span><a name="line.51"></a>
+<span class="sourceLineNo">052</span> /**<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * Obtain the time in milliseconds
that this object last spent in the the<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * active state (it may still be
active in which case subsequent calls will<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * return an increased value).<a
name="line.55"></a>
+<span class="sourceLineNo">056</span> *<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * @return The time in milliseconds
last spent in the active state<a name="line.57"></a>
+<span class="sourceLineNo">058</span> */<a name="line.58"></a>
+<span class="sourceLineNo">059</span> long getActiveTimeMillis();<a
name="line.59"></a>
+<span class="sourceLineNo">060</span><a name="line.60"></a>
+<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * Obtain the time in milliseconds
that this object last spend in the the<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * idle state (it may still be idle
in which case subsequent calls will<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * return an increased value).<a
name="line.64"></a>
+<span class="sourceLineNo">065</span> *<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * @return The time in milliseconds
last spent in the idle state<a name="line.66"></a>
+<span class="sourceLineNo">067</span> */<a name="line.67"></a>
+<span class="sourceLineNo">068</span> long getIdleTimeMillis();<a
name="line.68"></a>
+<span class="sourceLineNo">069</span><a name="line.69"></a>
+<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * Obtain the time the wrapped object
was last borrowed.<a name="line.71"></a>
+<span class="sourceLineNo">072</span> *<a name="line.72"></a>
+<span class="sourceLineNo">073</span> * @return The time the object was
last borrowed<a name="line.73"></a>
+<span class="sourceLineNo">074</span> */<a name="line.74"></a>
+<span class="sourceLineNo">075</span> long getLastBorrowTime();<a
name="line.75"></a>
+<span class="sourceLineNo">076</span><a name="line.76"></a>
+<span class="sourceLineNo">077</span> /**<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * Obtain the time the wrapped object
was last returned.<a name="line.78"></a>
+<span class="sourceLineNo">079</span> *<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * @return The time the object was
last returned<a name="line.80"></a>
+<span class="sourceLineNo">081</span> */<a name="line.81"></a>
+<span class="sourceLineNo">082</span> long getLastReturnTime();<a
name="line.82"></a>
+<span class="sourceLineNo">083</span><a name="line.83"></a>
+<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * Return an estimate of the last
time this object was used. If the class<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * of the pooled object implements
{@link TrackedUse}, what is returned is<a name="line.86"></a>
+<span class="sourceLineNo">087</span> * the maximum of {@link
TrackedUse#getLastUsed()} and<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * {@link #getLastBorrowTime()};
otherwise this method gives the same<a name="line.88"></a>
+<span class="sourceLineNo">089</span> * value as {@link
#getLastBorrowTime()}.<a name="line.89"></a>
+<span class="sourceLineNo">090</span> *<a name="line.90"></a>
+<span class="sourceLineNo">091</span> * @return the last time this object
was used<a name="line.91"></a>
+<span class="sourceLineNo">092</span> */<a name="line.92"></a>
+<span class="sourceLineNo">093</span> long getLastUsedTime();<a
name="line.93"></a>
+<span class="sourceLineNo">094</span><a name="line.94"></a>
+<span class="sourceLineNo">095</span> /**<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * Orders instances based on idle
time - i.e. the length of time since the<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * instance was returned to the pool.
Used by the GKOP idle object evictor.<a name="line.97"></a>
+<span class="sourceLineNo">098</span> *<p><a name="line.98"></a>
+<span class="sourceLineNo">099</span> * Note: This class has a natural
ordering that is inconsistent with<a name="line.99"></a>
+<span class="sourceLineNo">100</span> * equals if distinct objects
have the same identity hash code.<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * <p><a name="line.101"></a>
+<span class="sourceLineNo">102</span> * {@inheritDoc}<a
name="line.102"></a>
+<span class="sourceLineNo">103</span> */<a name="line.103"></a>
+<span class="sourceLineNo">104</span> @Override<a name="line.104"></a>
+<span class="sourceLineNo">105</span> int compareTo(PooledObject<T>
other);<a name="line.105"></a>
+<span class="sourceLineNo">106</span><a name="line.106"></a>
+<span class="sourceLineNo">107</span> @Override<a name="line.107"></a>
+<span class="sourceLineNo">108</span> boolean equals(Object obj);<a
name="line.108"></a>
+<span class="sourceLineNo">109</span><a name="line.109"></a>
+<span class="sourceLineNo">110</span> @Override<a name="line.110"></a>
+<span class="sourceLineNo">111</span> int hashCode();<a name="line.111"></a>
+<span class="sourceLineNo">112</span><a name="line.112"></a>
+<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
+<span class="sourceLineNo">114</span> * Provides a String form of the
wrapper for debug purposes. The format is<a name="line.114"></a>
+<span class="sourceLineNo">115</span> * not fixed and may change at any
time.<a name="line.115"></a>
+<span class="sourceLineNo">116</span> * <p><a name="line.116"></a>
+<span class="sourceLineNo">117</span> * {@inheritDoc}<a
name="line.117"></a>
+<span class="sourceLineNo">118</span> */<a name="line.118"></a>
+<span class="sourceLineNo">119</span> @Override<a name="line.119"></a>
+<span class="sourceLineNo">120</span> String toString();<a
name="line.120"></a>
+<span class="sourceLineNo">121</span><a name="line.121"></a>
+<span class="sourceLineNo">122</span> /**<a name="line.122"></a>
+<span class="sourceLineNo">123</span> * Attempt to place the pooled object
in the<a name="line.123"></a>
+<span class="sourceLineNo">124</span> * {@link PooledObjectState#EVICTION}
state.<a name="line.124"></a>
+<span class="sourceLineNo">125</span> *<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * @return
<code>true</code> if the object was placed in the<a
name="line.126"></a>
+<span class="sourceLineNo">127</span> * {@link
PooledObjectState#EVICTION} state otherwise<a name="line.127"></a>
+<span class="sourceLineNo">128</span> *
<code>false</code><a name="line.128"></a>
+<span class="sourceLineNo">129</span> */<a name="line.129"></a>
+<span class="sourceLineNo">130</span> boolean startEvictionTest();<a
name="line.130"></a>
+<span class="sourceLineNo">131</span><a name="line.131"></a>
+<span class="sourceLineNo">132</span> /**<a name="line.132"></a>
+<span class="sourceLineNo">133</span> * Called to inform the object that
the eviction test has ended.<a name="line.133"></a>
+<span class="sourceLineNo">134</span> *<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * @param idleQueue The queue of idle
objects to which the object should be<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * returned<a
name="line.136"></a>
+<span class="sourceLineNo">137</span> *<a name="line.137"></a>
+<span class="sourceLineNo">138</span> * @return Currently not used<a
name="line.138"></a>
+<span class="sourceLineNo">139</span> */<a name="line.139"></a>
+<span class="sourceLineNo">140</span> boolean
endEvictionTest(Deque<PooledObject<T>> idleQueue);<a
name="line.140"></a>
+<span class="sourceLineNo">141</span><a name="line.141"></a>
+<span class="sourceLineNo">142</span> /**<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * Allocates the object.<a
name="line.143"></a>
+<span class="sourceLineNo">144</span> *<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * @return {@code true} if the
original state was {@link PooledObjectState#IDLE IDLE}<a name="line.145"></a>
+<span class="sourceLineNo">146</span> */<a name="line.146"></a>
+<span class="sourceLineNo">147</span> boolean allocate();<a
name="line.147"></a>
+<span class="sourceLineNo">148</span><a name="line.148"></a>
+<span class="sourceLineNo">149</span> /**<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * Deallocates the object and sets it
{@link PooledObjectState#IDLE IDLE}<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * if it is currently {@link
PooledObjectState#ALLOCATED ALLOCATED}.<a name="line.151"></a>
+<span class="sourceLineNo">152</span> *<a name="line.152"></a>
+<span class="sourceLineNo">153</span> * @return {@code true} if the state
was {@link PooledObjectState#ALLOCATED ALLOCATED}<a name="line.153"></a>
+<span class="sourceLineNo">154</span> */<a name="line.154"></a>
+<span class="sourceLineNo">155</span> boolean deallocate();<a
name="line.155"></a>
+<span class="sourceLineNo">156</span><a name="line.156"></a>
+<span class="sourceLineNo">157</span> /**<a name="line.157"></a>
+<span class="sourceLineNo">158</span> * Sets the state to {@link
PooledObjectState#INVALID INVALID}<a name="line.158"></a>
+<span class="sourceLineNo">159</span> */<a name="line.159"></a>
+<span class="sourceLineNo">160</span> void invalidate();<a
name="line.160"></a>
+<span class="sourceLineNo">161</span><a name="line.161"></a>
+<span class="sourceLineNo">162</span> /**<a name="line.162"></a>
+<span class="sourceLineNo">163</span> * Is abandoned object tracking being
used? If this is true the<a name="line.163"></a>
+<span class="sourceLineNo">164</span> * implementation will need to record
the stack trace of the last caller to<a name="line.164"></a>
+<span class="sourceLineNo">165</span> * borrow this object.<a
name="line.165"></a>
+<span class="sourceLineNo">166</span> *<a name="line.166"></a>
+<span class="sourceLineNo">167</span> * @param logAbandoned The new
configuration setting for abandoned<a name="line.167"></a>
+<span class="sourceLineNo">168</span> * object
tracking<a name="line.168"></a>
+<span class="sourceLineNo">169</span> */<a name="line.169"></a>
+<span class="sourceLineNo">170</span> void setLogAbandoned(boolean
logAbandoned);<a name="line.170"></a>
+<span class="sourceLineNo">171</span><a name="line.171"></a>
+<span class="sourceLineNo">172</span> /**<a name="line.172"></a>
+<span class="sourceLineNo">173</span> * Record the current stack trace as
the last time the object was used.<a name="line.173"></a>
+<span class="sourceLineNo">174</span> */<a name="line.174"></a>
+<span class="sourceLineNo">175</span> void use();<a name="line.175"></a>
+<span class="sourceLineNo">176</span><a name="line.176"></a>
+<span class="sourceLineNo">177</span> /**<a name="line.177"></a>
+<span class="sourceLineNo">178</span> * Prints the stack trace of the code
that borrowed this pooled object and<a name="line.178"></a>
+<span class="sourceLineNo">179</span> * the stack trace of the last code
to use this object (if available) to<a name="line.179"></a>
+<span class="sourceLineNo">180</span> * the supplied writer.<a
name="line.180"></a>
+<span class="sourceLineNo">181</span> *<a name="line.181"></a>
+<span class="sourceLineNo">182</span> * @param writer The destination
for the debug output<a name="line.182"></a>
+<span class="sourceLineNo">183</span> */<a name="line.183"></a>
+<span class="sourceLineNo">184</span> void printStackTrace(PrintWriter
writer);<a name="line.184"></a>
+<span class="sourceLineNo">185</span><a name="line.185"></a>
+<span class="sourceLineNo">186</span> /**<a name="line.186"></a>
+<span class="sourceLineNo">187</span> * Returns the state of this
object.<a name="line.187"></a>
+<span class="sourceLineNo">188</span> * @return state<a
name="line.188"></a>
+<span class="sourceLineNo">189</span> */<a name="line.189"></a>
+<span class="sourceLineNo">190</span> PooledObjectState getState();<a
name="line.190"></a>
+<span class="sourceLineNo">191</span><a name="line.191"></a>
+<span class="sourceLineNo">192</span> /**<a name="line.192"></a>
+<span class="sourceLineNo">193</span> * Marks the pooled object as
abandoned.<a name="line.193"></a>
+<span class="sourceLineNo">194</span> */<a name="line.194"></a>
+<span class="sourceLineNo">195</span> void markAbandoned();<a
name="line.195"></a>
+<span class="sourceLineNo">196</span><a name="line.196"></a>
+<span class="sourceLineNo">197</span> /**<a name="line.197"></a>
+<span class="sourceLineNo">198</span> * Marks the object as returning to
the pool.<a name="line.198"></a>
+<span class="sourceLineNo">199</span> */<a name="line.199"></a>
+<span class="sourceLineNo">200</span> void markReturning();<a
name="line.200"></a>
+<span class="sourceLineNo">201</span><a name="line.201"></a>
+<span class="sourceLineNo">202</span> // TODO: Uncomment this for version 3
(can't add it to 2.x as it will break<a name="line.202"></a>
+<span class="sourceLineNo">203</span> // API compatibility)<a
name="line.203"></a>
+<span class="sourceLineNo">204</span> ///**<a name="line.204"></a>
+<span class="sourceLineNo">205</span> // * Get the number of times this
object has been borrowed.<a name="line.205"></a>
+<span class="sourceLineNo">206</span> // */<a name="line.206"></a>
+<span class="sourceLineNo">207</span> //long getBorrowedCount();<a
name="line.207"></a>
+<span class="sourceLineNo">208</span>}<a name="line.208"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObject.html
------------------------------------------------------------------------------
svn:eol-style = native
Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObjectFactory.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObjectFactory.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObjectFactory.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,211 @@
+<!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>/**<a name="line.19"></a>
+<span class="sourceLineNo">020</span> * An interface defining life-cycle
methods for instances to be served by an<a name="line.20"></a>
+<span class="sourceLineNo">021</span> * {@link ObjectPool}.<a
name="line.21"></a>
+<span class="sourceLineNo">022</span> * <p><a name="line.22"></a>
+<span class="sourceLineNo">023</span> * By contract, when an {@link
ObjectPool} delegates to a<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * {@link PooledObjectFactory},<a
name="line.24"></a>
+<span class="sourceLineNo">025</span> * <ol><a name="line.25"></a>
+<span class="sourceLineNo">026</span> * <li><a name="line.26"></a>
+<span class="sourceLineNo">027</span> * {@link #makeObject} is called
whenever a new instance is needed.<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * </li><a name="line.28"></a>
+<span class="sourceLineNo">029</span> * <li><a name="line.29"></a>
+<span class="sourceLineNo">030</span> * {@link #activateObject} is invoked
on every instance that has been<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * {@link #passivateObject passivated}
before it is<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * {@link ObjectPool#borrowObject
borrowed} from the pool.<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * </li><a name="line.33"></a>
+<span class="sourceLineNo">034</span> * <li><a name="line.34"></a>
+<span class="sourceLineNo">035</span> * {@link #validateObject} may be
invoked on {@link #activateObject activated}<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * instances to make sure they can be
{@link ObjectPool#borrowObject borrowed}<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * from the pool. {@link
#validateObject} may also be used to<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * test an instance being {@link
ObjectPool#returnObject returned} to the pool<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * before it is {@link #passivateObject
passivated}. It will only be invoked<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * on an activated instance.<a
name="line.40"></a>
+<span class="sourceLineNo">041</span> * </li><a name="line.41"></a>
+<span class="sourceLineNo">042</span> * <li><a name="line.42"></a>
+<span class="sourceLineNo">043</span> * {@link #passivateObject} is invoked
on every instance when it is returned<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * to the pool.<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * </li><a name="line.45"></a>
+<span class="sourceLineNo">046</span> * <li><a name="line.46"></a>
+<span class="sourceLineNo">047</span> * {@link #destroyObject} is invoked on
every instance when it is being<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * "dropped" from the pool (whether due
to the response from<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * {@link #validateObject}, or for
reasons specific to the pool<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * implementation.) There is no
guarantee that the instance being destroyed<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * will be considered active, passive
or in a generally consistent state.<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * </li><a name="line.52"></a>
+<span class="sourceLineNo">053</span> * </ol><a name="line.53"></a>
+<span class="sourceLineNo">054</span> * {@link PooledObjectFactory} must be
thread-safe. The only promise<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * an {@link ObjectPool} makes is that
the same instance of an object will not<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * be passed to more than one method of a
<code>PoolableObjectFactory</code><a name="line.56"></a>
+<span class="sourceLineNo">057</span> * at a time.<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * <p><a name="line.58"></a>
+<span class="sourceLineNo">059</span> * While clients of a {@link
KeyedObjectPool} borrow and return instances of<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * the underlying value type {@code V},
the factory methods act on instances of<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * {@link PooledObject
PooledObject&lt;V&gt;}. These are the object wrappers that<a
name="line.61"></a>
+<span class="sourceLineNo">062</span> * pools use to track and maintain state
information about the objects that<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * they manage.<a name="line.63"></a>
+<span class="sourceLineNo">064</span> *<a name="line.64"></a>
+<span class="sourceLineNo">065</span> * @param <T> Type of element
managed in this factory.<a name="line.65"></a>
+<span class="sourceLineNo">066</span> *<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * @see ObjectPool<a name="line.67"></a>
+<span class="sourceLineNo">068</span> *<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * @version $Revision: 1333925 $<a
name="line.69"></a>
+<span class="sourceLineNo">070</span> *<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * @since 2.0<a name="line.71"></a>
+<span class="sourceLineNo">072</span> */<a name="line.72"></a>
+<span class="sourceLineNo">073</span>public interface
PooledObjectFactory<T> {<a name="line.73"></a>
+<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * Create an instance that can be
served by the pool and wrap it in a<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * {@link PooledObject} to be managed
by the pool.<a name="line.76"></a>
+<span class="sourceLineNo">077</span> *<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * @return a {@code PooledObject}
wrapping an instance that can be served by the pool<a name="line.78"></a>
+<span class="sourceLineNo">079</span> *<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * @throws Exception if there is a
problem creating a new instance,<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * this will be propagated to the
code requesting an object.<a name="line.81"></a>
+<span class="sourceLineNo">082</span> */<a name="line.82"></a>
+<span class="sourceLineNo">083</span> PooledObject<T> makeObject()
throws Exception;<a name="line.83"></a>
+<span class="sourceLineNo">084</span><a name="line.84"></a>
+<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * Destroys an instance no longer
needed by the pool.<a name="line.86"></a>
+<span class="sourceLineNo">087</span> * <p><a name="line.87"></a>
+<span class="sourceLineNo">088</span> * It is important for implementations
of this method to be aware that there<a name="line.88"></a>
+<span class="sourceLineNo">089</span> * is no guarantee about what state
<code>obj</code> will be in and the<a name="line.89"></a>
+<span class="sourceLineNo">090</span> * implementation should be prepared to
handle unexpected errors.<a name="line.90"></a>
+<span class="sourceLineNo">091</span> * <p><a name="line.91"></a>
+<span class="sourceLineNo">092</span> * Also, an implementation must take in
to consideration that instances lost<a name="line.92"></a>
+<span class="sourceLineNo">093</span> * to the garbage collector may never
be destroyed.<a name="line.93"></a>
+<span class="sourceLineNo">094</span> * </p><a name="line.94"></a>
+<span class="sourceLineNo">095</span> *<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * @param p a {@code PooledObject}
wrapping the instance to be destroyed<a name="line.96"></a>
+<span class="sourceLineNo">097</span> *<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * @throws Exception should be avoided
as it may be swallowed by<a name="line.98"></a>
+<span class="sourceLineNo">099</span> * the pool implementation.<a
name="line.99"></a>
+<span class="sourceLineNo">100</span> *<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * @see #validateObject<a
name="line.101"></a>
+<span class="sourceLineNo">102</span> * @see ObjectPool#invalidateObject<a
name="line.102"></a>
+<span class="sourceLineNo">103</span> */<a name="line.103"></a>
+<span class="sourceLineNo">104</span> void
destroyObject(PooledObject<T> p) throws Exception;<a name="line.104"></a>
+<span class="sourceLineNo">105</span><a name="line.105"></a>
+<span class="sourceLineNo">106</span> /**<a name="line.106"></a>
+<span class="sourceLineNo">107</span> * Ensures that the instance is safe to
be returned by the pool.<a name="line.107"></a>
+<span class="sourceLineNo">108</span> *<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * @param p a {@code PooledObject}
wrapping the instance to be validated<a name="line.109"></a>
+<span class="sourceLineNo">110</span> *<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * @return
<code>false</code> if <code>obj</code> is not valid and
should<a name="line.111"></a>
+<span class="sourceLineNo">112</span> * be dropped from the pool,
<code>true</code> otherwise.<a name="line.112"></a>
+<span class="sourceLineNo">113</span> */<a name="line.113"></a>
+<span class="sourceLineNo">114</span> boolean
validateObject(PooledObject<T> p);<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> * Reinitialize an instance to be
returned by the pool.<a name="line.117"></a>
+<span class="sourceLineNo">118</span> *<a name="line.118"></a>
+<span class="sourceLineNo">119</span> * @param p a {@code PooledObject}
wrapping the instance to be activated<a name="line.119"></a>
+<span class="sourceLineNo">120</span> *<a name="line.120"></a>
+<span class="sourceLineNo">121</span> * @throws Exception if there is a
problem activating <code>obj</code>,<a name="line.121"></a>
+<span class="sourceLineNo">122</span> * this exception may be swallowed
by the pool.<a name="line.122"></a>
+<span class="sourceLineNo">123</span> *<a name="line.123"></a>
+<span class="sourceLineNo">124</span> * @see #destroyObject<a
name="line.124"></a>
+<span class="sourceLineNo">125</span> */<a name="line.125"></a>
+<span class="sourceLineNo">126</span> void
activateObject(PooledObject<T> p) throws Exception;<a name="line.126"></a>
+<span class="sourceLineNo">127</span><a name="line.127"></a>
+<span class="sourceLineNo">128</span> /**<a name="line.128"></a>
+<span class="sourceLineNo">129</span> * Uninitialize an instance to be
returned to the idle object pool.<a name="line.129"></a>
+<span class="sourceLineNo">130</span> *<a name="line.130"></a>
+<span class="sourceLineNo">131</span> * @param p a {@code PooledObject}
wrapping the instance to be passivated<a name="line.131"></a>
+<span class="sourceLineNo">132</span> *<a name="line.132"></a>
+<span class="sourceLineNo">133</span> * @throws Exception if there is a
problem passivating <code>obj</code>,<a name="line.133"></a>
+<span class="sourceLineNo">134</span> * this exception may be swallowed
by the pool.<a name="line.134"></a>
+<span class="sourceLineNo">135</span> *<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * @see #destroyObject<a
name="line.136"></a>
+<span class="sourceLineNo">137</span> */<a name="line.137"></a>
+<span class="sourceLineNo">138</span> void
passivateObject(PooledObject<T> p) throws Exception;<a
name="line.138"></a>
+<span class="sourceLineNo">139</span>}<a name="line.139"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObjectFactory.html
------------------------------------------------------------------------------
svn:eol-style = native
Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObjectState.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObjectState.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObjectState.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,160 @@
+<!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>/**<a name="line.19"></a>
+<span class="sourceLineNo">020</span> * Provides the possible states that a
{@link PooledObject} may be in.<a name="line.20"></a>
+<span class="sourceLineNo">021</span> *<a name="line.21"></a>
+<span class="sourceLineNo">022</span> * @version $Revision: $<a
name="line.22"></a>
+<span class="sourceLineNo">023</span> *<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * @since 2.0<a name="line.24"></a>
+<span class="sourceLineNo">025</span> */<a name="line.25"></a>
+<span class="sourceLineNo">026</span>public enum PooledObjectState {<a
name="line.26"></a>
+<span class="sourceLineNo">027</span> /**<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * In the queue, not in use.<a
name="line.28"></a>
+<span class="sourceLineNo">029</span> */<a name="line.29"></a>
+<span class="sourceLineNo">030</span> IDLE,<a name="line.30"></a>
+<span class="sourceLineNo">031</span><a name="line.31"></a>
+<span class="sourceLineNo">032</span> /**<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * In use.<a name="line.33"></a>
+<span class="sourceLineNo">034</span> */<a name="line.34"></a>
+<span class="sourceLineNo">035</span> ALLOCATED,<a name="line.35"></a>
+<span class="sourceLineNo">036</span><a name="line.36"></a>
+<span class="sourceLineNo">037</span> /**<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * In the queue, currently being
tested for possible eviction.<a name="line.38"></a>
+<span class="sourceLineNo">039</span> */<a name="line.39"></a>
+<span class="sourceLineNo">040</span> EVICTION,<a name="line.40"></a>
+<span class="sourceLineNo">041</span><a name="line.41"></a>
+<span class="sourceLineNo">042</span> /**<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * Not in the queue, currently being
tested for possible eviction. An<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * attempt to borrow the object was
made while being tested which removed it<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * from the queue. It should be
returned to the head of the queue once<a name="line.45"></a>
+<span class="sourceLineNo">046</span> * eviction testing completes.<a
name="line.46"></a>
+<span class="sourceLineNo">047</span> * TODO: Consider allocating object
and ignoring the result of the eviction<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * test.<a name="line.48"></a>
+<span class="sourceLineNo">049</span> */<a name="line.49"></a>
+<span class="sourceLineNo">050</span> EVICTION_RETURN_TO_HEAD,<a
name="line.50"></a>
+<span class="sourceLineNo">051</span><a name="line.51"></a>
+<span class="sourceLineNo">052</span> /**<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * In the queue, currently being
validated.<a name="line.53"></a>
+<span class="sourceLineNo">054</span> */<a name="line.54"></a>
+<span class="sourceLineNo">055</span> VALIDATION,<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> * Not in queue, currently being
validated. The object was borrowed while<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * being validated and since
testOnBorrow was configured, it was removed<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * from the queue and pre-allocated.
It should be allocated once validation<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * completes.<a name="line.61"></a>
+<span class="sourceLineNo">062</span> */<a name="line.62"></a>
+<span class="sourceLineNo">063</span> VALIDATION_PREALLOCATED,<a
name="line.63"></a>
+<span class="sourceLineNo">064</span><a name="line.64"></a>
+<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * Not in queue, currently being
validated. An attempt to borrow the object<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * was made while previously being
tested for eviction which removed it from<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * the queue. It should be returned
to the head of the queue once validation<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * completes.<a name="line.69"></a>
+<span class="sourceLineNo">070</span> */<a name="line.70"></a>
+<span class="sourceLineNo">071</span> VALIDATION_RETURN_TO_HEAD,<a
name="line.71"></a>
+<span class="sourceLineNo">072</span><a name="line.72"></a>
+<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
+<span class="sourceLineNo">074</span> * Failed maintenance (e.g. eviction
test or validation) and will be / has<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * been destroyed<a
name="line.75"></a>
+<span class="sourceLineNo">076</span> */<a name="line.76"></a>
+<span class="sourceLineNo">077</span> INVALID,<a name="line.77"></a>
+<span class="sourceLineNo">078</span><a name="line.78"></a>
+<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * Deemed abandoned, to be
invalidated.<a name="line.80"></a>
+<span class="sourceLineNo">081</span> */<a name="line.81"></a>
+<span class="sourceLineNo">082</span> ABANDONED,<a name="line.82"></a>
+<span class="sourceLineNo">083</span><a name="line.83"></a>
+<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * Returning to the pool.<a
name="line.85"></a>
+<span class="sourceLineNo">086</span> */<a name="line.86"></a>
+<span class="sourceLineNo">087</span> RETURNING<a name="line.87"></a>
+<span class="sourceLineNo">088</span>}<a name="line.88"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/PooledObjectState.html
------------------------------------------------------------------------------
svn:eol-style = native
Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/SwallowedExceptionListener.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/SwallowedExceptionListener.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/SwallowedExceptionListener.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,108 @@
+<!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>/**<a name="line.19"></a>
+<span class="sourceLineNo">020</span> * Pools that unavoidably swallow
exceptions may be configured with an instance<a name="line.20"></a>
+<span class="sourceLineNo">021</span> * of this listener so the user may
receive notification of when this happens.<a name="line.21"></a>
+<span class="sourceLineNo">022</span> * The listener should not throw an
exception when called but pools calling<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * listeners should protect themselves
against exceptions anyway.<a name="line.23"></a>
+<span class="sourceLineNo">024</span> *<a name="line.24"></a>
+<span class="sourceLineNo">025</span> * @since 2.0<a name="line.25"></a>
+<span class="sourceLineNo">026</span> */<a name="line.26"></a>
+<span class="sourceLineNo">027</span>public interface
SwallowedExceptionListener {<a name="line.27"></a>
+<span class="sourceLineNo">028</span><a name="line.28"></a>
+<span class="sourceLineNo">029</span> /**<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * This method is called every time
the implementation unavoidably swallows<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * an exception.<a name="line.31"></a>
+<span class="sourceLineNo">032</span> *<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * @param e The exception that was
swallowed<a name="line.33"></a>
+<span class="sourceLineNo">034</span> */<a name="line.34"></a>
+<span class="sourceLineNo">035</span> void onSwallowException(Exception
e);<a name="line.35"></a>
+<span class="sourceLineNo">036</span>}<a name="line.36"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/SwallowedExceptionListener.html
------------------------------------------------------------------------------
svn:eol-style = native
Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/TrackedUse.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/TrackedUse.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/TrackedUse.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,110 @@
+<!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>/**<a name="line.19"></a>
+<span class="sourceLineNo">020</span> * This interface allows pooled objects
to make information available about when<a name="line.20"></a>
+<span class="sourceLineNo">021</span> * and how they were used available to
the object pool. The object pool may, but<a name="line.21"></a>
+<span class="sourceLineNo">022</span> * is not required, to use this
information to make more informed decisions when<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * determining the state of a pooled
object - for instance whether or not the<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * object has been abandoned.<a
name="line.24"></a>
+<span class="sourceLineNo">025</span> *<a name="line.25"></a>
+<span class="sourceLineNo">026</span> * @version $Revision:$<a
name="line.26"></a>
+<span class="sourceLineNo">027</span> *<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * @since 2.0<a name="line.28"></a>
+<span class="sourceLineNo">029</span> */<a name="line.29"></a>
+<span class="sourceLineNo">030</span>public interface TrackedUse {<a
name="line.30"></a>
+<span class="sourceLineNo">031</span><a name="line.31"></a>
+<span class="sourceLineNo">032</span> /**<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * Get the last time this object was
used in ms.<a name="line.33"></a>
+<span class="sourceLineNo">034</span> *<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * @return long time in ms<a
name="line.35"></a>
+<span class="sourceLineNo">036</span> */<a name="line.36"></a>
+<span class="sourceLineNo">037</span> long getLastUsed();<a
name="line.37"></a>
+<span class="sourceLineNo">038</span>}<a name="line.38"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/TrackedUse.html
------------------------------------------------------------------------------
svn:eol-style = native
Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/UsageTracking.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/UsageTracking.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/UsageTracking.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,111 @@
+<!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>/**<a name="line.19"></a>
+<span class="sourceLineNo">020</span> * This interface may be implemented by
an object pool to enable clients<a name="line.20"></a>
+<span class="sourceLineNo">021</span> * (primarily those clients that wrap
pools to provide pools with extended<a name="line.21"></a>
+<span class="sourceLineNo">022</span> * features) to provide additional
information to the pool relating to object<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * using allowing more informed decisions
and reporting to be made regarding<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * abandoned objects.<a
name="line.24"></a>
+<span class="sourceLineNo">025</span> *<a name="line.25"></a>
+<span class="sourceLineNo">026</span> * @param <T> The type of object
provided by the pool.<a name="line.26"></a>
+<span class="sourceLineNo">027</span> *<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * @since 2.0<a name="line.28"></a>
+<span class="sourceLineNo">029</span> */<a name="line.29"></a>
+<span class="sourceLineNo">030</span>public interface UsageTracking<T>
{<a name="line.30"></a>
+<span class="sourceLineNo">031</span><a name="line.31"></a>
+<span class="sourceLineNo">032</span> /**<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * This method is called every time a
pooled object to enable the pool to<a name="line.33"></a>
+<span class="sourceLineNo">034</span> * better track borrowed objects.<a
name="line.34"></a>
+<span class="sourceLineNo">035</span> *<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * @param pooledObject The object
that is being used<a name="line.36"></a>
+<span class="sourceLineNo">037</span> */<a name="line.37"></a>
+<span class="sourceLineNo">038</span> void use(T pooledObject);<a
name="line.38"></a>
+<span class="sourceLineNo">039</span>}<a name="line.39"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/UsageTracking.html
------------------------------------------------------------------------------
svn:eol-style = native
Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/AbandonedConfig.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/AbandonedConfig.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/AbandonedConfig.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,304 @@
+<!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><a name="line.17"></a>
+<span class="sourceLineNo">018</span>package org.apache.commons.pool2.impl;<a
name="line.18"></a>
+<span class="sourceLineNo">019</span><a name="line.19"></a>
+<span class="sourceLineNo">020</span>import java.io.PrintWriter;<a
name="line.20"></a>
+<span class="sourceLineNo">021</span><a name="line.21"></a>
+<span class="sourceLineNo">022</span>import
org.apache.commons.pool2.TrackedUse;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import
org.apache.commons.pool2.UsageTracking;<a name="line.23"></a>
+<span class="sourceLineNo">024</span><a name="line.24"></a>
+<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
+<span class="sourceLineNo">026</span> * Configuration settings for abandoned
object removal.<a name="line.26"></a>
+<span class="sourceLineNo">027</span> *<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * @version $Revision:$<a
name="line.28"></a>
+<span class="sourceLineNo">029</span> *<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * @since 2.0<a name="line.30"></a>
+<span class="sourceLineNo">031</span> */<a name="line.31"></a>
+<span class="sourceLineNo">032</span>public class AbandonedConfig {<a
name="line.32"></a>
+<span class="sourceLineNo">033</span><a name="line.33"></a>
+<span class="sourceLineNo">034</span> /**<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * Whether or not borrowObject
performs abandoned object removal.<a name="line.35"></a>
+<span class="sourceLineNo">036</span> */<a name="line.36"></a>
+<span class="sourceLineNo">037</span> private boolean
removeAbandonedOnBorrow = false;<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> * <p>Flag to remove abandoned
objects if they exceed the<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * removeAbandonedTimeout when
borrowObject is invoked.</p><a name="line.41"></a>
+<span class="sourceLineNo">042</span> *<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * <p>The default value is
false.</p><a name="line.43"></a>
+<span class="sourceLineNo">044</span> *<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * <p>If set to true, abandoned
objects are removed by borrowObject if<a name="line.45"></a>
+<span class="sourceLineNo">046</span> * there are fewer than 2 idle
objects available in the pool and<a name="line.46"></a>
+<span class="sourceLineNo">047</span> * <code>getNumActive()
&gt; getMaxTotal() - 3</code></p><a name="line.47"></a>
+<span class="sourceLineNo">048</span> *<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * @return true if abandoned objects
are to be removed by borrowObject<a name="line.49"></a>
+<span class="sourceLineNo">050</span> */<a name="line.50"></a>
+<span class="sourceLineNo">051</span> public boolean
getRemoveAbandonedOnBorrow() {<a name="line.51"></a>
+<span class="sourceLineNo">052</span> return
this.removeAbandonedOnBorrow;<a name="line.52"></a>
+<span class="sourceLineNo">053</span> }<a name="line.53"></a>
+<span class="sourceLineNo">054</span><a name="line.54"></a>
+<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * <p>Flag to remove abandoned
objects if they exceed the<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * removeAbandonedTimeout when
borrowObject is invoked.</p><a name="line.57"></a>
+<span class="sourceLineNo">058</span> *<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * @param removeAbandonedOnBorrow
true means abandoned objects will be<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * removed by borrowObject<a
name="line.60"></a>
+<span class="sourceLineNo">061</span> * @see
#getRemoveAbandonedOnBorrow()<a name="line.61"></a>
+<span class="sourceLineNo">062</span> */<a name="line.62"></a>
+<span class="sourceLineNo">063</span> public void
setRemoveAbandonedOnBorrow(boolean removeAbandonedOnBorrow) {<a
name="line.63"></a>
+<span class="sourceLineNo">064</span> this.removeAbandonedOnBorrow =
removeAbandonedOnBorrow;<a name="line.64"></a>
+<span class="sourceLineNo">065</span> }<a name="line.65"></a>
+<span class="sourceLineNo">066</span><a name="line.66"></a>
+<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * Whether or not pool maintenance
(evictor) performs abandoned object<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * removal.<a name="line.69"></a>
+<span class="sourceLineNo">070</span> */<a name="line.70"></a>
+<span class="sourceLineNo">071</span> private boolean
removeAbandonedOnMaintenance = false;<a name="line.71"></a>
+<span class="sourceLineNo">072</span><a name="line.72"></a>
+<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
+<span class="sourceLineNo">074</span> * <p>Flag to remove abandoned
objects if they exceed the<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * removeAbandonedTimeout when pool
maintenance (the "evictor")<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * runs.</p><a
name="line.76"></a>
+<span class="sourceLineNo">077</span> *<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * <p>The default value is
false.</p><a name="line.78"></a>
+<span class="sourceLineNo">079</span> *<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * <p>If set to true, abandoned
objects are removed by the pool<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * maintenance thread when it runs.
This setting has no effect<a name="line.81"></a>
+<span class="sourceLineNo">082</span> * unless maintenance is enabled by
setting<a name="line.82"></a>
+<span class="sourceLineNo">083</span> *{@link
GenericObjectPool#getTimeBetweenEvictionRunsMillis()
timeBetweenEvictionRunsMillis}<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * to a positive number.</p><a
name="line.84"></a>
+<span class="sourceLineNo">085</span> *<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * @return true if abandoned objects
are to be removed by the evictor<a name="line.86"></a>
+<span class="sourceLineNo">087</span> */<a name="line.87"></a>
+<span class="sourceLineNo">088</span> public boolean
getRemoveAbandonedOnMaintenance() {<a name="line.88"></a>
+<span class="sourceLineNo">089</span> return
this.removeAbandonedOnMaintenance;<a name="line.89"></a>
+<span class="sourceLineNo">090</span> }<a name="line.90"></a>
+<span class="sourceLineNo">091</span><a name="line.91"></a>
+<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
+<span class="sourceLineNo">093</span> * <p>Flag to remove abandoned
objects if they exceed the<a name="line.93"></a>
+<span class="sourceLineNo">094</span> * removeAbandonedTimeout when pool
maintenance runs.</p><a name="line.94"></a>
+<span class="sourceLineNo">095</span> *<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * @param
removeAbandonedOnMaintenance true means abandoned objects will be<a
name="line.96"></a>
+<span class="sourceLineNo">097</span> * removed by pool maintenance<a
name="line.97"></a>
+<span class="sourceLineNo">098</span> * @see
#getRemoveAbandonedOnMaintenance<a name="line.98"></a>
+<span class="sourceLineNo">099</span> */<a name="line.99"></a>
+<span class="sourceLineNo">100</span> public void
setRemoveAbandonedOnMaintenance(boolean removeAbandonedOnMaintenance) {<a
name="line.100"></a>
+<span class="sourceLineNo">101</span> this.removeAbandonedOnMaintenance
= removeAbandonedOnMaintenance;<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> /**<a name="line.104"></a>
+<span class="sourceLineNo">105</span> * Timeout in seconds before an
abandoned object can be removed.<a name="line.105"></a>
+<span class="sourceLineNo">106</span> */<a name="line.106"></a>
+<span class="sourceLineNo">107</span> private int removeAbandonedTimeout =
300;<a name="line.107"></a>
+<span class="sourceLineNo">108</span><a name="line.108"></a>
+<span class="sourceLineNo">109</span> /**<a name="line.109"></a>
+<span class="sourceLineNo">110</span> * <p>Timeout in seconds before
an abandoned object can be removed.</p><a name="line.110"></a>
+<span class="sourceLineNo">111</span> *<a name="line.111"></a>
+<span class="sourceLineNo">112</span> * <p>The time of most recent
use of an object is the maximum (latest) of<a name="line.112"></a>
+<span class="sourceLineNo">113</span> * {@link TrackedUse#getLastUsed()}
(if this class of the object implements<a name="line.113"></a>
+<span class="sourceLineNo">114</span> * TrackedUse) and the time when the
object was borrowed from the pool.</p><a name="line.114"></a>
+<span class="sourceLineNo">115</span> *<a name="line.115"></a>
+<span class="sourceLineNo">116</span> * <p>The default value is 300
seconds.</p><a name="line.116"></a>
+<span class="sourceLineNo">117</span> *<a name="line.117"></a>
+<span class="sourceLineNo">118</span> * @return the abandoned object
timeout in seconds<a name="line.118"></a>
+<span class="sourceLineNo">119</span> */<a name="line.119"></a>
+<span class="sourceLineNo">120</span> public int
getRemoveAbandonedTimeout() {<a name="line.120"></a>
+<span class="sourceLineNo">121</span> return
this.removeAbandonedTimeout;<a name="line.121"></a>
+<span class="sourceLineNo">122</span> }<a name="line.122"></a>
+<span class="sourceLineNo">123</span><a name="line.123"></a>
+<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * <p>Sets the timeout in
seconds before an abandoned object can be<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * removed</p><a
name="line.126"></a>
+<span class="sourceLineNo">127</span> *<a name="line.127"></a>
+<span class="sourceLineNo">128</span> * <p>Setting this property has
no effect if<a name="line.128"></a>
+<span class="sourceLineNo">129</span> * {@link
#getRemoveAbandonedOnBorrow() removeAbandonedOnBorrow} and<a
name="line.129"></a>
+<span class="sourceLineNo">130</span> * {@link
#getRemoveAbandonedOnMaintenance() removeAbandonedOnMaintenance}<a
name="line.130"></a>
+<span class="sourceLineNo">131</span> * are both false.</p><a
name="line.131"></a>
+<span class="sourceLineNo">132</span> *<a name="line.132"></a>
+<span class="sourceLineNo">133</span> * @param removeAbandonedTimeout new
abandoned timeout in seconds<a name="line.133"></a>
+<span class="sourceLineNo">134</span> * @see
#getRemoveAbandonedTimeout()<a name="line.134"></a>
+<span class="sourceLineNo">135</span> */<a name="line.135"></a>
+<span class="sourceLineNo">136</span> public void
setRemoveAbandonedTimeout(int removeAbandonedTimeout) {<a name="line.136"></a>
+<span class="sourceLineNo">137</span> this.removeAbandonedTimeout =
removeAbandonedTimeout;<a name="line.137"></a>
+<span class="sourceLineNo">138</span> }<a name="line.138"></a>
+<span class="sourceLineNo">139</span><a name="line.139"></a>
+<span class="sourceLineNo">140</span> /**<a name="line.140"></a>
+<span class="sourceLineNo">141</span> * Determines whether or not to log
stack traces for application code<a name="line.141"></a>
+<span class="sourceLineNo">142</span> * which abandoned an object.<a
name="line.142"></a>
+<span class="sourceLineNo">143</span> */<a name="line.143"></a>
+<span class="sourceLineNo">144</span> private boolean logAbandoned =
false;<a name="line.144"></a>
+<span class="sourceLineNo">145</span><a name="line.145"></a>
+<span class="sourceLineNo">146</span> /**<a name="line.146"></a>
+<span class="sourceLineNo">147</span> * Flag to log stack traces for
application code which abandoned<a name="line.147"></a>
+<span class="sourceLineNo">148</span> * an object.<a name="line.148"></a>
+<span class="sourceLineNo">149</span> *<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * Defaults to false.<a
name="line.150"></a>
+<span class="sourceLineNo">151</span> * Logging of abandoned objects adds
overhead for every object created<a name="line.151"></a>
+<span class="sourceLineNo">152</span> * because a stack trace has to be
generated.<a name="line.152"></a>
+<span class="sourceLineNo">153</span> *<a name="line.153"></a>
+<span class="sourceLineNo">154</span> * @return boolean true if stack
trace logging is turned on for abandoned<a name="line.154"></a>
+<span class="sourceLineNo">155</span> * objects<a name="line.155"></a>
+<span class="sourceLineNo">156</span> *<a name="line.156"></a>
+<span class="sourceLineNo">157</span> */<a name="line.157"></a>
+<span class="sourceLineNo">158</span> public boolean getLogAbandoned() {<a
name="line.158"></a>
+<span class="sourceLineNo">159</span> return this.logAbandoned;<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> /**<a name="line.162"></a>
+<span class="sourceLineNo">163</span> * Sets the flag to log stack traces
for application code which abandoned<a name="line.163"></a>
+<span class="sourceLineNo">164</span> * an object.<a name="line.164"></a>
+<span class="sourceLineNo">165</span> *<a name="line.165"></a>
+<span class="sourceLineNo">166</span> * @param logAbandoned true turns on
abandoned stack trace logging<a name="line.166"></a>
+<span class="sourceLineNo">167</span> * @see #getLogAbandoned()<a
name="line.167"></a>
+<span class="sourceLineNo">168</span> *<a name="line.168"></a>
+<span class="sourceLineNo">169</span> */<a name="line.169"></a>
+<span class="sourceLineNo">170</span> public void setLogAbandoned(boolean
logAbandoned) {<a name="line.170"></a>
+<span class="sourceLineNo">171</span> this.logAbandoned =
logAbandoned;<a name="line.171"></a>
+<span class="sourceLineNo">172</span> }<a name="line.172"></a>
+<span class="sourceLineNo">173</span><a name="line.173"></a>
+<span class="sourceLineNo">174</span> /**<a name="line.174"></a>
+<span class="sourceLineNo">175</span> * PrintWriter to use to log
information on abandoned objects.<a name="line.175"></a>
+<span class="sourceLineNo">176</span> * Use of default system encoding is
deliberate.<a name="line.176"></a>
+<span class="sourceLineNo">177</span> */<a name="line.177"></a>
+<span class="sourceLineNo">178</span> private PrintWriter logWriter = new
PrintWriter(System.out);<a name="line.178"></a>
+<span class="sourceLineNo">179</span><a name="line.179"></a>
+<span class="sourceLineNo">180</span> /**<a name="line.180"></a>
+<span class="sourceLineNo">181</span> * Returns the log writer being used
by this configuration to log<a name="line.181"></a>
+<span class="sourceLineNo">182</span> * information on abandoned objects.
If not set, a PrintWriter based on<a name="line.182"></a>
+<span class="sourceLineNo">183</span> * System.out with the system default
encoding is used.<a name="line.183"></a>
+<span class="sourceLineNo">184</span> *<a name="line.184"></a>
+<span class="sourceLineNo">185</span> * @return log writer in use<a
name="line.185"></a>
+<span class="sourceLineNo">186</span> */<a name="line.186"></a>
+<span class="sourceLineNo">187</span> public PrintWriter getLogWriter() {<a
name="line.187"></a>
+<span class="sourceLineNo">188</span> return logWriter;<a
name="line.188"></a>
+<span class="sourceLineNo">189</span> }<a name="line.189"></a>
+<span class="sourceLineNo">190</span><a name="line.190"></a>
+<span class="sourceLineNo">191</span> /**<a name="line.191"></a>
+<span class="sourceLineNo">192</span> * Sets the log writer to be used by
this configuration to log<a name="line.192"></a>
+<span class="sourceLineNo">193</span> * information on abandoned
objects.<a name="line.193"></a>
+<span class="sourceLineNo">194</span> *<a name="line.194"></a>
+<span class="sourceLineNo">195</span> * @param logWriter The new log
writer<a name="line.195"></a>
+<span class="sourceLineNo">196</span> */<a name="line.196"></a>
+<span class="sourceLineNo">197</span> public void setLogWriter(PrintWriter
logWriter) {<a name="line.197"></a>
+<span class="sourceLineNo">198</span> this.logWriter = logWriter;<a
name="line.198"></a>
+<span class="sourceLineNo">199</span> }<a name="line.199"></a>
+<span class="sourceLineNo">200</span><a name="line.200"></a>
+<span class="sourceLineNo">201</span> /**<a name="line.201"></a>
+<span class="sourceLineNo">202</span> * If the pool implements {@link
UsageTracking}, should the pool record a<a name="line.202"></a>
+<span class="sourceLineNo">203</span> * stack trace every time a method is
called on a pooled object and retain<a name="line.203"></a>
+<span class="sourceLineNo">204</span> * the most recent stack trace to aid
debugging of abandoned objects?<a name="line.204"></a>
+<span class="sourceLineNo">205</span> */<a name="line.205"></a>
+<span class="sourceLineNo">206</span> private boolean useUsageTracking =
false;<a name="line.206"></a>
+<span class="sourceLineNo">207</span><a name="line.207"></a>
+<span class="sourceLineNo">208</span> /**<a name="line.208"></a>
+<span class="sourceLineNo">209</span> * If the pool implements {@link
UsageTracking}, should the pool record a<a name="line.209"></a>
+<span class="sourceLineNo">210</span> * stack trace every time a method is
called on a pooled object and retain<a name="line.210"></a>
+<span class="sourceLineNo">211</span> * the most recent stack trace to aid
debugging of abandoned objects?<a name="line.211"></a>
+<span class="sourceLineNo">212</span> *<a name="line.212"></a>
+<span class="sourceLineNo">213</span> * @return
<code>true</code> if usage tracking is enabled<a
name="line.213"></a>
+<span class="sourceLineNo">214</span> */<a name="line.214"></a>
+<span class="sourceLineNo">215</span> public boolean getUseUsageTracking()
{<a name="line.215"></a>
+<span class="sourceLineNo">216</span> return useUsageTracking;<a
name="line.216"></a>
+<span class="sourceLineNo">217</span> }<a name="line.217"></a>
+<span class="sourceLineNo">218</span><a name="line.218"></a>
+<span class="sourceLineNo">219</span> /**<a name="line.219"></a>
+<span class="sourceLineNo">220</span> * If the pool implements {@link
UsageTracking}, configure whether the pool<a name="line.220"></a>
+<span class="sourceLineNo">221</span> * should record a stack trace every
time a method is called on a pooled<a name="line.221"></a>
+<span class="sourceLineNo">222</span> * object and retain the most recent
stack trace to aid debugging of<a name="line.222"></a>
+<span class="sourceLineNo">223</span> * abandoned objects.<a
name="line.223"></a>
+<span class="sourceLineNo">224</span> *<a name="line.224"></a>
+<span class="sourceLineNo">225</span> * @param useUsageTracking A
value of <code>true</code> will enable<a name="line.225"></a>
+<span class="sourceLineNo">226</span> * the
recording of a stack trace on every use<a name="line.226"></a>
+<span class="sourceLineNo">227</span> * of a
pooled object<a name="line.227"></a>
+<span class="sourceLineNo">228</span> */<a name="line.228"></a>
+<span class="sourceLineNo">229</span> public void
setUseUsageTracking(boolean useUsageTracking) {<a name="line.229"></a>
+<span class="sourceLineNo">230</span> this.useUsageTracking =
useUsageTracking;<a name="line.230"></a>
+<span class="sourceLineNo">231</span> }<a name="line.231"></a>
+<span class="sourceLineNo">232</span>}<a name="line.232"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/AbandonedConfig.html
------------------------------------------------------------------------------
svn:eol-style = native
