org.objectweb.fractal.rmi.stub
Class Stub

java.lang.Object
  org.objectweb.fractal.rmi.stub.Stub

All Implemented Interfaces:

org.objectweb.fractal.api.Interface, Reference

public class Stub
extends java.lang.Object
implements Reference, org.objectweb.fractal.api.Interface

Super class of the stub classes generated by the RmiStubFactory. A stub gives access to an interface of a Fractal component. More precisely, it gives access to the "functional" interface provided by a server interface, and also gives access to the Interface interface implemented by this server interface. The "functional" interface is implemented by a sub class of this class, while the Interface interface is implemented by this class once and for all.

Field Summary

protected Identifier	id The identifier of the remote object to which this stub gives access.
protected MarshallerFactory	marshallerFactory The marshaller factory to be used to create new invocation messages.
protected Session_High	session The session that gives access to the remote object.
protected SessionIdentifier	sessionId The identifier of the session that gives access to the remote object.

Constructor Summary

Stub()
Constructs a new Stub.

Method Summary

boolean	equals(java.lang.Object o) Tests if the given object is equal to this stub.
protected void	finalize() Finalizes this object.
java.lang.String	getFcItfName()
org.objectweb.fractal.api.Component	getFcItfOwner()
org.objectweb.fractal.api.Type	getFcItfType()
Identifier[]	getIdentifiers() Returns the set of identifiers associated with this reference.
protected java.lang.Exception	handleException(java.lang.Exception e) Handles an exception that happen in this stub.
int	hashCode() Returns the hashcode of this stub.
protected void	invoke(Marshaller marshaller) Sends the marshaller with the invocation data down the protocol stack.
boolean	isFcInternalItf()
protected ReplyInterface	prepareInvocation(Marshaller marshaller) Prepares the marshaller prior to marshalling invocation data.
protected java.lang.Object	replaceClassName(java.lang.Object o)
protected java.lang.Object	replaceClassValue(java.lang.Object o)
protected Marshaller	request() Obtains a marshaller for marshalling invocation data.
void	setIdentifiers(Identifier[] ids) Sets the set of identifiers associated with this reference.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected Identifier id

The identifier of the remote object to which this stub gives access.

marshallerFactory

protected MarshallerFactory marshallerFactory

The marshaller factory to be used to create new invocation messages.

sessionId

protected SessionIdentifier sessionId

The identifier of the session that gives access to the remote object.

session

protected Session_High session

The session that gives access to the remote object. This session is used to send the invocation messages down the protocol stack.

Constructor Detail

Stub

public Stub()

Constructs a new Stub.

Method Detail

getIdentifiers

public Identifier[] getIdentifiers()

Returns the set of identifiers associated with this reference.

Specified by:

getIdentifiers in interface Reference

Returns:

the set of identifiers associated with this reference.

See Also:

setIdentifiers(org.objectweb.jonathan.apis.binding.Identifier[])

setIdentifiers

public void setIdentifiers(Identifier[] ids)

Sets the set of identifiers associated with this reference.

Specified by:

setIdentifiers in interface Reference

Parameters:

ids - the set of identifiers to be associated with this reference.

See Also:

getIdentifiers()

getFcItfOwner

public org.objectweb.fractal.api.Component getFcItfOwner()

Specified by:

getFcItfOwner in interface org.objectweb.fractal.api.Interface

getFcItfName

public java.lang.String getFcItfName()

Specified by:

getFcItfName in interface org.objectweb.fractal.api.Interface

getFcItfType

public org.objectweb.fractal.api.Type getFcItfType()

Specified by:

getFcItfType in interface org.objectweb.fractal.api.Interface

isFcInternalItf

public boolean isFcInternalItf()

Specified by:

isFcInternalItf in interface org.objectweb.fractal.api.Interface

request

protected Marshaller request()
                      throws MarshalException

Obtains a marshaller for marshalling invocation data.

Returns:

a marshaller for marshalling invocation data.

Throws:

MarshalException - if something goes wrong.

prepareInvocation

protected ReplyInterface prepareInvocation(Marshaller marshaller)
                                    throws MarshalException

Prepares the marshaller prior to marshalling invocation data. This preparation is protocol-specific and typically consists of adding headers to the marshaller. In line with Java method invocation semantics, a reply is expected after the remote invocation is executed; a reply interface is thus returned in order to listen for the reply.

Parameters:

marshaller - a marshaller to be used for the invocation data.

Returns:

a reply interface for listening for the reply.

Throws:

MarshalException - if something goes wrong.

invoke

protected void invoke(Marshaller marshaller)
               throws MarshalException

Sends the marshaller with the invocation data down the protocol stack.

Parameters:

marshaller - a marshaller with the invocation data.

Throws:

MarshalException - if something goes wrong.

handleException

protected java.lang.Exception handleException(java.lang.Exception e)

Handles an exception that happen in this stub.

Parameters:

e - an exception.

Returns:

the exception encapsulated in the given exception (if it is a ServerException, i.e., an exception that was thrown by the remote object and sent back in a reply message), or a new RemoteException encaspulating the given exception in the other cases (case of an exception that was thrown locally by the stub itself).

replaceClassName

protected java.lang.Object replaceClassName(java.lang.Object o)
                                     throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

replaceClassValue

protected java.lang.Object replaceClassValue(java.lang.Object o)

equals

public boolean equals(java.lang.Object o)

Tests if the given object is equal to this stub.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to be compared to this stub.

Returns:

true if the given object is a stub whose id is equal to the id of this stub, false otherwise.

hashCode

public int hashCode()

Returns the hashcode of this stub.

Overrides:

hashCode in class java.lang.Object

Returns:

the hashcode of the id of this stub.

finalize

protected void finalize()

Finalizes this object. This method closes the session associated to this stub if it is not null.

Overrides:

finalize in class java.lang.Object