RMIClientSocketFactory
, RMIServerSocketFactory
public abstract class RMISocketFactory extends Object implements RMIClientSocketFactory, RMIServerSocketFactory
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 creates a direct socket connection to the remote host.
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.Constructor | Description |
---|---|
RMISocketFactory() |
Constructs an
RMISocketFactory . |
Modifier and Type | Method | Description |
---|---|---|
abstract ServerSocket |
createServerSocket(int port) |
Create a server socket on the specified port (port 0 indicates
an anonymous port).
|
abstract Socket |
createSocket(String host,
int port) |
Creates a client socket connected to the specified host and port.
|
static RMISocketFactory |
getDefaultSocketFactory() |
Returns a reference to the default socket factory used
by this RMI implementation.
|
static RMIFailureHandler |
getFailureHandler() |
Returns the handler for socket creation failure set by the
setFailureHandler method. |
static RMISocketFactory |
getSocketFactory() |
Returns the socket factory set by the
setSocketFactory
method. |
static void |
setFailureHandler(RMIFailureHandler fh) |
Sets the failure handler to be called by the RMI runtime if server
socket creation fails.
|
static void |
setSocketFactory(RMISocketFactory fac) |
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).
|
public RMISocketFactory()
RMISocketFactory
.public abstract Socket createSocket(String host, int port) throws IOException
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
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
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()
setSocketFactory
method. Returns null
if no socket factory has been
set.setSocketFactory(RMISocketFactory)
public static RMISocketFactory getDefaultSocketFactory()
getSocketFactory
returns null
.public static void setFailureHandler(RMIFailureHandler fh)
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()
setFailureHandler
method.setFailureHandler(RMIFailureHandler)
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps