1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="null" lang="null">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>IdleConnectionTimeoutThread xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/httpclient/util/IdleConnectionTimeoutThread.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/util/IdleConnectionTimeoutThread.java,v 1.2 2004/05/13 02:40:36 mbecke Exp $</em>
<a name="3" href="#3">3</a> <em class="comment"> * $Revision: 480424 $</em>
<a name="4" href="#4">4</a> <em class="comment"> * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $</em>
<a name="5" href="#5">5</a> <em class="comment"> *</em>
<a name="6" href="#6">6</a> <em class="comment"> * ====================================================================</em>
<a name="7" href="#7">7</a> <em class="comment"> *</em>
<a name="8" href="#8">8</a> <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="9" href="#9">9</a> <em class="comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a name="10" href="#10">10</a> <em class="comment"> * this work for additional information regarding copyright ownership.</em>
<a name="11" href="#11">11</a> <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a name="12" href="#12">12</a> <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
<a name="13" href="#13">13</a> <em class="comment"> * the License. You may obtain a copy of the License at</em>
<a name="14" href="#14">14</a> <em class="comment"> *</em>
<a name="15" href="#15">15</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="16" href="#16">16</a> <em class="comment"> *</em>
<a name="17" href="#17">17</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="18" href="#18">18</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="19" href="#19">19</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="20" href="#20">20</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="21" href="#21">21</a> <em class="comment"> * limitations under the License.</em>
<a name="22" href="#22">22</a> <em class="comment"> * ====================================================================</em>
<a name="23" href="#23">23</a> <em class="comment"> *</em>
<a name="24" href="#24">24</a> <em class="comment"> * This software consists of voluntary contributions made by many</em>
<a name="25" href="#25">25</a> <em class="comment"> * individuals on behalf of the Apache Software Foundation. For more</em>
<a name="26" href="#26">26</a> <em class="comment"> * information on the Apache Software Foundation, please see</em>
<a name="27" href="#27">27</a> <em class="comment"> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
<a name="28" href="#28">28</a> <em class="comment"> *</em>
<a name="29" href="#29">29</a> <em class="comment"> */</em>
<a name="30" href="#30">30</a> <strong>package</strong> org.apache.commons.httpclient.util;
<a name="31" href="#31">31</a>
<a name="32" href="#32">32</a> <strong>import</strong> java.util.ArrayList;
<a name="33" href="#33">33</a> <strong>import</strong> java.util.Iterator;
<a name="34" href="#34">34</a> <strong>import</strong> java.util.List;
<a name="35" href="#35">35</a>
<a name="36" href="#36">36</a> <strong>import</strong> org.apache.commons.httpclient.HttpConnectionManager;
<a name="37" href="#37">37</a>
<a name="38" href="#38">38</a> <em>/**</em>
<a name="39" href="#39">39</a> <em> * A utility class for periodically closing idle connections.</em>
<a name="40" href="#40">40</a> <em> * </em>
<a name="41" href="#41">41</a> <em> * @see org.apache.commons.httpclient.HttpConnectionManager#closeIdleConnections(long)</em>
<a name="42" href="#42">42</a> <em> * </em>
<a name="43" href="#43">43</a> <em> * @since 3.0</em>
<a name="44" href="#44">44</a> <em> */</em>
<a name="45" href="#45">45</a> <strong>public</strong> <strong>class</strong> <a href="../../../../../org/apache/commons/httpclient/util/IdleConnectionTimeoutThread.html">IdleConnectionTimeoutThread</a> <strong>extends</strong> Thread {
<a name="46" href="#46">46</a>
<a name="47" href="#47">47</a> <strong>private</strong> List connectionManagers = <strong>new</strong> ArrayList();
<a name="48" href="#48">48</a>
<a name="49" href="#49">49</a> <strong>private</strong> <strong>boolean</strong> shutdown = false;
<a name="50" href="#50">50</a>
<a name="51" href="#51">51</a> <strong>private</strong> <strong>long</strong> timeoutInterval = 1000;
<a name="52" href="#52">52</a>
<a name="53" href="#53">53</a> <strong>private</strong> <strong>long</strong> connectionTimeout = 3000;
<a name="54" href="#54">54</a>
<a name="55" href="#55">55</a> <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/util/IdleConnectionTimeoutThread.html">IdleConnectionTimeoutThread</a>() {
<a name="56" href="#56">56</a> setDaemon(<strong>true</strong>);
<a name="57" href="#57">57</a> }
<a name="58" href="#58">58</a>
<a name="59" href="#59">59</a> <em>/**</em>
<a name="60" href="#60">60</a> <em> * Adds a connection manager to be handled by this class. </em>
<a name="61" href="#61">61</a> <em> * {@link HttpConnectionManager#closeIdleConnections(long)} will be called on the connection</em>
<a name="62" href="#62">62</a> <em> * manager every {@link #setTimeoutInterval(long) timeoutInterval} milliseconds.</em>
<a name="63" href="#63">63</a> <em> * </em>
<a name="64" href="#64">64</a> <em> * @param connectionManager The connection manager to add</em>
<a name="65" href="#65">65</a> <em> */</em>
<a name="66" href="#66">66</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> addConnectionManager(<a href="../../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</a> connectionManager) {
<a name="67" href="#67">67</a> <strong>if</strong> (shutdown) {
<a name="68" href="#68">68</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"IdleConnectionTimeoutThread has been shutdown"</span>);
<a name="69" href="#69">69</a> }
<a name="70" href="#70">70</a> <strong>this</strong>.connectionManagers.add(connectionManager);
<a name="71" href="#71">71</a> }
<a name="72" href="#72">72</a>
<a name="73" href="#73">73</a> <em>/**</em>
<a name="74" href="#74">74</a> <em> * Removes the connection manager from this class. The idle connections from the connection</em>
<a name="75" href="#75">75</a> <em> * manager will no longer be automatically closed by this class.</em>
<a name="76" href="#76">76</a> <em> * </em>
<a name="77" href="#77">77</a> <em> * @param connectionManager The connection manager to remove</em>
<a name="78" href="#78">78</a> <em> */</em>
<a name="79" href="#79">79</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> removeConnectionManager(<a href="../../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</a> connectionManager) {
<a name="80" href="#80">80</a> <strong>if</strong> (shutdown) {
<a name="81" href="#81">81</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"IdleConnectionTimeoutThread has been shutdown"</span>);
<a name="82" href="#82">82</a> }
<a name="83" href="#83">83</a> <strong>this</strong>.connectionManagers.remove(connectionManager);
<a name="84" href="#84">84</a> }
<a name="85" href="#85">85</a>
<a name="86" href="#86">86</a> <em>/**</em>
<a name="87" href="#87">87</a> <em> * Handles calling {@link HttpConnectionManager#closeIdleConnections(long) closeIdleConnections()}</em>
<a name="88" href="#88">88</a> <em> * and doing any other cleanup work on the given connection mangaer.</em>
<a name="89" href="#89">89</a> <em> * @param connectionManager The connection manager to close idle connections for</em>
<a name="90" href="#90">90</a> <em> */</em>
<a name="91" href="#91">91</a> <strong>protected</strong> <strong>void</strong> handleCloseIdleConnections(<a href="../../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</a> connectionManager) {
<a name="92" href="#92">92</a> connectionManager.closeIdleConnections(connectionTimeout);
<a name="93" href="#93">93</a> }
<a name="94" href="#94">94</a>
<a name="95" href="#95">95</a> <em>/**</em>
<a name="96" href="#96">96</a> <em> * Closes idle connections.</em>
<a name="97" href="#97">97</a> <em> */</em>
<a name="98" href="#98">98</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> run() {
<a name="99" href="#99">99</a> <strong>while</strong> (!shutdown) {
<a name="100" href="#100">100</a> Iterator iter = connectionManagers.iterator();
<a name="101" href="#101">101</a>
<a name="102" href="#102">102</a> <strong>while</strong> (iter.hasNext()) {
<a name="103" href="#103">103</a> <a href="../../../../../org/apache/commons/httpclient/HttpConnectionManager.html">HttpConnectionManager</a> connectionManager = (HttpConnectionManager) iter.next();
<a name="104" href="#104">104</a> handleCloseIdleConnections(connectionManager);
<a name="105" href="#105">105</a> }
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> <strong>try</strong> {
<a name="108" href="#108">108</a> <strong>this</strong>.wait(timeoutInterval);
<a name="109" href="#109">109</a> } <strong>catch</strong> (InterruptedException e) {
<a name="110" href="#110">110</a> }
<a name="111" href="#111">111</a> }
<a name="112" href="#112">112</a> <em class="comment">// clear out the connection managers now that we're shutdown</em>
<a name="113" href="#113">113</a> <strong>this</strong>.connectionManagers.clear();
<a name="114" href="#114">114</a> }
<a name="115" href="#115">115</a>
<a name="116" href="#116">116</a> <em>/**</em>
<a name="117" href="#117">117</a> <em> * Stops the thread used to close idle connections. This class cannot be used once shutdown.</em>
<a name="118" href="#118">118</a> <em> */</em>
<a name="119" href="#119">119</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> shutdown() {
<a name="120" href="#120">120</a> <strong>this</strong>.shutdown = <strong>true</strong>;
<a name="121" href="#121">121</a> <strong>this</strong>.notifyAll();
<a name="122" href="#122">122</a> }
<a name="123" href="#123">123</a>
<a name="124" href="#124">124</a> <em>/**</em>
<a name="125" href="#125">125</a> <em> * Sets the timeout value to use when testing for idle connections.</em>
<a name="126" href="#126">126</a> <em> * </em>
<a name="127" href="#127">127</a> <em> * @param connectionTimeout The connection timeout in milliseconds</em>
<a name="128" href="#128">128</a> <em> * </em>
<a name="129" href="#129">129</a> <em> * @see HttpConnectionManager#closeIdleConnections(long)</em>
<a name="130" href="#130">130</a> <em> */</em>
<a name="131" href="#131">131</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> setConnectionTimeout(<strong>long</strong> connectionTimeout) {
<a name="132" href="#132">132</a> <strong>if</strong> (shutdown) {
<a name="133" href="#133">133</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"IdleConnectionTimeoutThread has been shutdown"</span>);
<a name="134" href="#134">134</a> }
<a name="135" href="#135">135</a> <strong>this</strong>.connectionTimeout = connectionTimeout;
<a name="136" href="#136">136</a> }
<a name="137" href="#137">137</a> <em>/**</em>
<a name="138" href="#138">138</a> <em> * Sets the interval used by this class between closing idle connections. Idle </em>
<a name="139" href="#139">139</a> <em> * connections will be closed every <code>timeoutInterval</code> milliseconds.</em>
<a name="140" href="#140">140</a> <em> * </em>
<a name="141" href="#141">141</a> <em> * @param timeoutInterval The timeout interval in milliseconds</em>
<a name="142" href="#142">142</a> <em> */</em>
<a name="143" href="#143">143</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> setTimeoutInterval(<strong>long</strong> timeoutInterval) {
<a name="144" href="#144">144</a> <strong>if</strong> (shutdown) {
<a name="145" href="#145">145</a> <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"IdleConnectionTimeoutThread has been shutdown"</span>);
<a name="146" href="#146">146</a> }
<a name="147" href="#147">147</a> <strong>this</strong>.timeoutInterval = timeoutInterval;
<a name="148" href="#148">148</a> }
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
|
