1 /* |
1 /* |
2 * Copyright (c) 1996, 1998, Oracle and/or its affiliates. All rights reserved. |
2 * Copyright (c) 1996, 2019, Oracle and/or its affiliates. All rights reserved. |
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 * |
4 * |
5 * This code is free software; you can redistribute it and/or modify it |
5 * This code is free software; you can redistribute it and/or modify it |
6 * under the terms of the GNU General Public License version 2 only, as |
6 * under the terms of the GNU General Public License version 2 only, as |
7 * published by the Free Software Foundation. Oracle designates this |
7 * published by the Free Software Foundation. Oracle designates this |
24 */ |
24 */ |
25 |
25 |
26 package java.rmi.server; |
26 package java.rmi.server; |
27 |
27 |
28 /** |
28 /** |
29 * An <code>RMIFailureHandler</code> can be registered via the |
29 * An {@code RMIFailureHandler} can be registered via the |
30 * <code>RMISocketFactory.setFailureHandler</code> call. The |
30 * {@code RMISocketFactory.setFailureHandler} call. The |
31 * <code>failure</code> method of the handler is invoked when the RMI |
31 * {@code failure} method of the handler is invoked when the RMI |
32 * runtime is unable to create a <code>ServerSocket</code> to listen |
32 * runtime is unable to create a {@code ServerSocket} to listen |
33 * for incoming calls. The <code>failure</code> method returns a boolean |
33 * for incoming calls. The {@code failure} method returns a boolean |
34 * indicating whether the runtime should attempt to re-create the |
34 * indicating whether the runtime should attempt to re-create the |
35 * <code>ServerSocket</code>. |
35 * {@code ServerSocket}. |
36 * |
36 * |
37 * @author Ann Wollrath |
37 * @author Ann Wollrath |
38 * @since 1.1 |
38 * @since 1.1 |
39 */ |
39 */ |
40 public interface RMIFailureHandler { |
40 public interface RMIFailureHandler { |
41 |
41 |
42 /** |
42 /** |
43 * The <code>failure</code> callback is invoked when the RMI |
43 * The {@code failure} callback is invoked when the RMI |
44 * runtime is unable to create a <code>ServerSocket</code> via the |
44 * runtime is unable to create a {@code ServerSocket} via the |
45 * <code>RMISocketFactory</code>. An <code>RMIFailureHandler</code> |
45 * {@code RMISocketFactory}. An {@code RMIFailureHandler} |
46 * is registered via a call to |
46 * is registered via a call to |
47 * <code>RMISocketFacotry.setFailureHandler</code>. If no failure |
47 * {@code RMISocketFactory.setFailureHandler}. If no failure |
48 * handler is installed, the default behavior is to attempt to |
48 * handler is installed, the default behavior is to attempt to |
49 * re-create the ServerSocket. |
49 * re-create the ServerSocket. |
50 * |
50 * |
51 * @param ex the exception that occurred during <code>ServerSocket</code> |
51 * @param ex the exception that occurred during {@code ServerSocket} |
52 * creation |
52 * creation |
53 * @return if true, the RMI runtime attempts to retry |
53 * @return if true, the RMI runtime attempts to retry |
54 * <code>ServerSocket</code> creation |
54 * {@code ServerSocket} creation |
55 * @see java.rmi.server.RMISocketFactory#setFailureHandler(RMIFailureHandler) |
55 * @see java.rmi.server.RMISocketFactory#setFailureHandler(RMIFailureHandler) |
56 * @since 1.1 |
56 * @since 1.1 |
57 */ |
57 */ |
58 public boolean failure(Exception ex); |
58 public boolean failure(Exception ex); |
59 |
59 |