public abstract class RMISocketFactory extends Object implements RMIClientSocketFactory, RMIServerSocketFactory
An RMISocketFactory instance is used by the RMI runtime in order to obtain client and server sockets for RMI calls. An application may use the setSocketFactory method to request that the RMI runtime use its socket factory instance instead of the default implementation.
The default socket factory implementation performs a three-tiered approach to creating client sockets. First, a direct socket connection to the remote VM is attempted. If that fails (due to a firewall), the runtime uses HTTP with the explicit port number of the server. If the firewall does not allow this type of communication, then HTTP to a cgi-bin script on the server is used to POST the RMI call. The HTTP tunneling mechanisms are disabled by default. This behavior is controlled by the java.rmi.server.disableHttp property, whose default value is true. Setting this property's value to false will enable the HTTP tunneling mechanisms.
Deprecated: HTTP Tunneling. The HTTP tunneling mechanisms described above, specifically HTTP with an explicit port and HTTP to a cgi-bin script, are deprecated. These HTTP tunneling mechanisms are subject to removal in a future release of the platform.
The default socket factory implementation creates server sockets that are bound to the wildcard address, which accepts requests from all network interfaces.
You can use the RMISocketFactory class to create a server socket that is bound to a specific address, restricting the origin of requests. For example, the following code implements a socket factory that binds server sockets to an IPv4 loopback address. This restricts RMI to processing requests only from the local host.
class LoopbackSocketFactory extends RMISocketFactory {
public ServerSocket createServerSocket(int port) throws IOException {
return new ServerSocket(port, 5, InetAddress.getByName("127.0.0.1"));
}
public Socket createSocket(String host, int port) throws IOException {
// just call the default client socket factory
return RMISocketFactory.getDefaultSocketFactory()
.createSocket(host, port);
}
}
// ...
RMISocketFactory.setSocketFactory(new LoopbackSocketFactory()); Set the java.rmi.server.hostname system property to 127.0.0.1 to ensure that the generated stubs connect to the right network interface.public RMISocketFactory()
Constructs an RMISocketFactory.
public abstract Socket createSocket(String host,
int port)
throws IOException Creates a client socket connected to the specified host and port.
createSocket in interface RMIClientSocketFactory
host - the host nameport - the port numberIOException - if an I/O error occurs during socket creationpublic abstract ServerSocket createServerSocket(int port)
throws IOException Create a server socket on the specified port (port 0 indicates an anonymous port).
createServerSocket in interface RMIServerSocketFactory
port - the port numberIOException - if an I/O error occurs during server socket creationpublic static void setSocketFactory(RMISocketFactory fac)
throws IOException Set the global socket factory from which RMI gets sockets (if the remote object is not associated with a specific client and/or server socket factory). The RMI socket factory can only be set once. Note: The RMISocketFactory may only be set if the current security manager allows setting a socket factory; if disallowed, a SecurityException will be thrown.
fac - the socket factoryIOException - if the RMI socket factory is already setSecurityException - if a security manager exists and its checkSetFactory method doesn't allow the operation.getSocketFactory(), SecurityManager.checkSetFactory()
public static RMISocketFactory getSocketFactory()
Returns the socket factory set by the setSocketFactory method. Returns null if no socket factory has been set.
setSocketFactory(RMISocketFactory)public static RMISocketFactory getDefaultSocketFactory()
Returns a reference to the default socket factory used by this RMI implementation. This will be the factory used by the RMI runtime when getSocketFactory returns null.
public static void setFailureHandler(RMIFailureHandler fh)
Sets the failure handler to be called by the RMI runtime if server socket creation fails. By default, if no failure handler is installed and server socket creation fails, the RMI runtime does attempt to recreate the server socket.
If there is a security manager, this method first calls the security manager's checkSetFactory method to ensure the operation is allowed. This could result in a SecurityException.
fh - the failure handlerSecurityException - if a security manager exists and its checkSetFactory method doesn't allow the operation.getFailureHandler(), RMIFailureHandler.failure(Exception)
public static RMIFailureHandler getFailureHandler()
Returns the handler for socket creation failure set by the setFailureHandler method.
setFailureHandler(RMIFailureHandler)
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.