| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SessionContext</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="SessionContext"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/SessionBean.html" title="interface in jakarta.ejb"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/ejb/SessionSynchronization.html" title="interface in jakarta.ejb"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/ejb/SessionContext.html" target="_top">Frames</a></li> |
| <li><a href="SessionContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 SessionContext" class="title">Interface SessionContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../jakarta/ejb/EJBContext.html" title="interface in jakarta.ejb">EJBContext</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SessionContext</span> |
| extends <a href="../../jakarta/ejb/EJBContext.html" title="interface in jakarta.ejb">EJBContext</a></pre> |
| <div class="block">The SessionContext interface provides access to the runtime session context that the container provides for a session |
| bean instance. The container passes the SessionContext interface to an instance after the instance has been created. |
| The session context remains associated with the instance for the lifetime of the instance.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>EJB 1.0</dd> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/examples/transaction-rollback.html">transaction-rollback</a>, <a href="../../../../../tomee-9.0/examples/testing-security-2.html">testing-security-2</a>, <a href="../../../../../tomee-9.0/examples/ejb-remote-call-2.html">ejb-remote-call-2</a>, <a href="../../../../../tomee-9.0/examples/ejb-examples.html">ejb-examples</a>, <a href="../../../../../tomee-9.0/examples/decorators.html">decorators</a>, <a href="../../../../../tomee-9.0/examples/alternate-descriptors.html">alternate-descriptors</a></dd> |
| <dt><span class="simpleTagLabel">Examples (es):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/es/examples/alternate-descriptors.html">alternate-descriptors</a></dd> |
| <dt><span class="simpleTagLabel">Examples (pt):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/pt/examples/alternate-descriptors.html">alternate-descriptors</a></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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/SessionContext.html#getBusinessObject-java.lang.Class-">getBusinessObject</a></span>(java.lang.Class<T> businessInterface)</code> |
| <div class="block">Obtain an object that can be used to invoke the current bean through a particular business interface view or its |
| no-interface view.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/ejb/EJBLocalObject.html" title="interface in jakarta.ejb">EJBLocalObject</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/SessionContext.html#getEJBLocalObject--">getEJBLocalObject</a></span>()</code> |
| <div class="block">Obtain a reference to the enterprise bean local object that is associated with the instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/ejb/EJBObject.html" title="interface in jakarta.ejb">EJBObject</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/SessionContext.html#getEJBObject--">getEJBObject</a></span>()</code> |
| <div class="block">Obtain a reference to the enterprise bean object that is currently associated with the instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Class</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/SessionContext.html#getInvokedBusinessInterface--">getInvokedBusinessInterface</a></span>()</code> |
| <div class="block">Obtain the business interface or no-interface view type through which the current business method invocation was |
| made.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/SessionContext.html#wasCancelCalled--">wasCancelCalled</a></span>()</code> |
| <div class="block">Check whether a client invoked the <code>cancel</code> method on the client <code>Future</code> object corresponding |
| to the currently executing asynchronous business method.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.jakarta.ejb.EJBContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.ejb.<a href="../../jakarta/ejb/EJBContext.html" title="interface in jakarta.ejb">EJBContext</a></h3> |
| <code><a href="../../jakarta/ejb/EJBContext.html#getCallerPrincipal--">getCallerPrincipal</a>, <a href="../../jakarta/ejb/EJBContext.html#getContextData--">getContextData</a>, <a href="../../jakarta/ejb/EJBContext.html#getEJBHome--">getEJBHome</a>, <a href="../../jakarta/ejb/EJBContext.html#getEJBLocalHome--">getEJBLocalHome</a>, <a href="../../jakarta/ejb/EJBContext.html#getRollbackOnly--">getRollbackOnly</a>, <a href="../../jakarta/ejb/EJBContext.html#getTimerService--">getTimerService</a>, <a href="../../jakarta/ejb/EJBContext.html#getUserTransaction--">getUserTransaction</a>, <a href="../../jakarta/ejb/EJBContext.html#isCallerInRole-java.lang.String-">isCallerInRole</a>, <a href="../../jakarta/ejb/EJBContext.html#lookup-java.lang.String-">lookup</a>, <a href="../../jakarta/ejb/EJBContext.html#setRollbackOnly--">setRollbackOnly</a></code></li> |
| </ul> |
| </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="getEJBLocalObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEJBLocalObject</h4> |
| <pre><a href="../../jakarta/ejb/EJBLocalObject.html" title="interface in jakarta.ejb">EJBLocalObject</a> getEJBLocalObject() |
| throws java.lang.IllegalStateException</pre> |
| <div class="block">Obtain a reference to the enterprise bean local object that is associated with the instance. |
| |
| <p> |
| An instance of a session bean can call this method at anytime between the <code>PostConstruct</code> or |
| <code>ejbCreate</code> and <code>PreDestroy</code> or <code>ejbRemove</code> methods, including from within these |
| methods. |
| |
| <p> |
| An instance can use this method, for example, when it wants to pass a reference to itself in a method argument or |
| result.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enterprise bean local object currently associated with the instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if the instance invokes this method while the instance is in a state that |
| does not allow the instance to invoke this method, or if the instance does not have a local interface.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>EJB 2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEJBObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEJBObject</h4> |
| <pre><a href="../../jakarta/ejb/EJBObject.html" title="interface in jakarta.ejb">EJBObject</a> getEJBObject() |
| throws java.lang.IllegalStateException</pre> |
| <div class="block">Obtain a reference to the enterprise bean object that is currently associated with the instance. |
| |
| <p> |
| An instance of a session enterprise Bean can call this method at anytime between the <code>PostConstruct</code> or |
| <code>ejbCreate</code> and the <code>PreDestroy</code> or <code>ejbRemove</code> methods, including from within these |
| methods. |
| |
| <p> |
| An instance can use this method, for example, when it wants to pass a reference to itself in a method argument or |
| result.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enterprise bean object currently associated with the instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if the instance invokes this method while the instance is in a state that |
| does not allow the instance to invoke this method, or if the instance does not have a remote interface.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBusinessObject-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBusinessObject</h4> |
| <pre><T> T getBusinessObject(java.lang.Class<T> businessInterface) |
| throws java.lang.IllegalStateException</pre> |
| <div class="block">Obtain an object that can be used to invoke the current bean through a particular business interface view or its |
| no-interface view.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - a T object.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>businessInterface</code> - One of the local business interfaces or remote business interfaces for this session bean. In |
| addition, the bean class type can be used to acquire a reference to the bean's no-interface view.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The business object corresponding to the given business interface or no-interface view.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if invoked with a parameter that does not correspond to one of the beans' |
| business interfaces or no-interface view.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>EJB 3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInvokedBusinessInterface--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInvokedBusinessInterface</h4> |
| <pre>java.lang.Class getInvokedBusinessInterface() |
| throws java.lang.IllegalStateException</pre> |
| <div class="block">Obtain the business interface or no-interface view type through which the current business method invocation was |
| made.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Class</code> object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if this method is called and the bean has not been invoked through a business |
| interface or no-interface view.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>EJB 3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="wasCancelCalled--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>wasCancelCalled</h4> |
| <pre>boolean wasCancelCalled() |
| throws java.lang.IllegalStateException</pre> |
| <div class="block">Check whether a client invoked the <code>cancel</code> method on the client <code>Future</code> object corresponding |
| to the currently executing asynchronous business method.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the client has invoked <code>Future.cancel</code> with a value of true for the |
| <code>mayInterruptIfRunning</code> parameter.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if not invoked from within an asynchronous business method invocation with |
| return type <code>Future<V></code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>EJB 3.1</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/SessionBean.html" title="interface in jakarta.ejb"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/ejb/SessionSynchronization.html" title="interface in jakarta.ejb"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/ejb/SessionContext.html" target="_top">Frames</a></li> |
| <li><a href="SessionContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
