blob: 2f542a7e49d775e7cf90f5c2d18e0855f9fa4525 [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>StatelessInstanceManager</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="StatelessInstanceManager";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All 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><a href="../../../../../org/apache/openejb/core/stateless/StatelessEjbObjectHandler.html" title="class in org.apache.openejb.core.stateless"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openejb/core/stateless/StatelessInstanceManager.html" target="_top">Frames</a></li>
<li><a href="StatelessInstanceManager.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>Nested&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.core.stateless</div>
<h2 title="Class StatelessInstanceManager" class="title">Class StatelessInstanceManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.openejb.core.stateless.StatelessInstanceManager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">StatelessInstanceManager</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/core/stateless/StatelessInstanceManager.html#StatelessInstanceManager-org.apache.openejb.spi.SecurityService-org.apache.openejb.util.Duration-org.apache.openejb.util.Duration-org.apache.openejb.util.Pool.Builder-int-java.util.concurrent.ScheduledExecutorService-">StatelessInstanceManager</a></span>(<a href="../../../../../org/apache/openejb/spi/SecurityService.html" title="interface in org.apache.openejb.spi">SecurityService</a>&nbsp;securityService,
<a href="../../../../../org/apache/openejb/util/Duration.html" title="class in org.apache.openejb.util">Duration</a>&nbsp;accessTimeout,
<a href="../../../../../org/apache/openejb/util/Duration.html" title="class in org.apache.openejb.util">Duration</a>&nbsp;closeTimeout,
<a href="../../../../../org/apache/openejb/util/Pool.Builder.html" title="class in org.apache.openejb.util">Pool.Builder</a>&nbsp;poolBuilder,
int&nbsp;callbackThreads,
java.util.concurrent.ScheduledExecutorService&nbsp;ses)</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateless/StatelessInstanceManager.html#deploy-org.apache.openejb.BeanContext-">deploy</a></span>(<a href="../../../../../org/apache/openejb/BeanContext.html" title="class in org.apache.openejb">BeanContext</a>&nbsp;beanContext)</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/core/stateless/StatelessInstanceManager.html#destroy--">destroy</a></span>()</code>&nbsp;</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/core/stateless/StatelessInstanceManager.html#discardInstance-org.apache.openejb.core.ThreadContext-java.lang.Object-">discardInstance</a></span>(<a href="../../../../../org/apache/openejb/core/ThreadContext.html" title="class in org.apache.openejb.core">ThreadContext</a>&nbsp;callContext,
java.lang.Object&nbsp;bean)</code>
<div class="block">This method is called to release the semaphore in case of the business method
throwing a system exception</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openejb/core/stateless/Instance.html" title="class in org.apache.openejb.core.stateless">Instance</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateless/StatelessInstanceManager.html#getInstance-org.apache.openejb.core.ThreadContext-">getInstance</a></span>(<a href="../../../../../org/apache/openejb/core/ThreadContext.html" title="class in org.apache.openejb.core">ThreadContext</a>&nbsp;callContext)</code>
<div class="block">Removes an instance from the pool and returns it for use
by the container in business methods.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateless/StatelessInstanceManager.html#poolInstance-org.apache.openejb.core.ThreadContext-java.lang.Object-">poolInstance</a></span>(<a href="../../../../../org/apache/openejb/core/ThreadContext.html" title="class in org.apache.openejb.core">ThreadContext</a>&nbsp;callContext,
java.lang.Object&nbsp;bean)</code>
<div class="block">All instances are removed from the pool in getInstance(...).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/stateless/StatelessInstanceManager.html#undeploy-org.apache.openejb.BeanContext-">undeploy</a></span>(<a href="../../../../../org/apache/openejb/BeanContext.html" title="class in org.apache.openejb">BeanContext</a>&nbsp;beanContext)</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="StatelessInstanceManager-org.apache.openejb.spi.SecurityService-org.apache.openejb.util.Duration-org.apache.openejb.util.Duration-org.apache.openejb.util.Pool.Builder-int-java.util.concurrent.ScheduledExecutorService-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StatelessInstanceManager</h4>
<pre>public&nbsp;StatelessInstanceManager(<a href="../../../../../org/apache/openejb/spi/SecurityService.html" title="interface in org.apache.openejb.spi">SecurityService</a>&nbsp;securityService,
<a href="../../../../../org/apache/openejb/util/Duration.html" title="class in org.apache.openejb.util">Duration</a>&nbsp;accessTimeout,
<a href="../../../../../org/apache/openejb/util/Duration.html" title="class in org.apache.openejb.util">Duration</a>&nbsp;closeTimeout,
<a href="../../../../../org/apache/openejb/util/Pool.Builder.html" title="class in org.apache.openejb.util">Pool.Builder</a>&nbsp;poolBuilder,
int&nbsp;callbackThreads,
java.util.concurrent.ScheduledExecutorService&nbsp;ses)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="destroy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre>public&nbsp;void&nbsp;destroy()</pre>
</li>
</ul>
<a name="getInstance-org.apache.openejb.core.ThreadContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/openejb/core/stateless/Instance.html" title="class in org.apache.openejb.core.stateless">Instance</a>&nbsp;getInstance(<a href="../../../../../org/apache/openejb/core/ThreadContext.html" title="class in org.apache.openejb.core">ThreadContext</a>&nbsp;callContext)
throws <a href="../../../../../org/apache/openejb/OpenEJBException.html" title="class in org.apache.openejb">OpenEJBException</a></pre>
<div class="block">Removes an instance from the pool and returns it for use
by the container in business methods.
If the pool is at it's limit the StrictPooling flag will
cause this thread to wait.
If StrictPooling is not enabled this method will create a
new stateless bean instance performing all required injection
and callbacks before returning it in a method ready state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>callContext</code> - ThreadContext</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/OpenEJBException.html" title="class in org.apache.openejb">OpenEJBException</a></code></dd>
</dl>
</li>
</ul>
<a name="poolInstance-org.apache.openejb.core.ThreadContext-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>poolInstance</h4>
<pre>public&nbsp;void&nbsp;poolInstance(<a href="../../../../../org/apache/openejb/core/ThreadContext.html" title="class in org.apache.openejb.core">ThreadContext</a>&nbsp;callContext,
java.lang.Object&nbsp;bean)
throws <a href="../../../../../org/apache/openejb/OpenEJBException.html" title="class in org.apache.openejb">OpenEJBException</a></pre>
<div class="block">All instances are removed from the pool in getInstance(...). They are only
returned by the StatelessContainer via this method under two circumstances.
1. The business method returns normally
2. The business method throws an application exception
Instances are not returned to the pool if the business method threw a system
exception.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>callContext</code> - ThreadContext</dd>
<dd><code>bean</code> - Object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/OpenEJBException.html" title="class in org.apache.openejb">OpenEJBException</a></code></dd>
</dl>
</li>
</ul>
<a name="discardInstance-org.apache.openejb.core.ThreadContext-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>discardInstance</h4>
<pre>public&nbsp;void&nbsp;discardInstance(<a href="../../../../../org/apache/openejb/core/ThreadContext.html" title="class in org.apache.openejb.core">ThreadContext</a>&nbsp;callContext,
java.lang.Object&nbsp;bean)
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<div class="block">This method is called to release the semaphore in case of the business method
throwing a system exception</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>callContext</code> - ThreadContext</dd>
<dd><code>bean</code> - Object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code></dd>
</dl>
</li>
</ul>
<a name="deploy-org.apache.openejb.BeanContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deploy</h4>
<pre>public&nbsp;void&nbsp;deploy(<a href="../../../../../org/apache/openejb/BeanContext.html" title="class in org.apache.openejb">BeanContext</a>&nbsp;beanContext)
throws <a href="../../../../../org/apache/openejb/OpenEJBException.html" title="class in org.apache.openejb">OpenEJBException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/OpenEJBException.html" title="class in org.apache.openejb">OpenEJBException</a></code></dd>
</dl>
</li>
</ul>
<a name="undeploy-org.apache.openejb.BeanContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>undeploy</h4>
<pre>public&nbsp;void&nbsp;undeploy(<a href="../../../../../org/apache/openejb/BeanContext.html" title="class in org.apache.openejb">BeanContext</a>&nbsp;beanContext)</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><a href="../../../../../org/apache/openejb/core/stateless/StatelessEjbObjectHandler.html" title="class in org.apache.openejb.core.stateless"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openejb/core/stateless/StatelessInstanceManager.html" target="_top">Frames</a></li>
<li><a href="StatelessInstanceManager.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>Nested&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>