FileDocCategorySizeDatePackage
RMISocketFactory.javaAPI DocJava SE 5 API5936Fri Aug 26 14:57:12 BST 2005java.rmi.server

RMISocketFactory

public abstract class RMISocketFactory extends Object implements RMIServerSocketFactory, RMIClientSocketFactory
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.

version
1.21, 12/19/03
author
Ann Wollrath
author
Peter Jones
since
JDK1.1

Fields Summary
private static RMISocketFactory
factory
Client/server socket factory to be used by RMI runtime
private static RMISocketFactory
defaultSocketFactory
default socket factory used by this RMI implementation
private static RMIFailureHandler
handler
Handler for socket creation failure
Constructors Summary
public RMISocketFactory()
Constructs an RMISocketFactory.

since
JDK1.1


              
      
	super();
    
Methods Summary
public abstract java.net.ServerSocketcreateServerSocket(int port)
Create a server socket on the specified port (port 0 indicates an anonymous port).

param
port the port number
return
the server socket on the specified port
exception
IOException if an I/O error occurs during server socket creation
since
JDK1.1

public abstract java.net.SocketcreateSocket(java.lang.String host, int port)
Creates a client socket connected to the specified host and port.

param
host the host name
param
port the port number
return
a socket connected to the specified host and port.
exception
IOException if an I/O error occurs during socket creation
since
JDK1.1

public static synchronized java.rmi.server.RMISocketFactorygetDefaultSocketFactory()
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.

return
the default RMI socket factory
since
JDK1.1

	if (defaultSocketFactory == null) {
	    defaultSocketFactory =
		new sun.rmi.transport.proxy.RMIMasterSocketFactory();
	}
	return defaultSocketFactory;
    
public static synchronized java.rmi.server.RMIFailureHandlergetFailureHandler()
Returns the handler for socket creation failure set by the setFailureHandler method.

return
the failure handler
see
#setFailureHandler(RMIFailureHandler)
since
JDK1.1

	return handler;
    
public static synchronized java.rmi.server.RMISocketFactorygetSocketFactory()
Returns the socket factory set by the setSocketFactory method. Returns null if no socket factory has been set.

return
the socket factory
see
#setSocketFactory(RMISocketFactory)
since
JDK1.1

	return factory;
    
public static synchronized voidsetFailureHandler(java.rmi.server.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.

param
fh the failure handler
throws
SecurityException if a security manager exists and its checkSetFactory method doesn't allow the operation.
see
#getFailureHandler
see
java.rmi.server.RMIFailureHandler#failure(Exception)
since
JDK1.1

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

param
fac the socket factory
exception
IOException if the RMI socket factory is already set
exception
SecurityException if a security manager exists and its checkSetFactory method doesn't allow the operation.
see
#getSocketFactory
see
java.lang.SecurityManager#checkSetFactory()
since
JDK1.1

    	if (factory != null) {
	    throw new SocketException("factory already defined");
	}
	SecurityManager security = System.getSecurityManager();
	if (security != null) {
	    security.checkSetFactory();
	}
	factory = fac;