java.rmi.server
Class UnicastRemoteObject

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

public class UnicastRemoteObject
extends RemoteServer

The UnicastRemoteObject class defines a non-replicated remote object whose references are valid only while the server process is alive. The UnicastRemoteObject class provides support for point-to-point active object references (invocations, parameters, and results) using TCP streams.

Objects that require remote behavior should extend RemoteObject, typically via UnicastRemoteObject. If UnicastRemoteObject is not extended, the implementation class must then assume the responsibility for the correct semantics of the hashCode, equals, and toString methods inherited from the Object class, so that they behave appropriately for remote objects.

Since:
JDK1.1
Author:
Ann Wollrath, Peter Jones
See Also:
RemoteServer, RemoteObject, Serialized Form

Field Summary
private  RMIClientSocketFactory csf
           
private  int port
           
private static Class[] portFactoryParamTypes
           
private static Class[] portParamTypes
           
private static long serialVersionUID
           
private  RMIServerSocketFactory ssf
           
 
Fields inherited from class java.rmi.server.RemoteServer
 
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.
private static Remote exportObject(Remote obj, String refType, Class[] params, Object[] args)
           
private  void readObject(ObjectInputStream in)
          Re-export the remote object when it is deserialized.
private  void reexport()
           
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
 

Field Detail

port

private int port

csf

private RMIClientSocketFactory csf

ssf

private RMIServerSocketFactory ssf

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

portParamTypes

private static Class[] portParamTypes

portFactoryParamTypes

private static Class[] portFactoryParamTypes
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

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
Re-export the remote object when it is deserialized.

Throws:
IOException
ClassNotFoundException

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

reexport

private void reexport()
               throws RemoteException
Throws:
RemoteException

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

exportObject

private static Remote exportObject(Remote obj,
                                   String refType,
                                   Class[] params,
                                   Object[] args)
                            throws RemoteException
Throws:
RemoteException