src/java.rmi/share/classes/java/rmi/server/RMIFailureHandler.java
author igerasim
Tue, 19 Feb 2019 09:06:44 -0800
changeset 53822 c93f9524acb2
parent 47216 71c04702a3d5
permissions -rw-r--r--
4887513: Typo in RMIFailureHandler interface doc page Reviewed-by: dfuchs Contributed-by: Andrey Turbanov <turbanoff@gmail.com>, Ivan Gerasimov <ivan.gerasimov@oracle.com>
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
53822
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
     2
 * Copyright (c) 1996, 2019, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.rmi.server;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
53822
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    29
 * An {@code RMIFailureHandler} can be registered via the
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    30
 * {@code RMISocketFactory.setFailureHandler} call. The
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    31
 * {@code failure} method of the handler is invoked when the RMI
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    32
 * runtime is unable to create a {@code ServerSocket} to listen
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    33
 * for incoming calls. The {@code failure} method returns a boolean
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * indicating whether the runtime should attempt to re-create the
53822
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    35
 * {@code ServerSocket}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * @author      Ann Wollrath
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 5506
diff changeset
    38
 * @since       1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
public interface RMIFailureHandler {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
    /**
53822
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    43
     * The {@code failure} callback is invoked when the RMI
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    44
     * runtime is unable to create a {@code ServerSocket} via the
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    45
     * {@code RMISocketFactory}. An {@code RMIFailureHandler}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
     * is registered via a call to
53822
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    47
     * {@code RMISocketFactory.setFailureHandler}.  If no failure
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
     * handler is installed, the default behavior is to attempt to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
     * re-create the ServerSocket.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     *
53822
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    51
     * @param ex the exception that occurred during {@code ServerSocket}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     *           creation
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     * @return if true, the RMI runtime attempts to retry
53822
c93f9524acb2 4887513: Typo in RMIFailureHandler interface doc page
igerasim
parents: 47216
diff changeset
    54
     * {@code ServerSocket} creation
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * @see java.rmi.server.RMISocketFactory#setFailureHandler(RMIFailureHandler)
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 5506
diff changeset
    56
     * @since 1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    public boolean failure(Exception ex);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
}