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
|
<!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;">
Quick Start
</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-active"><a class="menu-active" 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-inactive"><a class="menu-inactive" 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>
This document describes how to invoke Proxool. It assumes that you're
familiar with the Java language in general and the JDBC API in particular.
Please visit Sun's <a href="http://java.sun.com/products/jdbc/">JDBC</a>
web site for information about JDBC.
</p>
<p><b>1.</b> If you adapting an existing application then the most transparent
way to switch to Proxool is to simply change the URL you use to connect to the
database. For example:</p>
<div class="codeSample">
<span class="lineNumber"> 1.</span>Connection connection = null;<br/>
<span class="lineNumber"> 2.</span>try {<br/>
<span class="lineNumber"> 3.</span> Class.forName("org.hsqldb.jdbcDriver");<br/>
<span class="lineNumber"> 4.</span> try {<br/>
<span class="lineNumber"> 5.</span> connection = DriverManager.getConnection("jdbc:hsqldb:test");<br/>
<span class="lineNumber"> 6.</span> } catch (SQLException e) {<br/>
<span class="lineNumber"> 7.</span> LOG.error("Problem getting connection", e);<br/>
<span class="lineNumber"> 8.</span> }<br/>
<span class="lineNumber"> 9.</span> <br/>
<span class="lineNumber">10.</span> if (connection != null) {<br/>
<span class="lineNumber">11.</span> LOG.info("Got connection :)");<br/>
<span class="lineNumber">12.</span> } else {<br/>
<span class="lineNumber">13.</span> LOG.error("Didn't get connection, which probably means that no Driver accepted the URL");<br/>
<span class="lineNumber">14.</span> }<br/>
<span class="lineNumber">15.</span> <br/>
<span class="lineNumber">16.</span>} catch (ClassNotFoundException e) {<br/>
<span class="lineNumber">17.</span> LOG.error("Couldn't find driver", e);<br/>
<span class="lineNumber">18.</span>} finally {<br/>
<span class="lineNumber">19.</span> try {<br/>
<span class="lineNumber">20.</span> // Check to see we actually got a connection before we<br/>
<span class="lineNumber">21.</span> // attempt to close it.<br/>
<span class="lineNumber">22.</span> if (connection != null) {<br/>
<span class="lineNumber">23.</span> connection.close();<br/>
<span class="lineNumber">24.</span> }<br/>
<span class="lineNumber">25.</span> } catch (SQLException e) {<br/>
<span class="lineNumber">26.</span> LOG.error("Problem closing connection", e);<br/>
<span class="lineNumber">27.</span> }<br/>
<span class="lineNumber">28.</span>}
</div>
<p>To start using Proxool, simply edit lines 3 and 5 (marked in blue):</p>
<div class="codeSample">
<span class="lineNumber"> 1.</span>Connection connection = null;<br/>
<span class="lineNumber"> 2.</span>try {<br/>
<span class="lineNumber"> 3.</span> Class.forName("<font color="#000099">org.logicalcobwebs.proxool.ProxoolDriver</font>");<br/>
<span class="lineNumber"> 4.</span> try {<br/>
<span class="lineNumber"> 5.</span> connection = DriverManager.getConnection("<font color="#000099">proxool.example:org.hsqldb.jdbcDriver:jdbc:hsqldb:test</font>");<br/>
<span class="lineNumber"> 6.</span> } catch (SQLException e) {<br/>
<span class="lineNumber"> 7.</span> LOG.error("Problem getting connection", e);<br/>
<span class="lineNumber"> 8.</span> }<br/>
<span class="lineNumber"> 9.</span> <br/>
<span class="lineNumber">10.</span> if (connection != null) {<br/>
<span class="lineNumber">11.</span> LOG.info("Got connection :)");<br/>
<span class="lineNumber">12.</span> } else {<br/>
<span class="lineNumber">13.</span> LOG.error("Didn't get connection, which probably means that no Driver accepted the URL");<br/>
<span class="lineNumber">14.</span> }<br/>
<span class="lineNumber">15.</span> <br/>
<span class="lineNumber">16.</span>} catch (ClassNotFoundException e) {<br/>
<span class="lineNumber">17.</span> LOG.error("Couldn't find driver", e);<br/>
<span class="lineNumber">18.</span>} finally {<br/>
<span class="lineNumber">19.</span> try {<br/>
<span class="lineNumber">20.</span> // Check to see we actually got a connection before we<br/>
<span class="lineNumber">21.</span> // attempt to close it.<br/>
<span class="lineNumber">22.</span> if (connection != null) {<br/>
<span class="lineNumber">23.</span> connection.close();<br/>
<span class="lineNumber">24.</span> }<br/>
<span class="lineNumber">25.</span> } catch (SQLException e) {<br/>
<span class="lineNumber">26.</span> LOG.error("Problem closing connection", e);<br/>
<span class="lineNumber">27.</span> }<br/>
<span class="lineNumber">28.</span>}
</div>
<p>The first change (line 3) just loads the Proxool JDBC driver (you only have to do this once). The second line
is the one that is interesting, The URL can be broken down into four sections:</p>
<p>proxool.<font color="#990000">example</font>:<font color="#009900">org.hsqldb.jdbcDriver</font>:<font color="#000099">jdbc:hsqldb:test</font></p>
<p style="margin-left: 16px">"<font color="#990000">example</font>" is the alias for this pool. This is a unique label that we will use to
reference the pool.</p>
<p style="margin-left: 16px">"<font color="#009900">org.hsqldb.jdbcDriver</font>" is the JDBC driver Proxool should
use to connect to the database. (The same one you were originally using).</p>
<p style="margin-left: 16px">"<font color="#000099">jdbc:hsqldb:test</font>" is the URL Proxool should
use to connect to the database. (The same one you were originally using).</p>
<p><b>2.</b> You will find it a lot easier if you explicitly configure the pools at startup, however. There
are lots of ways of doing this - see <a href="configure.html">here</a>. Once you've done that, it's just
a matter of using the alias to pick up a connection. For example:</p>
<div class="codeSample">
<span class="lineNumber"> 1.</span>Connection connection = null;<br/>
<span class="lineNumber"> 2.</span>try {<br/>
<span class="lineNumber"> 4.</span> try {<br/>
<span class="lineNumber"> 5.</span> connection = DriverManager.getConnection("<font color="#000099">proxool.example</font>");<br/>
<span class="lineNumber"> 6.</span> } catch (SQLException e) {<br/>
<span class="lineNumber"> 7.</span> LOG.error("Problem getting connection", e);<br/>
<span class="lineNumber"> 8.</span> }<br/>
<span class="lineNumber"> ...
</div>
</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>
|