| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>AroundTimeout</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="AroundTimeout"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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/interceptor/AroundInvoke.html" title="annotation in jakarta.interceptor"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/interceptor/ExcludeClassInterceptors.html" title="annotation in jakarta.interceptor"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/interceptor/AroundTimeout.html" target="_top">Frames</a></li> |
| <li><a href="AroundTimeout.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>Field | </li> |
| <li>Required | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Element</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.interceptor</div> |
| <h2 title="Annotation Type AroundTimeout" class="title">Annotation Type AroundTimeout</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Target(value=METHOD) |
| @Retention(value=RUNTIME) |
| public @interface <span class="memberNameLabel">AroundTimeout</span></pre> |
| <div class="block">Defines an interceptor method that interposes on timeout methods. The method must take a single parameter of type |
| <a href="../../jakarta/interceptor/InvocationContext.html" title="interface in jakarta.interceptor"><code>InvocationContext</code></a> and have a return type <code>Object</code>. The method must not be |
| declared as abstract, final, or static. |
| |
| <pre> |
| @AroundTimeout |
| public Object interceptTimeout(InvocationContext ctx) throws Exception { ... } |
| </pre> |
| |
| <p> |
| <code>AroundTimeout</code> methods may be declared in interceptor classes, in the superclasses of interceptor classes, in |
| the target class, and/or in superclasses of the target class. |
| </p> |
| |
| <p> |
| A given class must not declare more than one <code>AroundTimeout</code> method. |
| </p> |
| |
| <p> |
| An <code>AroundTimeout</code> method can invoke any component or resource that its corresponding timeout method can |
| invoke. |
| </p> |
| |
| <p> |
| <a href="../../jakarta/interceptor/InvocationContext.html#getTimer--"><code>InvocationContext.getTimer()</code></a> allows any <code>AroundTimeout</code> method to retrieve the timer |
| object associated with the timeout. |
| </p> |
| |
| <p> |
| In general, <code>AroundTimeout</code> method invocations occur within the same transaction and security context as the |
| timeout method on which they are interposing. |
| </p> |
| |
| <p> |
| <code>AroundTimeout</code> methods may throw any exceptions that are allowed by the throws clause of the timeout method |
| on which they are interposing. They may catch and suppress exceptions and recover by calling |
| <a href="../../jakarta/interceptor/InvocationContext.html#proceed--"><code>InvocationContext.proceed()</code></a>. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Jakarta Interceptors 1.1</dd> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/examples/async-postconstruct.html">async-postconstruct</a></dd> |
| <dt><span class="simpleTagLabel">Examples (pt):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/pt/examples/async-postconstruct.html">async-postconstruct</a></dd> |
| </dl> |
| </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/interceptor/AroundInvoke.html" title="annotation in jakarta.interceptor"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/interceptor/ExcludeClassInterceptors.html" title="annotation in jakarta.interceptor"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/interceptor/AroundTimeout.html" target="_top">Frames</a></li> |
| <li><a href="AroundTimeout.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>Field | </li> |
| <li>Required | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Element</li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |