This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.rmi.server
class RMISocketFactory

java.lang.Object extended by java.rmi.server.RMISocketFactory
All Implemented Interfaces:
RMIClientSocketFactory, RMIServerSocketFactory

Most common way to construct:

RMISocketFactory defaultFactory = RMISocketFactory.getDefaultSocketFactory();

Based on 14 examples


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 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.


Constructor Summary

          Constructs an RMISocketFactory.
 
Method Summary
abstract ServerSocket

          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

          Returns a reference to the default socket factory used by this RMI implementation.
static RMIFailureHandler

          Returns the handler for socket creation failure set by the setFailureHandler method.
static RMISocketFactory

          Returns the socket factory set by the setSocketFactory method.
static void

          Sets the failure handler to be called by the RMI runtime if server socket creation fails.
static void

          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).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RMISocketFactory

public RMISocketFactory()
Constructs an RMISocketFactory.

Method Detail

createServerSocket

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

Parameters:
port - the port number
Returns:
the server socket on the specified port
Throws:
IOException - if an I/O error occurs during server socket creation

createSocket

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

Parameters:
host - the host name
port - the port number
Returns:
a socket connected to the specified host and port.
Throws:
IOException - if an I/O error occurs during socket creation

getDefaultSocketFactory

public static synchronized 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.

Returns:
the default RMI socket factory

getFailureHandler

public static synchronized RMIFailureHandler getFailureHandler()
Returns the handler for socket creation failure set by the setFailureHandler method.

Returns:
the failure handler

getSocketFactory

public static synchronized RMISocketFactory getSocketFactory()
Returns the socket factory set by the setSocketFactory method. Returns null if no socket factory has been set.

Returns:
the socket factory

setFailureHandler

public static synchronized 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.

Parameters:
fh - the failure handler

setSocketFactory

public static synchronized 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.

Parameters:
fac - the socket factory
Throws:
IOException - if the RMI socket factory is already set


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.