File	Doc	Category	Size	Date	Package
RemoteRef.java	API Doc	Java SE 5 API	6897	Fri Aug 26 14:57:12 BST 2005	java.rmi.server

RemoteRef

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

Constructors Summary

Methods Summary
public void	done(java.rmi.server.RemoteCall call) 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. since JDK1.1 deprecated 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. param call object representing remote call throws RemoteException if remote error occurs during call cleanup see #invoke(Remote,java.lang.reflect.Method,Object[],long)
public java.lang.String	getRefClass(java.io.ObjectOutput out) Returns the class name of the ref type to be serialized onto the stream 'out'. param out the output stream to which the reference will be serialized return the class name (without package qualification) of the reference type since JDK1.1
public java.lang.Object	invoke(java.rmi.Remote obj, java.lang.reflect.Method method, java.lang.Object[] params, long opnum) 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. param obj the object that contains the RemoteRef (e.g., the RemoteStub for the object. param method the method to be invoked param params the parameter list param opnum a hash that may be used to represent the method return result of remote method invocation exception Exception if any exception occurs during remote method invocation since 1.2
public void	invoke(java.rmi.server.RemoteCall call) 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. since JDK1.1 deprecated 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. param call object representing remote call throws Exception if any exception occurs during remote method see #invoke(Remote,java.lang.reflect.Method,Object[],long)
public java.rmi.server.RemoteCall	newCall(java.rmi.server.RemoteObject obj, java.rmi.server.Operation[] op, int opnum, long hash) 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. since JDK1.1 deprecated 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. param obj remote stub through which to make call param op array of stub operations param opnum operation number param hash stub/skeleton interface hash return call object representing remote call throws RemoteException if failed to initiate new remote call see #invoke(Remote,java.lang.reflect.Method,Object[],long)
public boolean	remoteEquals(java.rmi.server.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. param obj the Object to compare with return true if these Objects are equal; false otherwise. see java.util.Hashtable since JDK1.1
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). return remote object hashcode see java.util.Hashtable since JDK1.1
public java.lang.String	remoteToString() Returns a String that represents the reference of this remote object. return string representing remote object reference since JDK1.1