Home » openjdk-7 » java » rmi » server » [javadoc | source]
java.rmi.server
public interface: RemoteRef [javadoc | source]

All Implemented Interfaces:
    Externalizable

All Known Implementing Classes:
    ServerRef

RemoteRef represents the handle for a remote object. A RemoteStub uses a remote reference to carry out a remote method invocation to a remote object.
Field Summary
static final  long serialVersionUID    indicate compatibility with JDK 1.1.x version of class. 
static final  String packagePrefix    Initialize the server package prefix: assumes that the implementation of server ref classes (e.g., UnicastRef, UnicastServerRef) are located in the package defined by the prefix. 
Method from java.rmi.server.RemoteRef Summary:
done,   getRefClass,   invoke,   invoke,   newCall,   remoteEquals,   remoteHashCode,   remoteToString
Method from java.rmi.server.RemoteRef Detail:
 public  void done(RemoteCall call) throws RemoteExceptionDeprecated! 1.2 -  style stubs no longer use this method. Instead of
using a sequence of method calls to the remote reference
(newCall, invoke, and done), a
stub uses a single method, invoke(Remote, Method, Object[],
int), on the remote reference to carry out parameter
marshalling, remote method executing and unmarshalling of the return
value.

    Allows the remote reference to clean up (or reuse) the connection. Done should only be called if the invoke returns successfully (non-exceptionally) to the stub.
 public String getRefClass(ObjectOutput out)
    Returns the class name of the ref type to be serialized onto the stream 'out'.
 public  void invoke(RemoteCall call) throws ExceptionDeprecated! 1.2 -  style stubs no longer use this method. Instead of
using a sequence of method calls to the remote reference
(newCall, invoke, and done), a
stub uses a single method, invoke(Remote, Method, Object[],
int), on the remote reference to carry out parameter
marshalling, remote method executing and unmarshalling of the return
value.

    Executes the remote call. Invoke will raise any "user" exceptions which should pass through and not be caught by the stub. If any exception is raised during the remote invocation, invoke should take care of cleaning up the connection before raising the "user" or remote exception.
 public Object invoke(Remote obj,
    Method method,
    Object[] params,
    long opnum) throws Exception
    Invoke a method. This form of delegating method invocation to the reference allows the reference to take care of setting up the connection to the remote host, marshaling some representation for the method and parameters, then communicating the method invocation to the remote host. This method either returns the result of a method invocation on the remote object which resides on the remote host or throws a RemoteException if the call failed or an application-level exception if the remote invocation throws an exception.
 public RemoteCall newCall(RemoteObject obj,
    Operation[] op,
    int opnum,
    long hash) throws RemoteExceptionDeprecated! 1.2 -  style stubs no longer use this method. Instead of
using a sequence of method calls on the stub's the remote reference
(newCall, invoke, and done), a
stub uses a single method, invoke(Remote, Method, Object[],
int), on the remote reference to carry out parameter
marshalling, remote method executing and unmarshalling of the return
value.

    Creates an appropriate call object for a new remote method invocation on this object. Passing operation array and index, allows the stubs generator to assign the operation indexes and interpret them. The remote reference may need the operation to encode in the call.
 public boolean remoteEquals(RemoteRef obj)
    Compares two remote objects for equality. Returns a boolean that indicates whether this remote object is equivalent to the specified Object. This method is used when a remote object is stored in a hashtable.
 public int remoteHashCode()
    Returns a hashcode for a remote object. Two remote object stubs that refer to the same remote object will have the same hash code (in order to support remote objects as keys in hash tables).
 public String remoteToString()
    Returns a String that represents the reference of this remote object.