Serializable
, Remote
public class UnicastRemoteObject extends RemoteServer
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 non-deprecated ways of exporting objects as listed below.
There are eight 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. exportObject(Remote, port, filter)
method. exportObject(Remote, port, csf, ssf, filter)
method. The fourth technique, exportObject(Remote)
, always uses statically generated stubs and is deprecated.
The other 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. 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
, it must reside in a package that is exported to at least the java.rmi
module, and it 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:
Proxy
class, using the class loader of the remote object's class. java.rmi
module, or it must reside in a package that is open to at least the java.rmi
module. RemoteObjectInvocationHandler
instance constructed with a RemoteRef
. StubNotFoundException
will be thrown. Exported remote objects receive method invocations from the stubs as described in the RMI specification. Each invocation's operation and parameters are unmarshaled using a custom ObjectInputStream
. If an ObjectInputFilter
is provided and is not null
when the object is exported, it is used to filter the parameters as they are unmarshaled from the stream. The filter is used for all invocations and all parameters regardless of the method being invoked or the parameter values. If no filter is provided or is null
for the exported object then the ObjectInputStream
default filter, if any, is used. The default filter is configured with ObjectInputFilter.Config.setSerialFilter
. If the filter rejects any of the parameters, the InvalidClassException
thrown by ObjectInputStream
is reported as the cause of an UnmarshalException
.
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
Modifier | Constructor | Description |
---|---|---|
protected |
Creates and exports a new UnicastRemoteObject object using an anonymous port. |
|
protected |
Creates and exports a new UnicastRemoteObject object using the particular supplied port. |
|
protected |
Creates and exports a new UnicastRemoteObject object using the particular supplied port and socket factories. |
Modifier and Type | Method | Description |
---|---|---|
Object |
clone() |
Returns a clone of the remote object that is distinct from the original. |
static RemoteStub |
exportObject |
Deprecated. This method is deprecated because it supports only static stubs. |
static Remote |
exportObject |
Exports the remote object to make it available to receive incoming calls, using the particular supplied port. |
static Remote |
exportObject |
Exports the remote object to make it available to receive incoming calls, using the particular supplied port and filter. |
static Remote |
exportObject |
Exports the remote object to make it available to receive incoming calls, using a transport specified by the given socket factory. |
static Remote |
exportObject |
Exports the remote object to make it available to receive incoming calls, using a transport specified by the given socket factory and filter. |
static boolean |
unexportObject |
Removes the remote object, obj, from the RMI runtime. |
getClientHost, getLog, setLog
protected UnicastRemoteObject() throws RemoteException
The object is exported with a server socket created using the RMISocketFactory
class.
RemoteException
- if failed to export objectprotected UnicastRemoteObject(int port) throws RemoteException
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
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
clone
in class Object
CloneNotSupportedException
- if clone failed due to a RemoteException.@Deprecated public static RemoteStub exportObject(Remote obj) throws RemoteException
exportObject(Remote, port)
or exportObject(Remote, port, csf, ssf)
instead.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
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
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 Remote exportObject(Remote obj, int port, ObjectInputFilter filter) throws RemoteException
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 onfilter
- an ObjectInputFilter applied when deserializing invocation arguments; may be null
RemoteException
- if export failspublic static Remote exportObject(Remote obj, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf, ObjectInputFilter filter) throws RemoteException
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 callsfilter
- an ObjectInputFilter applied when deserializing invocation arguments; may be null
RemoteException
- if export failspublic static boolean unexportObject(Remote obj, boolean force) throws NoSuchObjectException
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, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.rmi/java/rmi/server/UnicastRemoteObject.html