blob: 266ce997e2a6bc157b60885f6cc40159c033664f [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>SessionSynchronization</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SessionSynchronization";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../jakarta/ejb/SessionContext.html" title="interface in jakarta.ejb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/ejb/Singleton.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/ejb/SessionSynchronization.html" target="_top">Frames</a></li>
<li><a href="SessionSynchronization.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>Constr&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>Constr&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">jakarta.ejb</div>
<h2 title="Interface SessionSynchronization" class="title">Interface SessionSynchronization</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SessionSynchronization</span></pre>
<div class="block"><p>
The SessionSynchronization interface allows a stateful session bean instance to be notified by its container of
transaction boundaries.
<p>
Only a stateful session bean with container-managed transaction demarcation can receive session synchronization
notifications. Other bean types must not implement the SessionSynchronization interface or use the session
synchronization annotations.
<p>
A stateful session bean class is not required to implement this interface.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>EJB 1.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../jakarta/ejb/SessionSynchronization.html#afterBegin--">afterBegin</a></span>()</code>
<div class="block">The <code>afterBegin</code> method notifies a stateful session bean instance that a new transaction has started, and
that the subsequent business methods on the instance will be invoked in the context of the transaction.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/SessionSynchronization.html#afterCompletion-boolean-">afterCompletion</a></span>(boolean&nbsp;committed)</code>
<div class="block">The <code>afterCompletion</code> method notifies a stateful session bean instance that a transaction commit protocol
has completed, and tells the instance whether the transaction has been committed or rolled back.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/SessionSynchronization.html#beforeCompletion--">beforeCompletion</a></span>()</code>
<div class="block">The <code>beforeCompletion</code> method notifies a stateful session bean instance that a transaction is about to be
committed.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="afterBegin--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterBegin</h4>
<pre>void&nbsp;afterBegin()
throws <a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a>,
java.rmi.RemoteException</pre>
<div class="block">The <code>afterBegin</code> method notifies a stateful session bean instance that a new transaction has started, and
that the subsequent business methods on the instance will be invoked in the context of the transaction.
<p>
The instance can use this method, for example, to read data from a database and cache the data in the instance
fields.
<p>
This method executes in the proper transaction context.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - Thrown by the method to indicate a failure caused by a system-level error.</dd>
<dd><code>java.rmi.RemoteException</code> - This exception is defined in the method signature to provide backward compatibility for
enterprise beans written for the enterprise bean 1.0 specification. Enterprise beans written for the EJB 1.1 and
later specifications should throw the jakarta.ejb.EJBException instead of this exception. Enterprise beans written
for the EJB 2.0 and later specifications must not throw the java.rmi.RemoteException.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../jakarta/ejb/AfterBegin.html" title="annotation in jakarta.ejb"><code>AfterBegin</code></a></dd>
</dl>
</li>
</ul>
<a name="beforeCompletion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beforeCompletion</h4>
<pre>void&nbsp;beforeCompletion()
throws <a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a>,
java.rmi.RemoteException</pre>
<div class="block">The <code>beforeCompletion</code> method notifies a stateful session bean instance that a transaction is about to be
committed. The instance can use this method, for example, to write any cached data to a database.
<p>
This method executes in the proper transaction context.
<p>
<b>Note:</b> The instance may still cause the container to rollback the transaction by invoking the
<code>setRollbackOnly</code> method on the session context, or by throwing an exception.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - Thrown by the method to indicate a failure caused by a system-level error.</dd>
<dd><code>java.rmi.RemoteException</code> - This exception is defined in the method signature to provide backward compatibility for
enterprise beans written for the enterprise bean 1.0 specification. Enterprise beans written for the EJB 1.1 and
later specification should throw the jakarta.ejb.EJBException instead of this exception. Enterprise beans written for
the EJB 2.0 and later specifications must not throw the java.rmi.RemoteException.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../jakarta/ejb/BeforeCompletion.html" title="annotation in jakarta.ejb"><code>BeforeCompletion</code></a></dd>
</dl>
</li>
</ul>
<a name="afterCompletion-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>afterCompletion</h4>
<pre>void&nbsp;afterCompletion(boolean&nbsp;committed)
throws <a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a>,
java.rmi.RemoteException</pre>
<div class="block">The <code>afterCompletion</code> method notifies a stateful session bean instance that a transaction commit protocol
has completed, and tells the instance whether the transaction has been committed or rolled back.
<p>
This method executes with no transaction context.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>committed</code> - True if the transaction has been committed, false if is has been rolled back.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a></code> - Thrown by the method to indicate a failure caused by a system-level error.</dd>
<dd><code>java.rmi.RemoteException</code> - This exception is defined in the method signature to provide backward compatibility for
enterprise beans written for the enterprise bean 1.0 specification. Enterprise beans written for the EJB 1.1 and
later specification should throw the jakarta.ejb.EJBException instead of this exception. Enterprise beans written for
the EJB 2.0 and later specifications must not throw the java.rmi.RemoteException.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../jakarta/ejb/AfterCompletion.html" title="annotation in jakarta.ejb"><code>AfterCompletion</code></a></dd>
</dl>
</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="../../jakarta/ejb/SessionContext.html" title="interface in jakarta.ejb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/ejb/Singleton.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/ejb/SessionSynchronization.html" target="_top">Frames</a></li>
<li><a href="SessionSynchronization.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>Constr&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>Constr&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>