blob: 862376025c417dc265a72e8d8b306a5822f4500f [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>SessionBean</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="SessionBean";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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/Schedules.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/ejb/SessionContext.html" title="interface in jakarta.ejb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/ejb/SessionBean.html" target="_top">Frames</a></li>
<li><a href="SessionBean.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 SessionBean" class="title">Interface SessionBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../jakarta/ejb/EnterpriseBean.html" title="interface in jakarta.ejb">EnterpriseBean</a>, java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SessionBean</span>
extends <a href="../../jakarta/ejb/EnterpriseBean.html" title="interface in jakarta.ejb">EnterpriseBean</a></pre>
<div class="block">The SessionBean interface defines methods that the enterprise bean container uses to notify a session bean instance
of the instance's life cycle events.
<p>
As of EJB 3.0 it is no longer required that a session bean class 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/SessionBean.html#ejbActivate--">ejbActivate</a></span>()</code>
<div class="block">The activate method is called when a stateful session bean instance is activated from its "passive" state.</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/SessionBean.html#ejbPassivate--">ejbPassivate</a></span>()</code>
<div class="block">The passivate method is called before a stateful session bean instance enters the "passive" state.</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/SessionBean.html#ejbRemove--">ejbRemove</a></span>()</code>
<div class="block">A container invokes this method before it ends the life of the session object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/SessionBean.html#setSessionContext-jakarta.ejb.SessionContext-">setSessionContext</a></span>(<a href="../../jakarta/ejb/SessionContext.html" title="interface in jakarta.ejb">SessionContext</a>&nbsp;ctx)</code>
<div class="block">Set the associated session context.</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="setSessionContext-jakarta.ejb.SessionContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSessionContext</h4>
<pre>void&nbsp;setSessionContext(<a href="../../jakarta/ejb/SessionContext.html" title="interface in jakarta.ejb">SessionContext</a>&nbsp;ctx)
throws <a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a>,
java.rmi.RemoteException</pre>
<div class="block">Set the associated session context. The container calls this method after the instance creation.
<p>
The session bean instance should store the reference to the context object in an instance variable.
<p>
This method is called with no transaction context.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctx</code> - A SessionContext interface for the instance.</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
applications written for the enterprise bean 1.0 specification. Enterprise beans written for the EJB 1.1
specification should throw the jakarta.ejb.EJBException instead of this exception. Enterprise beans written for the
EJB2.0 and higher specifications must throw the jakarta.ejb.EJBException instead of this exception.</dd>
</dl>
</li>
</ul>
<a name="ejbRemove--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ejbRemove</h4>
<pre>void&nbsp;ejbRemove()
throws <a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a>,
java.rmi.RemoteException</pre>
<div class="block">A container invokes this method before it ends the life of the session object. This happens as a result of a client's
invoking a remove operation, or when a container decides to terminate the session object after a timeout.
<p>
This method is called with no 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
specification should throw the jakarta.ejb.EJBException instead of this exception. Enterprise beans written for the
EJB2.0 and higher specifications must throw the jakarta.ejb.EJBException instead of this exception.</dd>
</dl>
</li>
</ul>
<a name="ejbActivate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ejbActivate</h4>
<pre>void&nbsp;ejbActivate()
throws <a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a>,
java.rmi.RemoteException</pre>
<div class="block">The activate method is called when a stateful session bean instance is activated from its "passive" state. The
instance should acquire any resource that it has released earlier in the <code>ejbPassivate</code> method.
<p>
This method is called with no 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
specification should throw the jakarta.ejb.EJBException instead of this exception. Enterprise beans written for the
EJB2.0 and higher specifications must throw the jakarta.ejb.EJBException instead of this exception.</dd>
</dl>
</li>
</ul>
<a name="ejbPassivate--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ejbPassivate</h4>
<pre>void&nbsp;ejbPassivate()
throws <a href="../../jakarta/ejb/EJBException.html" title="class in jakarta.ejb">EJBException</a>,
java.rmi.RemoteException</pre>
<div class="block">The passivate method is called before a stateful session bean instance enters the "passive" state. The instance
should release any resources that it can re-acquire later in the <code>ejbActivate</code> method.
<p>
After the passivate method completes, the instance must be in a state that allows the container to use the Java
Serialization protocol to externalize and store away the instance's state.
<p>
This method is called with no 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
specification should throw the jakarta.ejb.EJBException instead of this exception. Enterprise beans written for the
EJB2.0 and higher specifications must throw the jakarta.ejb.EJBException instead of this exception.</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/Schedules.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/ejb/SessionContext.html" title="interface in jakarta.ejb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/ejb/SessionBean.html" target="_top">Frames</a></li>
<li><a href="SessionBean.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>