java.rmi.server: abstract public class: RMISocketFactory

java.rmi.server
abstract public class: RMISocketFactory [javadoc | source]

java.lang.Object
   java.rmi.server.RMISocketFactory

All Implemented Interfaces:
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 used goes through 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.

author: Ann - Wollrath

author: Peter - Jones

since: JDK1.1 -

Constructor:

Constructor:
public RMISocketFactory() { super(); } Constructs an `RMISocketFactory`. since: `JDK1.1` -

 public RMISocketFactory() {
              
        super();
}

Constructs an RMISocketFactory.

since: JDK1.1 -

Method from java.rmi.server.RMISocketFactory Summary:
createServerSocket, createSocket, getDefaultSocketFactory, getFailureHandler, getSocketFactory, setFailureHandler, setSocketFactory

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.rmi.server.RMISocketFactory Detail:
abstract public ServerSocket createServerSocket(int port) throws IOException Create a server socket on the specified port (port 0 indicates an anonymous port).
abstract public Socket createSocket(String host, int port) throws IOException Creates a client socket connected to the specified host and port.
public static synchronized RMISocketFactory getDefaultSocketFactory() { if (defaultSocketFactory == null) { defaultSocketFactory = new sun.rmi.transport.proxy.RMIMasterSocketFactory(); } return defaultSocketFactory; } 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 synchronized RMIFailureHandler getFailureHandler() { return handler; } Returns the handler for socket creation failure set by the `setFailureHandler` method.
public static synchronized RMISocketFactory getSocketFactory() { return factory; } Returns the socket factory set by the `setSocketFactory` method. Returns `null` if no socket factory has been set.
public static synchronized void setFailureHandler(RMIFailureHandler fh) { SecurityManager security = System.getSecurityManager(); if (security != null) { security.checkSetFactory(); } handler = 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`.
public static synchronized void setSocketFactory(RMISocketFactory fac) throws IOException { if (factory != null) { throw new SocketException("factory already defined"); } SecurityManager security = System.getSecurityManager(); if (security != null) { security.checkSetFactory(); } factory = 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). 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.

Method from java.rmi.server.RMISocketFactory Detail:

 abstract public ServerSocket createServerSocket(int port) throws IOExceptionCreate a server socket on the specified port (port 0 indicates
an anonymous port).

 abstract public Socket createSocket(String host,
    int port) throws IOExceptionCreates a client socket connected to the specified host and port.

 public static synchronized RMISocketFactory getDefaultSocketFactory() {
        if (defaultSocketFactory == null) {
            defaultSocketFactory =
                new sun.rmi.transport.proxy.RMIMasterSocketFactory();
        }
        return defaultSocketFactory;
}

getSocketFactory

null

 public static synchronized RMIFailureHandler getFailureHandler() {
        return handler;
}

setFailureHandler

 public static synchronized RMISocketFactory getSocketFactory() {
        return factory;
}

setSocketFactory

null

 public static synchronized  void setFailureHandler(RMIFailureHandler fh) {
        SecurityManager security = System.getSecurityManager();
        if (security != null) {
            security.checkSetFactory();
        }
        handler = 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.

 public static synchronized  void setSocketFactory(RMISocketFactory fac) throws IOException {
        if (factory != null) {
            throw new SocketException("factory already defined");
        }
        SecurityManager security = System.getSecurityManager();
        if (security != null) {
            security.checkSetFactory();
        }
        factory = 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). 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.