1 /*
   2  * Copyright (c) 1996, 1998, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   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
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.rmi.server;
  27 
  28 /**
  29  * An <code>RMIFailureHandler</code> can be registered via the
  30  * <code>RMISocketFactory.setFailureHandler</code> call. The
  31  * <code>failure</code> method of the handler is invoked when the RMI
  32  * runtime is unable to create a <code>ServerSocket</code> to listen
  33  * for incoming calls. The <code>failure</code> method returns a boolean
  34  * indicating whether the runtime should attempt to re-create the
  35  * <code>ServerSocket</code>.
  36  *
  37  * @author      Ann Wollrath
  38  * @since       JDK1.1
  39  */
  40 public interface RMIFailureHandler {
  41 
  42     /**
  43      * The <code>failure</code> callback is invoked when the RMI
  44      * runtime is unable to create a <code>ServerSocket</code> via the
  45      * <code>RMISocketFactory</code>. An <code>RMIFailureHandler</code>
  46      * is registered via a call to
  47      * <code>RMISocketFacotry.setFailureHandler</code>.  If no failure
  48      * handler is installed, the default behavior is to attempt to
  49      * re-create the ServerSocket.
  50      *
  51      * @param ex the exception that occurred during <code>ServerSocket</code>
  52      *           creation
  53      * @return if true, the RMI runtime attempts to retry
  54      * <code>ServerSocket</code> creation
  55      * @see java.rmi.server.RMISocketFactory#setFailureHandler(RMIFailureHandler)
  56      * @since JDK1.1
  57      */
  58     public boolean failure(Exception ex);
  59 
  60 }