デフォルトでは、JAX-RS ランタイムは HTTP 503 (Service unavailable) エラーレスポンスステータスコードを使用して WebApplicationException を生成します。カスタムタイムアウトハンドラーは、非同期レスポンスインスタンスの set であり、カスタムタイムアウトイベントの解決を提供します。

一時停止タイムアウトイベントの場合、カスタムタイムアウトハンドラーは通常、次のいずれかのアクションを実行します。

• custom response または custom exception を使用して中断された非同期レスポンスを再開します
• AsyncResponse cancel(...) メソッドの 1 つを呼び出して、レスポンスをキャンセルします。
• setting a new suspend time-out によるレスポンスの一時停止期間を延長します

登録されたタイムアウトハンドラーが上記のアクションを実行しない場合、デフォルトのタイムアウトイベント処理が続行され、HTTP503 ステータスコードを含む生成された WebApplicationException でレスポンスが再開されます。

次の例は、カスタム TimeoutHandler の使用箇所を示しています。

 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);
     }
     …
 }