blob: ec6cd2be82c18b080d39dabe4ccdd66277bb2f0c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>AutoConnectionTracker</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AutoConnectionTracker";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../org/apache/openejb/resource/AutoConnectionTracker.ConnectionInvocationHandler.html" title="class in org.apache.openejb.resource"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openejb/resource/AutoConnectionTracker.html" target="_top">Frames</a></li>
<li><a href="AutoConnectionTracker.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.openejb.resource</div>
<h2 title="Class AutoConnectionTracker" class="title">Class AutoConnectionTracker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.openejb.resource.AutoConnectionTracker</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">AutoConnectionTracker</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/resource/AutoConnectionTracker.ConnectionInvocationHandler.html" title="class in org.apache.openejb.resource">AutoConnectionTracker.ConnectionInvocationHandler</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/resource/AutoConnectionTracker.html#AutoConnectionTracker-boolean-">AutoConnectionTracker</a></span>(boolean&nbsp;cleanupLeakedConnections)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;ManagedConnectionInfo&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/resource/AutoConnectionTracker.html#connections--">connections</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/resource/AutoConnectionTracker.html#handleObtained-ConnectionTrackingInterceptor-ConnectionInfo-boolean-">handleObtained</a></span>(ConnectionTrackingInterceptor&nbsp;interceptor,
ConnectionInfo&nbsp;connectionInfo,
boolean&nbsp;reassociate)</code>
<div class="block">Proxies new connection handles so we can detect when they have been garbage collected.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/resource/AutoConnectionTracker.html#handleReleased-ConnectionTrackingInterceptor-ConnectionInfo-ConnectionReturnAction-">handleReleased</a></span>(ConnectionTrackingInterceptor&nbsp;interceptor,
ConnectionInfo&nbsp;connectionInfo,
ConnectionReturnAction&nbsp;action)</code>
<div class="block">Removes the released collection from the garbage collection reference tracker, since this
connection is being release via a normal close method.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/resource/AutoConnectionTracker.html#setEnvironment-ConnectionInfo-java.lang.String-">setEnvironment</a></span>(ConnectionInfo&nbsp;connectionInfo,
java.lang.String&nbsp;key)</code>
<div class="block">Releases any managed connections held by a garbage collected connection proxy.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/resource/AutoConnectionTracker.html#stackTraceToString-java.lang.StackTraceElement:A-">stackTraceToString</a></span>(java.lang.StackTraceElement[]&nbsp;stackTrace)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AutoConnectionTracker-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AutoConnectionTracker</h4>
<pre>public&nbsp;AutoConnectionTracker(boolean&nbsp;cleanupLeakedConnections)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="connections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connections</h4>
<pre>public&nbsp;java.util.Set&lt;ManagedConnectionInfo&gt;&nbsp;connections()</pre>
</li>
</ul>
<a name="setEnvironment-ConnectionInfo-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnvironment</h4>
<pre>public&nbsp;void&nbsp;setEnvironment(ConnectionInfo&nbsp;connectionInfo,
java.lang.String&nbsp;key)</pre>
<div class="block">Releases any managed connections held by a garbage collected connection proxy.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connectionInfo</code> - the connection to be obtained</dd>
<dd><code>key</code> - the unique id of the connection manager</dd>
</dl>
</li>
</ul>
<a name="handleObtained-ConnectionTrackingInterceptor-ConnectionInfo-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleObtained</h4>
<pre>public&nbsp;void&nbsp;handleObtained(ConnectionTrackingInterceptor&nbsp;interceptor,
ConnectionInfo&nbsp;connectionInfo,
boolean&nbsp;reassociate)
throws ResourceException</pre>
<div class="block">Proxies new connection handles so we can detect when they have been garbage collected.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interceptor</code> - the interceptor used to release the managed connection when the handled is garbage collected.</dd>
<dd><code>connectionInfo</code> - the connection that was obtained</dd>
<dd><code>reassociate</code> - should always be false</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>ResourceException</code></dd>
</dl>
</li>
</ul>
<a name="handleReleased-ConnectionTrackingInterceptor-ConnectionInfo-ConnectionReturnAction-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleReleased</h4>
<pre>public&nbsp;void&nbsp;handleReleased(ConnectionTrackingInterceptor&nbsp;interceptor,
ConnectionInfo&nbsp;connectionInfo,
ConnectionReturnAction&nbsp;action)</pre>
<div class="block">Removes the released collection from the garbage collection reference tracker, since this
connection is being release via a normal close method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interceptor</code> - ignored</dd>
<dd><code>connectionInfo</code> - the connection that was released</dd>
<dd><code>action</code> - ignored</dd>
</dl>
</li>
</ul>
<a name="stackTraceToString-java.lang.StackTraceElement:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stackTraceToString</h4>
<pre>public static&nbsp;java.lang.String&nbsp;stackTraceToString(java.lang.StackTraceElement[]&nbsp;stackTrace)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../org/apache/openejb/resource/AutoConnectionTracker.ConnectionInvocationHandler.html" title="class in org.apache.openejb.resource"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openejb/resource/AutoConnectionTracker.html" target="_top">Frames</a></li>
<li><a href="AutoConnectionTracker.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>