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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Language" content="en-gb">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<meta http-equiv="Expires" content="-1">
<meta http-equiv="Pragma" content="no-cache">
<title>Proxool 0.9.0RC3</title>
<link href="proxool.css" type="text/css" rel="stylesheet">
</head>
<body>
<div style="max-width: 1200px;">
<table border="0" style="min-height: 100%;" cellpadding="0" cellspacing="0" width="100%">
<tbody>
<tr>
<td valign="bottom" width="150">
</td>
<td colspan="2" height="50">
<div class="bannerFinal">
<table cellpadding="0" cellspacing="0" border="0" width="100%">
<tr>
<td height="50">
<span class="titleCaption" style="font-size: 110%; padding: 4px;">
Setting up Proxool in a Servlet environment
</span>
</td>
<td valign="middle" height="50">
<div>
<div style="float: right; margin-right: 8px;">
<img src="images/dots.gif" width="80" height="20" border="0" alt="...">
<a href="http://sourceforge.net/projects/proxool"><img src="images/sflogo.png" width="88" height="31" border="0" alt="SourceForge.net Logo"></a>
</div>
</div>
</td>
</tr>
</table>
</div>
<td width="10"> </td>
</tr>
<tr>
<td valign="top" width="150">
<br/>
<br/>
<table
cellpadding="0"
cellspacing="0"
border="0"
width="100%"
>
<tbody>
<tr>
<td valign="top">
<div class="menuBox" >
<div class="menu-inactive"><a class="menu-inactive" href="index.html">Home</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="news.html">News</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="faq.html">FAQ</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="tips.html">Tips</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="changelog.html">Changes</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="future.html">The Future</a></div>
<div class="menu-active"><a class="menu-active" href="user.html">User Guide</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="dev.html">Developer Guide</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="licence.html">Licence</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="credits.html">Credits</a></div>
<div class="menu-separater">User Guide:</div>
<div style="margin-left: 8px">
<div class="menu-inactive"><a class="menu-inactive" href="user.html">Introduction</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="quickStart.html">Quick start</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="properties.html">Properties</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="configure.html">Configuration</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="logging.html">Logging</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="admin.html">Admin</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="adminServlet.html">AdminServlet</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="listen.html">Events</a></div>
<div class="menu-active"><a class="menu-active" href="servlets.html">Servlets</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="api/index.html">Simple API</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="howitworks.html">How it works</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="datasource.html">DataSource</a></div>
<div class="menu-inactive"><a class="menu-inactive" href="injectableInterfaces.html">Injectable Interfaces</a></div>
</div>
</div>
</td>
<td> </td>
</tr>
<tr>
<td>
<table cellpadding="0" cellspacing="0" border="0" summary="">
<tbody>
<tr><td>
<div class="rightItem">
<div class="rightItemHeader">Version 0.9.0RC3</div>
<div class="rightItemContent">
The latest version of this documentation and software is available on our web site:
<br/><a href="http://proxool.sf.net">proxool.sf.net</a>
</div>
</div>
<div class="rightItem">
<div class="rightItemHeader">Donations</div>
<div class="rightItemContent">
You can donate to Proxool in the usual way:
<br/><a href="http://sourceforge.net/project/project_donations.php?group_id=53958">sourceforge.net</a>
</div>
</div>
</td></tr>
<tr>
<td>
<div class="footer">
last updated: 10-Jan-2007
</div>
</td>
</tr>
</tbody>
</table>
</td>
<td> </td>
</tr>
</tbody>
</table>
</td>
<td valign="top" colspan="2">
<table cellpadding="0" cellspacing="0" border="0" width="100%" summary="">
<tbody>
<tr>
<td class="contents" valign="top">
<p><a href="#configure">Configuration with a servlet</a></p>
<p><a href="#install">Installing Proxool in your web application</a></p>
<div class="section">
<a name="configure"></a>
<p><b>Configuration.</b> You can configure Proxool using a Servlet too. There are three
ways:</p>
<p><b>1. XML file</b>. Delegates to
<a href="api/org/logicalcobwebs/proxool/configuration/JAXPConfigurator.html">JAXPConfigurator</a> passing
in the filename. If the filename is not absolute then it is prepended
with the application directory.</p>
<div class="codeSample">
<servlet><br/>
<servlet-name>ServletConfigurator</servlet-name><br/>
<servlet-class>org.logicalcobwebs.proxool.configuration.ServletConfigurator</servlet-class><br/>
<init-param><br/>
<param-name>xmlFile</param-name><br/>
<param-value>WEB-INF/proxool.xml</param-value><br/>
</init-param><br/>
<load-on-startup>1</load-on-startup><br/>
</servlet>
</div>
<p><b>2. Property file</b>. Delegates to
<a href="api/org/logicalcobwebs/proxool/configuration/PropertyConfigurator.html">PropertyConfigurator</a>
passing in the filename. If the filename is not absolute then it is prepended
with the application directory.</p>
<div class="codeSample">
<servlet><br/>
<servlet-name>ServletConfigurator</servlet-name><br/>
<servlet-class>org.logicalcobwebs.proxool.configuration.ServletConfigurator</servlet-class><br/>
<init-param><br/>
<param-name>propertyFile</param-name><br/>
<param-value>WEB-INF/proxool.properties</param-value><br/>
</init-param><br/>
<load-on-startup>1</load-on-startup><br/>
</servlet>
</div>
<p><b>3. Init parameters</b>. Delegates to
<a href="api/org/logicalcobwebs/proxool/configuration/PropertyConfigurator.html">PropertyConfigurator</a>
by passing in a new Properties object based on the servlet's init
parameters.</p>
<div class="codeSample">
<servlet><br/>
<servlet-name>ServletConfigurator</servlet-name><br/>
<servlet-class>org.logicalcobwebs.proxool.configuration.ServletConfigurator</servlet-class><br/>
<init-param><br/>
<param-name>jdbc-0.proxool.alias</param-name><br/>
<param-value>test</param-value><br/>
</init-param><br/>
<init-param><br/>
<param-name>jdbc-0.proxool.driver-url</param-name><br/>
<param-value>jdbc:hsqldb:.</param-value><br/>
</init-param><br/>
<init-param><br/>
<param-name>jdbc-0.proxool.driver-class</param-name><br/>
<param-value>org.hsqldb.jdbcDriver</param-value><br/>
</init-param><br/>
<load-on-startup>1</load-on-startup><br/>
</servlet>
</div>
<p>The ServletConfigurator also shuts down Proxool by removing all connection pools. If you want
to disable this behaviour then use:</p>
<div class="codeSample">
<servlet><br/>
<servlet-name>ServletConfigurator</servlet-name><br/>
<servlet-class>org.logicalcobwebs.proxool.configuration.ServletConfigurator</servlet-class><br/>
<init-param><br/>
<param-name>autoShutdown</param-name><br/>
<param-value>false</param-value><br/>
</init-param><br/>
<load-on-startup>1</load-on-startup><br/>
</servlet>
</div>
</div>
<div class="section">
<a name="install"></a><p><b>Installation.</b></p>
</div>
<p>If you run more than one web application in your servlet environment then you should consider
where you install the Proxool JAR. There are two options:</p>
<p><b>1.</b> In the web application's lib directory (WEB-INF/lib). This has the following consequences:</p>
<p style="margin-left: 16px;">Proxool pools will not be shared across web applications.</p>
<p style="margin-left: 16px;">When you reload (or restart) your web application then a new
instance of Proxool is started. Unless you explicitly shutdown the old one then it will continue running
and continue to use resources (both locally and on the database). You can shutdown the pool by
either using the ServletConfigurator, above, or calling
ProxoolFacade.<a href="api/org/logicalcobwebs/proxool/ProxoolFacade.html#shutdown(int)">shutdown</a>.</p>
<p><b>2.</b> In the servlet container's common lib directory or elsewhere on the classpath. This has the
following consequences:</p>
<p style="margin-left: 16px;">You can share common pools between web applications.</p>
<p style="margin-left: 16px;">When you reload your web application the pool keeps running. The only way
to restart the pool is to either start and stop your servlet container or two explicitly shut it down and re-configure
it.</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</div>
</body>
<head>
<meta http-equiv="Expires" content="-1">
<meta http-equiv="Pragma" content="no-cache">
</head>
</html>
|
