View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.nio.reactor;
29  
30  import java.io.IOException;
31  
32  /**
33   * Abstract exception handler intended to deal with potentially recoverable
34   * I/O exceptions thrown by an I/O reactor.
35   *
36   * @since 4.0
37   */
38  public interface IOReactorExceptionHandler {
39  
40      /**
41       * This method is expected to examine the I/O exception passed as
42       * a parameter and decide whether it is safe to continue execution of
43       * the I/O reactor.
44       *
45       * @param ex potentially recoverable I/O exception
46       * @return <code>true</code> if it is safe to ignore the exception
47       * and continue execution of the I/O reactor; <code>false</code> if the
48       * I/O reactor must throw {@link IOReactorException} and terminate
49       */
50      boolean handle(IOException ex);
51  
52      /**
53       * This method is expected to examine the runtime exception passed as
54       * a parameter and decide whether it is safe to continue execution of
55       * the I/O reactor.
56       *
57       * @param ex potentially recoverable runtime exception
58       * @return <code>true</code> if it is safe to ignore the exception
59       * and continue execution of the I/O reactor; <code>false</code> if the
60       * I/O reactor must throw {@link RuntimeException} and terminate
61       */
62      boolean handle(RuntimeException ex);
63  
64  }