Java™ Platform
Standard Ed. 6

java.rmi.server
Class UnicastRemoteObject

java.lang.Object
  extended by java.rmi.server.RemoteObject
      extended by java.rmi.server.RemoteServer
          extended by java.rmi.server.UnicastRemoteObject
All Implemented Interfaces:
Serializable, Remote
Direct Known Subclasses:
ActivationGroup

public class UnicastRemoteObject
extends RemoteServer

Used for exporting a remote object with JRMP and obtaining a stub that communicates to the remote object.

For the constructors and static exportObject methods below, the stub for a remote object being exported is obtained as follows:

Since:
JDK1.1
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.rmi.server.RemoteObject
ref
 
Constructor Summary
protected UnicastRemoteObject()
          Creates and exports a new UnicastRemoteObject object using an anonymous port.
protected UnicastRemoteObject(int port)
          Creates and exports a new UnicastRemoteObject object using the particular supplied port.
protected UnicastRemoteObject(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
          Creates and exports a new UnicastRemoteObject object using the particular supplied port and socket factories.
 
Method Summary
 Object clone()
          Returns a clone of the remote object that is distinct from the original.
static RemoteStub exportObject(Remote obj)
          Exports the remote object to make it available to receive incoming calls using an anonymous port.
static Remote exportObject(Remote obj, int port)
          Exports the remote object to make it available to receive incoming calls, using the particular supplied port.
static Remote exportObject(Remote obj, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
          Exports the remote object to make it available to receive incoming calls, using a transport specified by the given socket factory.
static boolean unexportObject(Remote obj, boolean force)
          Removes the remote object, obj, from the RMI runtime.
 
Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
 
Methods inherited from class java.rmi.server.RemoteObject
equals, getRef, hashCode, toString, toStub
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UnicastRemoteObject

protected UnicastRemoteObject()
                       throws RemoteException
Creates and exports a new UnicastRemoteObject object using an anonymous port.

Throws:
RemoteException - if failed to export object
Since:
JDK1.1

UnicastRemoteObject

protected UnicastRemoteObject(int port)
                       throws RemoteException
Creates and exports a new UnicastRemoteObject object using the particular supplied port.

Parameters:
port - the port number on which the remote object receives calls (if port is zero, an anonymous port is chosen)
Throws:
RemoteException - if failed to export object
Since:
1.2

UnicastRemoteObject

protected UnicastRemoteObject(int port,
                              RMIClientSocketFactory csf,
                              RMIServerSocketFactory ssf)
                       throws RemoteException
Creates and exports a new UnicastRemoteObject object using the particular supplied port and socket factories.

Parameters:
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 object
ssf - the server-side socket factory for receiving remote calls
Throws:
RemoteException - if failed to export object
Since:
1.2
Method Detail

clone

public Object clone()
             throws CloneNotSupportedException
Returns a clone of the remote object that is distinct from the original.

Overrides:
clone in class Object
Returns:
the new remote object
Throws:
CloneNotSupportedException - if clone failed due to a RemoteException.
Since:
JDK1.1
See Also:
Cloneable

exportObject

public static RemoteStub exportObject(Remote obj)
                               throws RemoteException
Exports the remote object to make it available to receive incoming calls using an anonymous port.

Parameters:
obj - the remote object to be exported
Returns:
remote object stub
Throws:
RemoteException - if export fails
Since:
JDK1.1

exportObject

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

Parameters:
obj - the remote object to be exported
port - the port to export the object on
Returns:
remote object stub
Throws:
RemoteException - if export fails
Since:
1.2

exportObject

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

Parameters:
obj - the remote object to be exported
port - the port to export the object on
csf - the client-side socket factory for making calls to the remote object
ssf - the server-side socket factory for receiving remote calls
Returns:
remote object stub
Throws:
RemoteException - if export fails
Since:
1.2

unexportObject

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

Parameters:
obj - the remote object to be unexported
force - 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 calls
Returns:
true if operation is successful, false otherwise
Throws:
NoSuchObjectException - if the remote object is not currently exported
Since:
1.2

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.