public class UnicastRemoteObject extends RemoteServer
Used for exporting a remote object with JRMP and obtaining a stub that communicates to the remote object. Stubs are either generated at runtime using dynamic proxy objects, or they are generated statically at build time, typically using the rmic
tool.
Deprecated: Static Stubs. Support for statically generated stubs is deprecated. This includes the API in this class that requires the use of static stubs, as well as the runtime support for loading static stubs. Generating stubs dynamically is preferred, using one of the five non-deprecated ways of exporting objects as listed below. Do not run rmic
to generate static stub classes. It is unnecessary, and it is also deprecated.
There are six ways to export remote objects:
UnicastRemoteObject
and calling the UnicastRemoteObject()
constructor. UnicastRemoteObject
and calling the UnicastRemoteObject(port)
constructor. UnicastRemoteObject
and calling the UnicastRemoteObject(port, csf, ssf)
constructor. exportObject(Remote)
method. Deprecated. exportObject(Remote, port)
method. exportObject(Remote, port, csf, ssf)
method. The fourth technique, exportObject(Remote)
, always uses statically generated stubs and is deprecated.
The other five techniques all use the following approach: if the java.rmi.server.ignoreStubClasses
property is true
(case insensitive) or if a static stub cannot be found, stubs are generated dynamically using Proxy
objects. Otherwise, static stubs are used.
The default value of the java.rmi.server.ignoreStubClasses
property is false
.
Statically generated stubs are typically pregenerated from the remote object's class using the rmic
tool. A static stub is loaded and an instance of that stub class is constructed as described below.
Remote
, then the remote object's class is the root class; otherwise, the root class is the most derived superclass of the remote object's class that directly implements an interface that extends Remote
. _Stub
. RemoteStub
and must have a public constructor that has one parameter of type RemoteRef
. RemoteRef
. StubNotFoundException
is thrown. Stubs are dynamically generated by constructing an instance of a Proxy
with the following characteristics:
RemoteObjectInvocationHandler
instance constructed with a RemoteRef
. StubNotFoundException
will be thrown. RMISocketFactory
may be used for creating sockets. By default, server sockets created by RMISocketFactory
listen on all network interfaces. See the RMISocketFactory
class and the section RMI Socket Factories in the Java RMI Specification.ref
protected UnicastRemoteObject() throws RemoteException
Creates and exports a new UnicastRemoteObject object using an anonymous port.
The object is exported with a server socket created using the RMISocketFactory
class.
RemoteException
- if failed to export objectprotected UnicastRemoteObject(int port) throws RemoteException
Creates and exports a new UnicastRemoteObject object using the particular supplied port.
The object is exported with a server socket created using the RMISocketFactory
class.
port
- the port number on which the remote object receives calls (if port
is zero, an anonymous port is chosen)RemoteException
- if failed to export objectprotected UnicastRemoteObject(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) throws RemoteException
Creates and exports a new UnicastRemoteObject object using the particular supplied port and socket factories.
Either socket factory may be null
, in which case the corresponding client or server socket creation method of RMISocketFactory
is used instead.
port
- the port number on which the remote object receives calls (if port
is zero, an anonymous port is chosen)csf
- the client-side socket factory for making calls to the remote objectssf
- the server-side socket factory for receiving remote callsRemoteException
- if failed to export objectpublic Object clone() throws CloneNotSupportedException
Returns a clone of the remote object that is distinct from the original.
clone
in class Object
CloneNotSupportedException
- if clone failed due to a RemoteException.Cloneable
@Deprecated public static RemoteStub exportObject(Remote obj) throws RemoteException
Deprecated. This method is deprecated because it supports only static stubs. Use exportObject(Remote, port)
or exportObject(Remote, port, csf, ssf)
instead.
Exports the remote object to make it available to receive incoming calls using an anonymous port. This method will always return a statically generated stub.
The object is exported with a server socket created using the RMISocketFactory
class.
obj
- the remote object to be exportedRemoteException
- if export failspublic static Remote exportObject(Remote obj, int port) throws RemoteException
Exports the remote object to make it available to receive incoming calls, using the particular supplied port.
The object is exported with a server socket created using the RMISocketFactory
class.
obj
- the remote object to be exportedport
- the port to export the object onRemoteException
- if export failspublic static Remote exportObject(Remote obj, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) throws RemoteException
Exports the remote object to make it available to receive incoming calls, using a transport specified by the given socket factory.
Either socket factory may be null
, in which case the corresponding client or server socket creation method of RMISocketFactory
is used instead.
obj
- the remote object to be exportedport
- the port to export the object oncsf
- the client-side socket factory for making calls to the remote objectssf
- the server-side socket factory for receiving remote callsRemoteException
- if export failspublic static boolean unexportObject(Remote obj, boolean force) throws NoSuchObjectException
Removes the remote object, obj, from the RMI runtime. If successful, the object can no longer accept incoming RMI calls. If the force parameter is true, the object is forcibly unexported even if there are pending calls to the remote object or the remote object still has calls in progress. If the force parameter is false, the object is only unexported if there are no pending or in progress calls to the object.
obj
- the remote object to be unexportedforce
- if true, unexports the object even if there are pending or in-progress calls; if false, only unexports the object if there are no pending or in-progress callsNoSuchObjectException
- if the remote object is not currently exported
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.