org.ow2.carol.irmi
Class Ref

java.lang.Object
  org.ow2.carol.irmi.Ref

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.rmi.server.RemoteRef, Constants

public class Ref
extends java.lang.Object
implements java.rmi.server.RemoteRef, Constants

The Ref class implements the RemoteRef interface for this RMI implementation. Instances of this class are passed to a Remote object's RemoteStub implementation. These instances then get serialized and sent to the RMI client.

Author:

Rafael H. Schloming <rhs@mit.edu>

See Also:

Serialized Form

Field Summary

Fields inherited from interface java.rmi.server.RemoteRef

packagePrefix, serialVersionUID

Fields inherited from interface org.ow2.carol.irmi.Constants

DGC_PING, METHOD_CALL, METHOD_ERROR, METHOD_RESULT, SYSTEM_ERROR

Constructor Summary

Ref()
Public noargs constructor required for serialization.

Ref(java.lang.String host, int port, java.rmi.server.ObjID oid, ClientInterceptor clint)
Constructs a Ref instance.

Method Summary

void	connect(Ref ref) Make this Ref instance identical to the given Ref.
void	done(java.rmi.server.RemoteCall call) Delegates to RemoteCall#done().
void	finalize()
java.lang.String	getHost() Returns the remote host pointed to by this Ref.
java.rmi.server.ObjID	getOID() Returns the oid of this Ref.
int	getPort() Returns the port on the remote host pointed to by this Ref.
java.lang.String	getRefClass(java.io.ObjectOutput out) Returns null.
void	invoke(java.rmi.server.RemoteCall call) Delegates to RemoteCall.executeCall().
java.lang.Object	invoke(java.rmi.Remote rem, java.lang.reflect.Method meth, java.lang.Object[] args, long hash)
java.rmi.server.RemoteCall	newCall(java.rmi.server.RemoteObject obj, java.rmi.server.Operation[] ops, int opnum, long hash) Returns a new RemoteCall object.
void	readExternal(java.io.ObjectInput in)
boolean	remoteEquals(java.rmi.server.RemoteRef obj)
int	remoteHashCode()
java.lang.String	remoteToString()
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Ref

public Ref()

Public noargs constructor required for serialization.

Ref

public Ref(java.lang.String host,
           int port,
           java.rmi.server.ObjID oid,
           ClientInterceptor clint)

Constructs a Ref instance.

Parameters:

host - the remote host

port - the port on the remote host

oid - the ObjID of the remote object

clint - a ClientInterceptor or null

Method Detail

getOID

public java.rmi.server.ObjID getOID()

Returns the oid of this Ref.

Returns:

the oid of this Ref

getHost

public java.lang.String getHost()

Returns the remote host pointed to by this Ref.

Returns:

the remote host pointed to by this Ref

getPort

public int getPort()

Returns the port on the remote host pointed to by this Ref.

Returns:

the port on the remote host pointed to by this Ref

connect

public void connect(Ref ref)

Make this Ref instance identical to the given Ref.

Parameters:

ref - the ref to duplicate

invoke

public java.lang.Object invoke(java.rmi.Remote rem,
                               java.lang.reflect.Method meth,
                               java.lang.Object[] args,
                               long hash)
                        throws java.lang.Exception

Specified by:

invoke in interface java.rmi.server.RemoteRef

Throws:

java.lang.Exception

newCall

public java.rmi.server.RemoteCall newCall(java.rmi.server.RemoteObject obj,
                                          java.rmi.server.Operation[] ops,
                                          int opnum,
                                          long hash)

Returns a new RemoteCall object. This is only used for v1.1 stubs.

Specified by:

newCall in interface java.rmi.server.RemoteRef

Parameters:

obj - the stub

ops - the operations contained by the stub

opnum - the opnum to be invoked

hash - the interface hash for this remote object

Returns:

the RemoteCall implementation for use by the v1.1. stub

invoke

public void invoke(java.rmi.server.RemoteCall call)
            throws java.lang.Exception

Delegates to RemoteCall.executeCall().

Specified by:

invoke in interface java.rmi.server.RemoteRef

Parameters:

call - the RemoteCall obtained from invoking newCall(RemoteObject, Operation[], int, long)

Throws:

java.lang.Exception

done

public void done(java.rmi.server.RemoteCall call)

Delegates to RemoteCall#done().

Specified by:

done in interface java.rmi.server.RemoteRef

Parameters:

call - the RemoteCall obtained from invoking newCall(RemoteObject, Operation[], int, long)

getRefClass

public java.lang.String getRefClass(java.io.ObjectOutput out)

Returns null. This is important for indicating to the containg RemoteObject implementation that this Ref should be serialized and sent directly to the client rather than being replaced with a RemoteRef implementation from the client's RMI system.

Specified by:

getRefClass in interface java.rmi.server.RemoteRef

Parameters:

out - this is ignored

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

remoteEquals

public boolean remoteEquals(java.rmi.server.RemoteRef obj)

Specified by:

remoteEquals in interface java.rmi.server.RemoteRef

remoteHashCode

public int remoteHashCode()

Specified by:

remoteHashCode in interface java.rmi.server.RemoteRef

remoteToString

public java.lang.String remoteToString()

Specified by:

remoteToString in interface java.rmi.server.RemoteRef