1 /*
2 * Copyright 1998-2001 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.rmi.server;
27
28 import java.io;
29 import java.net;
30
31 /**
32 * An <code>RMIServerSocketFactory</code> instance is used by the RMI runtime
33 * in order to obtain server sockets for RMI calls. A remote object can be
34 * associated with an <code>RMIServerSocketFactory</code> when it is
35 * created/exported via the constructors or <code>exportObject</code> methods
36 * of <code>java.rmi.server.UnicastRemoteObject</code> and
37 * <code>java.rmi.activation.Activatable</code> .
38 *
39 * <p>An <code>RMIServerSocketFactory</code> instance associated with a remote
40 * object is used to obtain the <code>ServerSocket</code> used to accept
41 * incoming calls from clients.
42 *
43 * <p>An <code>RMIServerSocketFactory</code> instance can also be associated
44 * with a remote object registry so that clients can use custom socket
45 * communication with a remote object registry.
46 *
47 * <p>An implementation of this interface
48 * should implement {@link Object#equals} to return <code>true</code> when
49 * passed an instance that represents the same (functionally equivalent)
50 * server socket factory, and <code>false</code> otherwise (and it should also
51 * implement {@link Object#hashCode} consistently with its
52 * <code>Object.equals</code> implementation).
53 *
54 * @author Ann Wollrath
55 * @author Peter Jones
56 * @since 1.2
57 * @see java.rmi.server.UnicastRemoteObject
58 * @see java.rmi.activation.Activatable
59 * @see java.rmi.registry.LocateRegistry
60 */
61 public interface RMIServerSocketFactory {
62
63 /**
64 * Create a server socket on the specified port (port 0 indicates
65 * an anonymous port).
66 * @param port the port number
67 * @return the server socket on the specified port
68 * @exception IOException if an I/O error occurs during server socket
69 * creation
70 * @since 1.2
71 */
72 public ServerSocket createServerSocket(int port)
73 throws IOException;
74 }
Save This Page