jdk/src/share/classes/java/rmi/server/RMIServerSocketFactory.java
author smarks
Wed, 30 Oct 2013 18:39:09 -0700
changeset 21421 aadfbd8b351b
parent 5506 202f599c92aa
permissions -rw-r--r--
8023863: deprecate support for statically-generated stubs from RMI (JRMP) 4449028: exportObject() javadoc should specify behavior for null socket factories Reviewed-by: dfuchs, darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1998, 2001, 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
import java.io.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.net.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * An <code>RMIServerSocketFactory</code> instance is used by the RMI runtime
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * in order to obtain server sockets for RMI calls.  A remote object can be
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * associated with an <code>RMIServerSocketFactory</code> when it is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * created/exported via the constructors or <code>exportObject</code> methods
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * of <code>java.rmi.server.UnicastRemoteObject</code> and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * <code>java.rmi.activation.Activatable</code> .
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * <p>An <code>RMIServerSocketFactory</code> instance associated with a remote
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * object is used to obtain the <code>ServerSocket</code> used to accept
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * incoming calls from clients.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * <p>An <code>RMIServerSocketFactory</code> instance can also be associated
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * with a remote object registry so that clients can use custom socket
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * communication with a remote object registry.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * <p>An implementation of this interface
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * should implement {@link Object#equals} to return <code>true</code> when
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * passed an instance that represents the same (functionally equivalent)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * server socket factory, and <code>false</code> otherwise (and it should also
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * implement {@link Object#hashCode} consistently with its
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * <code>Object.equals</code> implementation).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 * @author  Ann Wollrath
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * @author  Peter Jones
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 * @since   1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 * @see     java.rmi.server.UnicastRemoteObject
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 * @see     java.rmi.activation.Activatable
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
 * @see     java.rmi.registry.LocateRegistry
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
public interface RMIServerSocketFactory {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * Create a server socket on the specified port (port 0 indicates
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * an anonymous port).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * @param  port the port number
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * @return the server socket on the specified port
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     * @exception IOException if an I/O error occurs during server socket
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * creation
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    public ServerSocket createServerSocket(int port)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
        throws IOException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
}