| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>TimeoutHandler</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="TimeoutHandler"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":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/ws/rs/container/Suspended.html" title="annotation in jakarta.ws.rs.container"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/container/TimeoutHandler.html" target="_top">Frames</a></li> |
| <li><a href="TimeoutHandler.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.ws.rs.container</div> |
| <h2 title="Interface TimeoutHandler" class="title">Interface TimeoutHandler</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">TimeoutHandler</span></pre> |
| <div class="block">Asynchronous response suspend time-out handler. |
| |
| JAX-RS users may utilize this callback interface to provide custom resolution of time-out events. |
| <p> |
| By default, JAX-RS runtime generates a <a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs"><code>WebApplicationException</code></a> with a |
| <a href="../../../../jakarta/ws/rs/core/Response.Status.html#SERVICE_UNAVAILABLE"><code>HTTP 503 (Service unavailable)</code></a> error response status |
| code. A custom time-out handler may be <a href="../../../../jakarta/ws/rs/container/AsyncResponse.html#setTimeoutHandler-jakarta.ws.rs.container.TimeoutHandler-"><code>set</code></a> on an asynchronous |
| response instance to provide custom time-out event resolution. |
| </p> |
| <p> |
| In case of a suspend time-out event, a custom time-out handler takes typically one of the following actions: |
| </p> |
| <ul> |
| <li>Resumes the suspended asynchronous response using a <a href="../../../../jakarta/ws/rs/container/AsyncResponse.html#resume-java.lang.Object-"><code>custom response</code></a> or a |
| <a href="../../../../jakarta/ws/rs/container/AsyncResponse.html#resume-java.lang.Throwable-"><code>custom exception</code></a></li> |
| <li>Cancels the response by calling one of the <a href="../../../../jakarta/ws/rs/container/AsyncResponse.html" title="interface in jakarta.ws.rs.container"><code>AsyncResponse</code></a> <code>cancel(...)</code> methods.</li> |
| <li>Extends the suspend period of the response by |
| <a href="../../../../jakarta/ws/rs/container/AsyncResponse.html#setTimeout-long-java.util.concurrent.TimeUnit-"><code>setting a new suspend time-out</code></a></li> |
| </ul> |
| <p> |
| If the registered time-out handler does not take any of the actions above, the default time-out event processing |
| continues and the response is resumed with a generated <code>WebApplicationException</code> containing the HTTP 503 status |
| code. |
| </p> |
| <p> |
| Following example illustrates the use of a custom <code>TimeoutHandler</code>: |
| </p> |
| |
| <pre> |
| public class MyTimeoutHandler implements TimeoutHandler { |
| … |
| public void handleTimeout(AsyncResponse ar) { |
| if (keepSuspended) { |
| ar.setTimeout(10, SECONDS); |
| } else if (cancel) { |
| ar.cancel(retryPeriod); |
| } else { |
| ar.resume(defaultResponse); |
| } |
| } |
| … |
| } |
| |
| @Path("/messages/next") |
| public class MessagingResource { |
| … |
| @GET |
| public void readMessage(@Suspended AsyncResponse ar) { |
| ar.setTimeoutHandler(new MyTimeoutHandler()); |
| suspended.put(ar); |
| } |
| … |
| } |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.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="../../../../jakarta/ws/rs/container/TimeoutHandler.html#handleTimeout-jakarta.ws.rs.container.AsyncResponse-">handleTimeout</a></span>(<a href="../../../../jakarta/ws/rs/container/AsyncResponse.html" title="interface in jakarta.ws.rs.container">AsyncResponse</a> asyncResponse)</code> |
| <div class="block">Invoked when the suspended asynchronous response is about to time out.</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="handleTimeout-jakarta.ws.rs.container.AsyncResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>handleTimeout</h4> |
| <pre>void handleTimeout(<a href="../../../../jakarta/ws/rs/container/AsyncResponse.html" title="interface in jakarta.ws.rs.container">AsyncResponse</a> asyncResponse)</pre> |
| <div class="block">Invoked when the suspended asynchronous response is about to time out. |
| |
| Implementing time-out handlers may use the callback method to change the default time-out strategy defined by JAX-RS |
| specification (see <a href="../../../../jakarta/ws/rs/container/AsyncResponse.html" title="interface in jakarta.ws.rs.container"><code>AsyncResponse</code></a> API documentation). |
| <p> |
| A custom time-out handler may decide to either |
| </p> |
| <ul> |
| <li>resume the suspended response using one of it's <code>resume(...)</code> methods,</li> |
| <li>cancel the suspended response using one of it's <code>cancel(...)</code> methods, or</li> |
| <li>extend the suspend period by <a href="../../../../jakarta/ws/rs/container/AsyncResponse.html#setTimeout-long-java.util.concurrent.TimeUnit-"><code>setting a new |
| suspend time-out</code></a></li> |
| </ul> |
| In case the time-out handler does not take any of the actions mentioned above, a default time-out strategy is |
| executed by the JAX-RS runtime.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>asyncResponse</code> - suspended asynchronous response that is timing out.</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/ws/rs/container/Suspended.html" title="annotation in jakarta.ws.rs.container"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/container/TimeoutHandler.html" target="_top">Frames</a></li> |
| <li><a href="TimeoutHandler.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> |
