Generated by
JDiff

java.rmi.server Documentation Differences

This file contains all the changes in documentation in the package java.rmi.server as colored differences. Deletions are shown like this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Class LogStream

LogStream provides a mechanism for logging errors that are of possible interest to those monitoring a system. @version 1.1617 12/03/0118/02 @author Ann Wollrath (lots of code stolen from Ken Arnold) @since JDK1.1 @deprecated no replacement
Class LogStream, PrintStream getDefaultStream()

Return the current default stream for new logs. @return default log stream @see #setDefaultStream @since JDK1.1 @deprecated no replacement
Class LogStream, OutputStream getOutputStream()

Return the current stream to which output from this log is sent. @return output stream for this log @see #setOutputStream @since JDK1.1 @deprecated no replacement
Class LogStream, void setDefaultStream(PrintStream)

Set the default stream for new logs. @param newDefault new default log stream @see #getDefaultStream @since JDK1.1 @deprecated no replacement
Class LogStream, void setOutputStream(OutputStream)

Set the stream to which output from this log is sent. @param out new output stream for this log @see #getOutputStream @since JDK1.1 @deprecated no replacement

Class ObjID

An ObjID is used to identify a remote object exported to an RMI runtime. When a remote object is exported it is assigned an object identifier either implicitly or explicitly depending on the API used to export.

The #ObjID() constructor can be used to generate a unique object identifier. Such an ObjID is unique over time with respect to the host it is generated on. The #ObjID(int) constructor can be used to create a "well-known" object identifier. The scope of a well-known ObjID depends on the RMI runtime it is exported to.

An ObjID instance contains an object number (of type long) and an address space identifier (of type I a unique ObjID the address space identifier is unique with respect to a given host over time. In a well-known ObjID the address space identifier is equivalent to one returned by invoking the UID#UID(short) constructor with the value zero.

If the system property java.rmi.server.randomIDs is defined to equal the string "true" (case insensitive) then the #ObjID() constructor will use a cryptographically strong random number generator to choose the object number of the returned ObjID. @author Ann Wollrath @author Peter Jones @version 1.26 0127 02/12/03/18 @since JDK1.1

Class ObjID, int ACTIVATOR_ID

objectObject number for well-known ObjID of the activator.
Class ObjID, int DGC_ID

objectObject number for well-known ObjID of the distributed garbage collector.
Class ObjID, int REGISTRY_ID

objectObject number for well-known ObjID of the registry.

Class RMIClassLoader

RMIClassLoader comprises static methods to support dynamic class loading with RMI. Included are methods for loading classes from a network location (one or more URLs) and obtaining the location from which an existing class should be loaded by remote parties. These methods are used by the RMI runtime when marshalling and unmarshalling classes contained in the arguments and return values of remote method calls and they also may be invoked directly by applications in order to mimic RMI's dynamic class loading behavior.

The implementation of the following static methods

is provided by an instance of RMIClassLoaderSpi the service provider interface for those methods. When one of the methods is invoked its behavior is to delegate to a corresponding method on the service provider instance. The details of how each method delegates to the provider instance is described in the documentation for each particular method.

The service provider instance is chosen as follows:

@version 1.34 0135 02/12/03/06 @author Ann Wollrath @author Peter Jones @author Laird Dornin @see RMIClassLoaderSpi @since JDK1.1
Class RMIClassLoader, String getClassAnnotation(Class)

Returns the annotation string (representing a location for the class definition) that RMI will use to annotate the class descriptor when marshalling objects of the given class.

This method delegates to the RMIClassLoaderSpi#getClassAnnotation(Class) method of the provider instance passing cl as the argument. @param cl the class to obtain the annotation for @return a string to be used to annotate the given class when it gets marshalled or null @throws NullPointerException if cl is null @since 1.2


Class RMIClassLoaderSpi

RMIClassLoaderSpi is the service provider interface for RMIClassLoader. In particular an RMIClassLoaderSpi instance provides an implementation of the following static methods of RMIClassLoader: When one of those methods is invoked its behavior is to delegate to a corresponding method on an instance of this class. The details of how each method delegates to the provider instance is described in the documentation for each particular method. See the documentation for RMIClassLoader for a description of how a provider instance is chosen. @version 1.9 0110 02/12/03/06 @author Peter Jones @author Laird Dornin @see RMIClassLoader @since JDK1.4
Class RMIClassLoaderSpi, String getClassAnnotation(Class)

Provides the implementation for RMIClassLoader#getClassAnnotation(Class) Returns the annotation string (representing a location for the class definition) that RMI will use to annotate the class descriptor when marshalling objects of the given class. @param cl the class to obtain the annotation for @return a string to be used to annotate the given class when it gets marshalled or null @throws NullPointerException if cl is null

Class RMISocketFactory

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.17 1219 05/0307/0102 @author Ann Wollrath @author Peter Jones @since JDK1.1

Class RMISocketFactory, void setFailureHandler(RMIFailureHandler)

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

Class RMISocketFactory, void setSocketFactory(RMISocketFactory)

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

Class RemoteObject

The RemoteObject class implements the java.lang.Object behavior for remote objects. RemoteObject provides the remote semantics of Object by implementing methods for hashCode equals and toString. @author Ann Wollrath @author Laird Dornin @author Peter Jones @version 1.25 0127 02/12/03/18 @since JDK1.1
Class RemoteObject, RemoteRef getRef()

Returns the remote reference for the remote object.

Note: The object returned from this method may be an instance of an implementation-specific class. The RemoteObject class ensures serialization portability of its instances' remote references through the behavior of its custom writeObject and readObject methods. An instance of RemoteRef should not be serialized outside of its RemoteObject wrapper instance or the result may be unportable. @return remote reference for the remote object @since 1.2

Class RemoteObject, RemoteRef ref

theThe object's remote reference.

Class RemoteServer

The RemoteServer class is the common superclass to server implementations and provides the framework to support a wide range of remote reference semantics. Specifically the functions needed to create and export remote objects (i.e. to make them remotely available) are provided abstractly by RemoteServer and concretely by its subclass(es). @version 1.2830 12/03/0121/02 @author Ann Wollrath @since JDK1.1
Class RemoteServer, PrintStream getLog()

Returns stream for the RMI call log. @return the call log @see #setLog @since JDK1.1
Class RemoteServer, void setLog(OutputStream)

Log RMI calls to the output stream out. If out is null call logging is turned off.

If there is a security manager its checkPermission method will be invoked with a java.util.logging.LoggingPermission("control") permission; this could result in a SecurityException. @param out the output stream to which RMI calls should be logged @throws SecurityException if there is a security manager and the invocation of its checkPermission method fails @see #getLog @since JDK1.1