| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ManagedTaskListener</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="ManagedTaskListener"; |
| } |
| } |
| 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="../../../javax/enterprise/concurrent/ManagedTask.html" title="interface in javax.enterprise.concurrent"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/enterprise/concurrent/ManagedThreadFactory.html" title="interface in javax.enterprise.concurrent"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/enterprise/concurrent/ManagedTaskListener.html" target="_top">Frames</a></li> |
| <li><a href="ManagedTaskListener.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">javax.enterprise.concurrent</div> |
| <h2 title="Interface ManagedTaskListener" class="title">Interface ManagedTaskListener</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ManagedTaskListener</span></pre> |
| <div class="block">A ManagedTaskListener is used to monitor the state of a task's Future. |
| It can be registered with a <a href="../../../javax/enterprise/concurrent/ManagedExecutorService.html" title="interface in javax.enterprise.concurrent"><code>ManagedExecutorService</code></a> using the |
| <code>submit</code> methods and will be invoked when the state of the |
| <code>Future</code> changes. |
| Each listener method will run with unspecified context. |
| All listeners run without an explicit transaction |
| (they do not enlist in the application component's transaction). If a transaction is required, use a |
| <code>javax.transaction.UserTransaction</code> instance. |
| <p> |
| |
| Each listener instance will be invoked within the same process in which the listener was registered. |
| If a single listener is submitted to multiple ManagedExecutorService instances, the |
| listener object may be invoked concurrently by multiple threads.<p> |
| |
| Each listener method supports a minimum quality of service of at-most-once. A listener is not |
| guaranteed to be invoked due to a process failure or termination. |
| <p> |
| <b>State Transition Diagram</b> |
| <p> |
| The following state transition figure and tables describe |
| the possible task lifecycle events that can occur when a |
| ManagedTaskListener is associated with a task. Each method is invoked |
| when the state of the <code>Future</code> moves from one state to another. |
| <p> |
| <img src="doc-files/TaskListener_StateDiagram.gif"><p> |
| |
| <b>A. The task runs normally:</b> |
| <table> |
| <tr><td valign="top"><strong><u>Sequence</u></strong></td><td valign="top"><strong><u>State</u></strong></td><td valign="top"><strong><u>Action</u></strong></td><td valign="top"><strong><u>Listener</u></strong></td><td valign="top"><strong><u>Next state</u></strong></td></tr> |
| |
| <tr><td valign="top">1.</td><td valign="top">None</td><td valign="top">submit()</td><td valign="top">taskSubmitted</td><td valign="top">Submitted</td></tr> |
| <tr><td valign="top">2.</td><td valign="top">Submitted</td><td valign="top">About to call run()</td><td valign="top">taskStarting</td><td valign="top">Started</td></tr> |
| <tr><td valign="top">3.</td><td valign="top">Started</td><td valign="top">Exit run()</td><td valign="top">taskDone</td><td valign="top">Done</td></tr> |
| |
| </table><p> |
| |
| <b>B. The task is cancelled during taskSubmitted():</b> |
| <table> |
| <tr><td valign="top"><strong><u>Sequence</u></strong></td><td valign="top"><strong><u>State</u></strong></td><td valign="top"><strong><u>Action</u></strong></td><td valign="top"><strong><u>Listener</u></strong></td><td valign="top"><strong><u>Next state</u></strong></td></tr> |
| <tr><td valign="top">1.</td><td valign="top">None</td><td valign="top">submit()</td><td valign="top">taskSubmitted<br>Future is cancelled.</td><td valign="top">Cancelling</td></tr> |
| |
| <tr><td valign="top">2.</td><td valign="top">Cancelling</td><td valign="top"> </td><td valign="top">taskAborted</td><td valign="top">Cancelled</td></tr> |
| <tr><td valign="top">3.</td><td valign="top">Cancelled</td><td valign="top"> </td><td valign="top">taskDone</td><td valign="top">Done</td></tr> |
| </table><p> |
| |
| <b>C. The task is cancelled or aborted after submitted, but before started:</b> |
| |
| <table> |
| <tr><td valign="top"><strong><u>Sequence</u></strong></td><td valign="top"><strong><u>State</u></strong></td><td valign="top"><strong><u>Action</u></strong></td><td valign="top"><strong><u>Listener</u></strong></td><td valign="top"><strong><u>Next state</u></strong></td></tr> |
| <tr><td valign="top">1.</td><td valign="top">None</td><td valign="top">submit()</td><td valign="top">taskSubmitted</td><td valign="top">Submitted</td></tr> |
| <tr><td valign="top">2.</td><td valign="top">Submitted</td><td valign="top">cancel() or abort</td><td valign="top">taskAborted</td><td valign="top">Cancelled</td></tr> |
| |
| <tr><td valign="top">3.</td><td valign="top">Cancelled</td><td valign="top"> </td><td valign="top">taskDone</td><td valign="top">Done</td></tr> |
| </table> <p> |
| |
| <b>D. The task is cancelled when it is starting:</b> |
| <table> |
| <tr><td valign="top"><strong><u>Sequence</u></strong></td><td valign="top"><strong><u>State</u></strong></td><td valign="top"><strong><u>Action</u></strong></td><td valign="top"><strong><u>Listener</u></strong></td><td valign="top"><strong><u>Next state</u></strong></td></tr> |
| |
| <tr><td valign="top">1.</td><td valign="top">None</td><td valign="top">submit()</td><td valign="top">taskSubmitted</td><td valign="top">Submitted</td></tr> |
| <tr><td valign="top">2.</td><td valign="top">Submitted</td><td valign="top">About to call run()</td><td valign="top">taskStarting<br>Future is cancelled.</td><td valign="top">Cancelling</td></tr> |
| <tr><td valign="top">3.</td><td valign="top">Cancelling</td><td valign="top"> </td><td valign="top">taskAborted</td><td valign="top">Cancelled</td></tr> |
| |
| <tr><td valign="top">4.</td><td valign="top">Cancelled</td><td valign="top"> </td><td valign="top">taskDone</td><td valign="top">Done</td></tr> |
| </table> |
| <P></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>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"> </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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/enterprise/concurrent/ManagedTaskListener.html#taskAborted-java.util.concurrent.Future-javax.enterprise.concurrent.ManagedExecutorService-java.lang.Object-java.lang.Throwable-">taskAborted</a></span>(java.util.concurrent.Future<?> future, |
| <a href="../../../javax/enterprise/concurrent/ManagedExecutorService.html" title="interface in javax.enterprise.concurrent">ManagedExecutorService</a> executor, |
| java.lang.Object task, |
| java.lang.Throwable exception)</code> |
| <div class="block">Called when a task's Future has been cancelled anytime during the life of a task.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/enterprise/concurrent/ManagedTaskListener.html#taskDone-java.util.concurrent.Future-javax.enterprise.concurrent.ManagedExecutorService-java.lang.Object-java.lang.Throwable-">taskDone</a></span>(java.util.concurrent.Future<?> future, |
| <a href="../../../javax/enterprise/concurrent/ManagedExecutorService.html" title="interface in javax.enterprise.concurrent">ManagedExecutorService</a> executor, |
| java.lang.Object task, |
| java.lang.Throwable exception)</code> |
| <div class="block">Called when a submitted task has completed running, either successfully or |
| failed due to any exception thrown from the task, task being cancelled, |
| rejected, or aborted.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/enterprise/concurrent/ManagedTaskListener.html#taskStarting-java.util.concurrent.Future-javax.enterprise.concurrent.ManagedExecutorService-java.lang.Object-">taskStarting</a></span>(java.util.concurrent.Future<?> future, |
| <a href="../../../javax/enterprise/concurrent/ManagedExecutorService.html" title="interface in javax.enterprise.concurrent">ManagedExecutorService</a> executor, |
| java.lang.Object task)</code> |
| <div class="block">This method is called before the task is about to start.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/enterprise/concurrent/ManagedTaskListener.html#taskSubmitted-java.util.concurrent.Future-javax.enterprise.concurrent.ManagedExecutorService-java.lang.Object-">taskSubmitted</a></span>(java.util.concurrent.Future<?> future, |
| <a href="../../../javax/enterprise/concurrent/ManagedExecutorService.html" title="interface in javax.enterprise.concurrent">ManagedExecutorService</a> executor, |
| java.lang.Object task)</code> |
| <div class="block">Called after the task has been submitted to the Executor.</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="taskSubmitted-java.util.concurrent.Future-javax.enterprise.concurrent.ManagedExecutorService-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>taskSubmitted</h4> |
| <pre>void taskSubmitted(java.util.concurrent.Future<?> future, |
| <a href="../../../javax/enterprise/concurrent/ManagedExecutorService.html" title="interface in javax.enterprise.concurrent">ManagedExecutorService</a> executor, |
| java.lang.Object task)</pre> |
| <div class="block">Called after the task has been submitted to the Executor. The task will not enter the |
| starting state until the taskSubmitted listener has completed. |
| This method may be called from the same thread that the task was submitted with. |
| <p> |
| This event does not indicate that the task has been scheduled for execution.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>future</code> - the <code>Future</code> instance that was created when the task was submitted.</dd> |
| <dd><code>executor</code> - the executor used to run the associated Future.</dd> |
| <dd><code>task</code> - the task that was submitted.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="taskAborted-java.util.concurrent.Future-javax.enterprise.concurrent.ManagedExecutorService-java.lang.Object-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>taskAborted</h4> |
| <pre>void taskAborted(java.util.concurrent.Future<?> future, |
| <a href="../../../javax/enterprise/concurrent/ManagedExecutorService.html" title="interface in javax.enterprise.concurrent">ManagedExecutorService</a> executor, |
| java.lang.Object task, |
| java.lang.Throwable exception)</pre> |
| <div class="block">Called when a task's Future has been cancelled anytime during the life of a task. |
| This method may be called after taskDone(). The <code>Future.isCancelled()</code> |
| method returns false if the task was aborted through another means other than |
| <code>Future.cancel(boolean)</code>. |
| The exception argument will represent the cause of the cancellation: |
| <ul> |
| <li><code>CancellationException</code> if the task was cancelled, |
| <li><a href="../../../javax/enterprise/concurrent/SkippedException.html" title="class in javax.enterprise.concurrent"><code>SkippedException</code></a> if the task was skipped or |
| <li><a href="../../../javax/enterprise/concurrent/AbortedException.html" title="class in javax.enterprise.concurrent"><code>AbortedException</code></a> if the task failed to start for another reason. |
| </ul> |
| The <code>AbortedException.getCause()</code> method will return the exception that |
| caused the task to fail to start.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>future</code> - the <code>Future</code> instance that was created when the task was submitted.</dd> |
| <dd><code>executor</code> - the executor used to run the associated Future.</dd> |
| <dd><code>task</code> - the task that was submitted.</dd> |
| <dd><code>exception</code> - the cause of the task abort.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="taskDone-java.util.concurrent.Future-javax.enterprise.concurrent.ManagedExecutorService-java.lang.Object-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>taskDone</h4> |
| <pre>void taskDone(java.util.concurrent.Future<?> future, |
| <a href="../../../javax/enterprise/concurrent/ManagedExecutorService.html" title="interface in javax.enterprise.concurrent">ManagedExecutorService</a> executor, |
| java.lang.Object task, |
| java.lang.Throwable exception)</pre> |
| <div class="block">Called when a submitted task has completed running, either successfully or |
| failed due to any exception thrown from the task, task being cancelled, |
| rejected, or aborted.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>future</code> - the <code>Future</code> instance that was created when the task was submitted.</dd> |
| <dd><code>executor</code> - the executor used to run the associated Future.</dd> |
| <dd><code>task</code> - the task that was submitted.</dd> |
| <dd><code>exception</code> - if not null, the exception that caused the task to fail.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="taskStarting-java.util.concurrent.Future-javax.enterprise.concurrent.ManagedExecutorService-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>taskStarting</h4> |
| <pre>void taskStarting(java.util.concurrent.Future<?> future, |
| <a href="../../../javax/enterprise/concurrent/ManagedExecutorService.html" title="interface in javax.enterprise.concurrent">ManagedExecutorService</a> executor, |
| java.lang.Object task)</pre> |
| <div class="block">This method is called before the task is about to start. The task will |
| not enter the starting state until the taskSubmitted listener has completed. This method |
| may be called from the same thread that the task was submitted with.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>future</code> - the <code>Future</code> instance that was created when the task was submitted.</dd> |
| <dd><code>executor</code> - the executor used to run the associated Future.</dd> |
| <dd><code>task</code> - the task that was submitted.</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="../../../javax/enterprise/concurrent/ManagedTask.html" title="interface in javax.enterprise.concurrent"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/enterprise/concurrent/ManagedThreadFactory.html" title="interface in javax.enterprise.concurrent"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/enterprise/concurrent/ManagedTaskListener.html" target="_top">Frames</a></li> |
| <li><a href="ManagedTaskListener.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> |
