| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Sat May 17 12:14:26 CEST 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>QueueListener (Apache Felix iPOJO ~ JavaDoc 1.12.0 API)</title> |
| <meta name="date" content="2014-05-17"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="QueueListener (Apache Felix iPOJO ~ JavaDoc 1.12.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/QueueListener.html">Use</a></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> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html" title="interface in org.apache.felix.ipojo.extender.queue"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/felix/ipojo/extender/queue/QueueService.html" title="interface in org.apache.felix.ipojo.extender.queue"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/felix/ipojo/extender/queue/QueueListener.html" target="_top">Frames</a></li> |
| <li><a href="QueueListener.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">org.apache.felix.ipojo.extender.queue</div> |
| <h2 title="Interface QueueListener" class="title">Interface QueueListener</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/felix/ipojo/extender/internal/queue/debug/ReplayQueueEventProxy.html" title="class in org.apache.felix.ipojo.extender.internal.queue.debug">ReplayQueueEventProxy</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../../src-html/org/apache/felix/ipojo/extender/queue/QueueListener.html#line.33">QueueListener</a></pre> |
| <div class="block">A <a href="../../../../../../org/apache/felix/ipojo/extender/queue/QueueListener.html" title="interface in org.apache.felix.ipojo.extender.queue"><code>QueueListener</code></a> provides queue management information to external entities: |
| <ul> |
| <li>Job submission</li> |
| <li>Job execution</li> |
| <li>Job result (success or failure)</li> |
| </ul> |
| |
| Implementer of this interface should not block as the invocation is done synchronously. |
| Implementers are responsible to register themselves in the <a href="../../../../../../org/apache/felix/ipojo/extender/queue/QueueService.html" title="interface in org.apache.felix.ipojo.extender.queue"><code>QueueService</code></a> they'll observe.</div> |
| </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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/extender/queue/QueueListener.html#enlisted(org.apache.felix.ipojo.extender.queue.JobInfo)">enlisted</a></strong>(<a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html" title="interface in org.apache.felix.ipojo.extender.queue">JobInfo</a> info)</code> |
| <div class="block">Invoked when a job is just being enlisted (before processing).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/extender/queue/QueueListener.html#executed(org.apache.felix.ipojo.extender.queue.JobInfo, java.lang.Object)">executed</a></strong>(<a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html" title="interface in org.apache.felix.ipojo.extender.queue">JobInfo</a> info, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> result)</code> |
| <div class="block">Invoked when a job's execution is finished successfully.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/extender/queue/QueueListener.html#failed(org.apache.felix.ipojo.extender.queue.JobInfo, java.lang.Throwable)">failed</a></strong>(<a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html" title="interface in org.apache.felix.ipojo.extender.queue">JobInfo</a> info, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> throwable)</code> |
| <div class="block">Invoked when a job's execution is finished with error.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/extender/queue/QueueListener.html#started(org.apache.felix.ipojo.extender.queue.JobInfo)">started</a></strong>(<a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html" title="interface in org.apache.felix.ipojo.extender.queue">JobInfo</a> info)</code> |
| <div class="block">Invoked when a job's execution is just about to be started.</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="enlisted(org.apache.felix.ipojo.extender.queue.JobInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enlisted</h4> |
| <pre>void <a href="../../../../../../src-html/org/apache/felix/ipojo/extender/queue/QueueListener.html#line.41">enlisted</a>(<a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html" title="interface in org.apache.felix.ipojo.extender.queue">JobInfo</a> info)</pre> |
| <div class="block">Invoked when a job is just being enlisted (before processing). |
| Only <a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html#getEnlistmentTime()"><code>JobInfo.getEnlistmentTime()</code></a> and <a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html#getWaitDuration()"><code>JobInfo.getWaitDuration()</code></a> provides meaningful values. |
| Note that <code>waitDuration</code> value is re-evaluated at each call.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - The job being enlisted</dd></dl> |
| </li> |
| </ul> |
| <a name="started(org.apache.felix.ipojo.extender.queue.JobInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>started</h4> |
| <pre>void <a href="../../../../../../src-html/org/apache/felix/ipojo/extender/queue/QueueListener.html#line.50">started</a>(<a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html" title="interface in org.apache.felix.ipojo.extender.queue">JobInfo</a> info)</pre> |
| <div class="block">Invoked when a job's execution is just about to be started. |
| Only <a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html#getEnlistmentTime()"><code>JobInfo.getEnlistmentTime()</code></a>, <a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html#getWaitDuration()"><code>JobInfo.getWaitDuration()</code></a>, <a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html#getStartTime()"><code>JobInfo.getStartTime()</code></a> |
| and <a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html#getExecutionDuration()"><code>JobInfo.getExecutionDuration()</code></a> provides meaningful values. |
| Note that <code>executionDuration</code> value is re-evaluated at each call.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - The job being started</dd></dl> |
| </li> |
| </ul> |
| <a name="executed(org.apache.felix.ipojo.extender.queue.JobInfo, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executed</h4> |
| <pre>void <a href="../../../../../../src-html/org/apache/felix/ipojo/extender/queue/QueueListener.html#line.58">executed</a>(<a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html" title="interface in org.apache.felix.ipojo.extender.queue">JobInfo</a> info, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> result)</pre> |
| <div class="block">Invoked when a job's execution is finished successfully. |
| Note the implementers should not retain any references to the provided <code>result</code> (memory leak).</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - The executed job</dd><dd><code>result</code> - The job's result</dd></dl> |
| </li> |
| </ul> |
| <a name="failed(org.apache.felix.ipojo.extender.queue.JobInfo, java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>failed</h4> |
| <pre>void <a href="../../../../../../src-html/org/apache/felix/ipojo/extender/queue/QueueListener.html#line.66">failed</a>(<a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html" title="interface in org.apache.felix.ipojo.extender.queue">JobInfo</a> info, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> throwable)</pre> |
| <div class="block">Invoked when a job's execution is finished with error. |
| Note the implementers should not retain any references to the provided <code>throwable</code> (memory leak).</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - The failed job</dd><dd><code>throwable</code> - The job's thrown 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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/QueueListener.html">Use</a></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> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/felix/ipojo/extender/queue/JobInfo.html" title="interface in org.apache.felix.ipojo.extender.queue"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/felix/ipojo/extender/queue/QueueService.html" title="interface in org.apache.felix.ipojo.extender.queue"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/felix/ipojo/extender/queue/QueueListener.html" target="_top">Frames</a></li> |
| <li><a href="QueueListener.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2014. All rights reserved.</small></p> |
| </body> |
| </html> |