| <!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 (1.8.0_212) on Tue Oct 22 15:11:38 UTC 2019 --> |
| <title>TimerServiceImpl</title> |
| <meta name="date" content="2019-10-22"> |
| <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="TimerServiceImpl"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../org/apache/openejb/core/timer/Timers.html" title="class in org.apache.openejb.core.timer"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openejb/core/timer/TimerServiceWrapper.html" title="class in org.apache.openejb.core.timer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openejb/core/timer/TimerServiceImpl.html" target="_top">Frames</a></li> |
| <li><a href="TimerServiceImpl.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.openejb.core.timer</div> |
| <h2 title="Class TimerServiceImpl" class="title">Class TimerServiceImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openejb.core.timer.TimerServiceImpl</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">TimerServiceImpl</span> |
| extends java.lang.Object |
| implements <a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#TimerServiceImpl-org.apache.openejb.core.timer.EjbTimerService-java.lang.Object-java.lang.reflect.Method-">TimerServiceImpl</a></span>(<a href="../../../../../org/apache/openejb/core/timer/EjbTimerService.html" title="interface in org.apache.openejb.core.timer">EjbTimerService</a> ejbTimerService, |
| java.lang.Object primaryKey, |
| java.lang.reflect.Method ejbTimeout)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#createCalendarTimer-javax.ejb.ScheduleExpression-">createCalendarTimer</a></span>(<a href="../../../../../javax/ejb/ScheduleExpression.html" title="class in javax.ejb">ScheduleExpression</a> scheduleExpression)</code> |
| <div class="block">Create a calendar-based timer based on the input schedule expression.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#createCalendarTimer-javax.ejb.ScheduleExpression-javax.ejb.TimerConfig-">createCalendarTimer</a></span>(<a href="../../../../../javax/ejb/ScheduleExpression.html" title="class in javax.ejb">ScheduleExpression</a> scheduleExpression, |
| <a href="../../../../../javax/ejb/TimerConfig.html" title="class in javax.ejb">TimerConfig</a> timerConfig)</code> |
| <div class="block">Create a calendar-based timer based on the input schedule expression.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#createIntervalTimer-java.util.Date-long-javax.ejb.TimerConfig-">createIntervalTimer</a></span>(java.util.Date initialExpiration, |
| long lintervalDuration, |
| <a href="../../../../../javax/ejb/TimerConfig.html" title="class in javax.ejb">TimerConfig</a> timerConfig)</code> |
| <div class="block">Create an interval timer whose first expiration occurs at a given |
| point in time and whose subsequent expirations occur after a specified |
| interval.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#createIntervalTimer-long-long-javax.ejb.TimerConfig-">createIntervalTimer</a></span>(long initialDuration, |
| long intervalDuration, |
| <a href="../../../../../javax/ejb/TimerConfig.html" title="class in javax.ejb">TimerConfig</a> timerConfig)</code> |
| <div class="block">Create an interval timer whose first expiration occurs after a specified |
| duration, and whose subsequent expirations occur after a specified |
| interval.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#createSingleActionTimer-java.util.Date-javax.ejb.TimerConfig-">createSingleActionTimer</a></span>(java.util.Date expiration, |
| <a href="../../../../../javax/ejb/TimerConfig.html" title="class in javax.ejb">TimerConfig</a> timerConfig)</code> |
| <div class="block">Create a single-action timer that expires at a given point in time.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#createSingleActionTimer-long-javax.ejb.TimerConfig-">createSingleActionTimer</a></span>(long duration, |
| <a href="../../../../../javax/ejb/TimerConfig.html" title="class in javax.ejb">TimerConfig</a> timerConfig)</code> |
| <div class="block">Create a single-action timer that expires after a specified duration.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#createTimer-java.util.Date-long-java.io.Serializable-">createTimer</a></span>(java.util.Date initialExpiration, |
| long intervalDuration, |
| java.io.Serializable info)</code> |
| <div class="block">Create an interval timer whose first expiration occurs at a given |
| point in time and whose subsequent expirations occur after a specified |
| interval.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#createTimer-java.util.Date-java.io.Serializable-">createTimer</a></span>(java.util.Date expiration, |
| java.io.Serializable info)</code> |
| <div class="block">Create a single-action timer that expires at a given point in time.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#createTimer-long-long-java.io.Serializable-">createTimer</a></span>(long initialDuration, |
| long intervalDuration, |
| java.io.Serializable info)</code> |
| <div class="block">Create an interval timer whose first expiration occurs after a specified |
| duration, and whose subsequent expirations occur after a specified |
| interval.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#createTimer-long-java.io.Serializable-">createTimer</a></span>(long duration, |
| java.io.Serializable info)</code> |
| <div class="block">Create a single-action timer that expires after a specified duration.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.util.Collection<<a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#getAllTimers--">getAllTimers</a></span>()</code> |
| <div class="block">Returns all active timers associated with the beans in the same module in |
| which the caller bean is packaged.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.util.Collection<<a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/timer/TimerServiceImpl.html#getTimers--">getTimers</a></span>()</code> |
| <div class="block">Returns all active timers associated with this bean.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TimerServiceImpl-org.apache.openejb.core.timer.EjbTimerService-java.lang.Object-java.lang.reflect.Method-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TimerServiceImpl</h4> |
| <pre>public TimerServiceImpl(<a href="../../../../../org/apache/openejb/core/timer/EjbTimerService.html" title="interface in org.apache.openejb.core.timer">EjbTimerService</a> ejbTimerService, |
| java.lang.Object primaryKey, |
| java.lang.reflect.Method ejbTimeout)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createTimer-java.util.Date-long-java.io.Serializable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTimer</h4> |
| <pre>public <a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a> createTimer(java.util.Date initialExpiration, |
| long intervalDuration, |
| java.io.Serializable info) |
| throws java.lang.IllegalArgumentException, |
| java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#createTimer-java.util.Date-long-java.io.Serializable-">TimerService</a></code></span></div> |
| <div class="block">Create an interval timer whose first expiration occurs at a given |
| point in time and whose subsequent expirations occur after a specified |
| interval.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#createTimer-java.util.Date-long-java.io.Serializable-">createTimer</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialExpiration</code> - the point in time at which the first timer |
| expiration must occur.</dd> |
| <dd><code>intervalDuration</code> - the number of milliseconds that must elapse |
| between timer expiration notifications. Expiration notifications are |
| scheduled relative to the time of the first expiration. If expiration |
| is delayed (e.g. due to the interleaving of other method calls on the |
| bean), two or more expiration notifications may occur in close |
| succession to "catch up".</dd> |
| <dd><code>info</code> - application information to be delivered along |
| with the timer expiration. This can be null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created Timer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If |
| initialExpiration is null, if initialExpiration.getTime() is |
| negative, or if intervalDuration is negative.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method could not complete |
| due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTimer-java.util.Date-java.io.Serializable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTimer</h4> |
| <pre>public <a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a> createTimer(java.util.Date expiration, |
| java.io.Serializable info) |
| throws java.lang.IllegalArgumentException, |
| java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#createTimer-java.util.Date-java.io.Serializable-">TimerService</a></code></span></div> |
| <div class="block">Create a single-action timer that expires at a given point in time.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#createTimer-java.util.Date-java.io.Serializable-">createTimer</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expiration</code> - The point in time at which the timer must expire.</dd> |
| <dd><code>info</code> - application information to be delivered along |
| with the timer expiration notification. This can be null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created Timer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If expiration is null or |
| expiration.getTime() is negative.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method could not complete |
| due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTimer-long-long-java.io.Serializable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTimer</h4> |
| <pre>public <a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a> createTimer(long initialDuration, |
| long intervalDuration, |
| java.io.Serializable info) |
| throws java.lang.IllegalArgumentException, |
| java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#createTimer-long-long-java.io.Serializable-">TimerService</a></code></span></div> |
| <div class="block">Create an interval timer whose first expiration occurs after a specified |
| duration, and whose subsequent expirations occur after a specified |
| interval.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#createTimer-long-long-java.io.Serializable-">createTimer</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialDuration</code> - The number of milliseconds that must elapse |
| before the first timer expiration notification.</dd> |
| <dd><code>intervalDuration</code> - The number of milliseconds that must elapse |
| between timer expiration notifications. Expiration notifications are |
| scheduled relative to the time of the first expiration. If expiration |
| is delayed (e.g. due to the interleaving of other method calls on the |
| bean), two or more expiration notifications may occur in close |
| succession to "catch up".</dd> |
| <dd><code>info</code> - application information to be delivered along |
| with the timer expiration. This can be null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created Timer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If initialDuration is |
| negative or intervalDuration is negative.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method could not complete |
| due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTimer-long-java.io.Serializable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTimer</h4> |
| <pre>public <a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a> createTimer(long duration, |
| java.io.Serializable info) |
| throws java.lang.IllegalArgumentException, |
| java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#createTimer-long-java.io.Serializable-">TimerService</a></code></span></div> |
| <div class="block">Create a single-action timer that expires after a specified duration.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#createTimer-long-java.io.Serializable-">createTimer</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>duration</code> - the number of milliseconds that must elapse before |
| the timer expires.</dd> |
| <dd><code>info</code> - application information to be delivered along |
| with the timer expiration notification. This can be null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created Timer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If duration is negative</dd> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method fails due to a |
| system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTimers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimers</h4> |
| <pre>public java.util.Collection<<a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a>> getTimers() |
| throws java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#getTimers--">TimerService</a></code></span></div> |
| <div class="block">Returns all active timers associated with this bean. These include both the |
| programmatically-created timers and the automatically-created timers.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#getTimers--">getTimers</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a collection of <code>javax.ejb.Timer</code> objects.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method could not complete |
| due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createSingleActionTimer-long-javax.ejb.TimerConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSingleActionTimer</h4> |
| <pre>public <a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a> createSingleActionTimer(long duration, |
| <a href="../../../../../javax/ejb/TimerConfig.html" title="class in javax.ejb">TimerConfig</a> timerConfig) |
| throws java.lang.IllegalArgumentException, |
| java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#createSingleActionTimer-long-javax.ejb.TimerConfig-">TimerService</a></code></span></div> |
| <div class="block">Create a single-action timer that expires after a specified duration.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#createSingleActionTimer-long-javax.ejb.TimerConfig-">createSingleActionTimer</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>duration</code> - the number of milliseconds that must elapse before |
| the timer expires.</dd> |
| <dd><code>timerConfig</code> - timer configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created Timer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If duration is negative</dd> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method fails due to a |
| system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createSingleActionTimer-java.util.Date-javax.ejb.TimerConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSingleActionTimer</h4> |
| <pre>public <a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a> createSingleActionTimer(java.util.Date expiration, |
| <a href="../../../../../javax/ejb/TimerConfig.html" title="class in javax.ejb">TimerConfig</a> timerConfig) |
| throws java.lang.IllegalArgumentException, |
| java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#createSingleActionTimer-java.util.Date-javax.ejb.TimerConfig-">TimerService</a></code></span></div> |
| <div class="block">Create a single-action timer that expires at a given point in time.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#createSingleActionTimer-java.util.Date-javax.ejb.TimerConfig-">createSingleActionTimer</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expiration</code> - the point in time at which the timer must expire.</dd> |
| <dd><code>timerConfig</code> - timer configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created Timer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If expiration is null or |
| expiration.getTime() is negative.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method could not complete |
| due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createIntervalTimer-long-long-javax.ejb.TimerConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createIntervalTimer</h4> |
| <pre>public <a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a> createIntervalTimer(long initialDuration, |
| long intervalDuration, |
| <a href="../../../../../javax/ejb/TimerConfig.html" title="class in javax.ejb">TimerConfig</a> timerConfig) |
| throws java.lang.IllegalArgumentException, |
| java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#createIntervalTimer-long-long-javax.ejb.TimerConfig-">TimerService</a></code></span></div> |
| <div class="block">Create an interval timer whose first expiration occurs after a specified |
| duration, and whose subsequent expirations occur after a specified |
| interval.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#createIntervalTimer-long-long-javax.ejb.TimerConfig-">createIntervalTimer</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialDuration</code> - The number of milliseconds that must elapse |
| before the first timer expiration notification.</dd> |
| <dd><code>intervalDuration</code> - The number of milliseconds that must elapse |
| between timer expiration notifications. Expiration notifications are |
| scheduled relative to the time of the first expiration. If expiration |
| is delayed (e.g. due to the interleaving of other method calls on the |
| bean), two or more expiration notifications may occur in close |
| succession to "catch up".</dd> |
| <dd><code>timerConfig</code> - timer configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created Timer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If initialDuration is |
| negative or intervalDuration is negative.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method could not complete |
| due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createIntervalTimer-java.util.Date-long-javax.ejb.TimerConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createIntervalTimer</h4> |
| <pre>public <a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a> createIntervalTimer(java.util.Date initialExpiration, |
| long lintervalDuration, |
| <a href="../../../../../javax/ejb/TimerConfig.html" title="class in javax.ejb">TimerConfig</a> timerConfig) |
| throws java.lang.IllegalArgumentException, |
| java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#createIntervalTimer-java.util.Date-long-javax.ejb.TimerConfig-">TimerService</a></code></span></div> |
| <div class="block">Create an interval timer whose first expiration occurs at a given |
| point in time and whose subsequent expirations occur after a specified |
| interval.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#createIntervalTimer-java.util.Date-long-javax.ejb.TimerConfig-">createIntervalTimer</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialExpiration</code> - the point in time at which the first timer |
| expiration must occur.</dd> |
| <dd><code>lintervalDuration</code> - the number of milliseconds that must elapse |
| between timer expiration notifications. Expiration notifications are |
| scheduled relative to the time of the first expiration. If expiration |
| is delayed (e.g. due to the interleaving of other method calls on the |
| bean), two or more expiration notifications may occur in close |
| succession to "catch up".</dd> |
| <dd><code>timerConfig</code> - timer configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created Timer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If |
| initialExpiration is null, if initialExpiration.getTime() is |
| negative, or if intervalDuration is negative.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method could not complete |
| due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createCalendarTimer-javax.ejb.ScheduleExpression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createCalendarTimer</h4> |
| <pre>public <a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a> createCalendarTimer(<a href="../../../../../javax/ejb/ScheduleExpression.html" title="class in javax.ejb">ScheduleExpression</a> scheduleExpression) |
| throws java.lang.IllegalArgumentException, |
| java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#createCalendarTimer-javax.ejb.ScheduleExpression-">TimerService</a></code></span></div> |
| <div class="block">Create a calendar-based timer based on the input schedule expression.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#createCalendarTimer-javax.ejb.ScheduleExpression-">createCalendarTimer</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scheduleExpression</code> - a schedule expression describing the timeouts |
| for this timer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created Timer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If Schedule represents an |
| invalid schedule expression.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method could not complete |
| due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createCalendarTimer-javax.ejb.ScheduleExpression-javax.ejb.TimerConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createCalendarTimer</h4> |
| <pre>public <a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a> createCalendarTimer(<a href="../../../../../javax/ejb/ScheduleExpression.html" title="class in javax.ejb">ScheduleExpression</a> scheduleExpression, |
| <a href="../../../../../javax/ejb/TimerConfig.html" title="class in javax.ejb">TimerConfig</a> timerConfig) |
| throws java.lang.IllegalArgumentException, |
| java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#createCalendarTimer-javax.ejb.ScheduleExpression-javax.ejb.TimerConfig-">TimerService</a></code></span></div> |
| <div class="block">Create a calendar-based timer based on the input schedule expression.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#createCalendarTimer-javax.ejb.ScheduleExpression-javax.ejb.TimerConfig-">createCalendarTimer</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scheduleExpression</code> - a schedule expression describing the timeouts for this timer.</dd> |
| <dd><code>timerConfig</code> - timer configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created Timer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - If Schedule represents an |
| invalid schedule expression.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method could not complete |
| due to a system-level failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllTimers--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getAllTimers</h4> |
| <pre>public java.util.Collection<<a href="../../../../../javax/ejb/Timer.html" title="interface in javax.ejb">Timer</a>> getAllTimers() |
| throws java.lang.IllegalStateException, |
| <a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/ejb/TimerService.html#getAllTimers--">TimerService</a></code></span></div> |
| <div class="block">Returns all active timers associated with the beans in the same module in |
| which the caller bean is packaged. These include both the |
| programmatically-created timers and the automatically-created timers.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/ejb/TimerService.html#getAllTimers--">getAllTimers</a></code> in interface <code><a href="../../../../../javax/ejb/TimerService.html" title="interface in javax.ejb">TimerService</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a collection of <code>javax.ejb.Timer</code> objects.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - If this method is |
| invoked while the instance is in a state that does not allow access |
| to this method.</dd> |
| <dd><code><a href="../../../../../javax/ejb/EJBException.html" title="class in javax.ejb">EJBException</a></code> - If this method could not complete |
| due to a system-level failure.</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="../../../../../org/apache/openejb/core/timer/Timers.html" title="class in org.apache.openejb.core.timer"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openejb/core/timer/TimerServiceWrapper.html" title="class in org.apache.openejb.core.timer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openejb/core/timer/TimerServiceImpl.html" target="_top">Frames</a></li> |
| <li><a href="TimerServiceImpl.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
