org.objectweb.proactive.core.body.rmi
Class RemoteBodyImpl

java.lang.Object
  extended byjava.rmi.server.RemoteObject
      extended byjava.rmi.server.RemoteServer
          extended byjava.rmi.server.UnicastRemoteObject
              extended byorg.objectweb.proactive.core.body.rmi.RemoteBodyImpl
All Implemented Interfaces:
Handlerizable, java.rmi.Remote, RemoteBody, java.io.Serializable, java.rmi.server.Unreferenced

public class RemoteBodyImpl
extends java.rmi.server.UnicastRemoteObject
implements RemoteBody, java.rmi.server.Unreferenced

An adapter for a LocalBody to be able to receive remote calls. This helps isolate RMI-specific code into a small set of specific classes, thus enabling reuse if we one day decide to switch to anothe remote objects library.

See Also:
Serialized Form

Field Summary
protected  UniversalBody body
          The encapsulated local body transient to deal with custom serialization of requests.
protected static org.apache.log4j.Logger logger
           
 
Fields inherited from class java.rmi.server.RemoteObject
ref
 
Constructor Summary
RemoteBodyImpl()
           
RemoteBodyImpl(UniversalBody body)
           
RemoteBodyImpl(UniversalBody body, java.rmi.server.RMIServerSocketFactory sf, java.rmi.server.RMIClientSocketFactory cf)
           
 
Method Summary
 void changeProxiedBody(Body newBody)
          Change the body referenced by this adapter
 void clearHandlersLevel()
          Clear the local map of handlers
 void disableAC()
          Disables automatic continuation mechanism for this body
 void enableAC()
          Enables automatic continuation mechanism for this body
 java.security.cert.X509Certificate getCertificate()
           
 byte[] getCertificateEncoded()
           
 java.util.ArrayList getEntities()
           
 java.lang.String getHandlerizableInfo()
          Get information about the handlerizable object
 java.util.HashMap getHandlersLevel()
          Give a reference to a local map of handlers
 UniqueID getID()
          Returns the UniqueID of this body This identifier is unique accross all JVMs
 java.lang.String getJobID()
           
 java.lang.String getNodeURL()
          Returns the url of the node this body is associated to The url of the node can change if the active object migrates
 SecurityContext getPolicy(SecurityContext securityContext)
           
 Policy getPolicyFrom(java.security.cert.X509Certificate certificate)
           
 Communication getPolicyTo(java.lang.String type, java.lang.String from, java.lang.String to)
           
 ProActiveSecurityManager getProActiveSecurityManager()
           
 java.security.PublicKey getPublicKey()
           
 java.lang.String getVNName()
           
 void initiateSession(int type, UniversalBody rbody)
           
 ConfidentialityTicket negociateKeyReceiverSide(ConfidentialityTicket confidentialityTicket, long sessionID)
           
 byte[][] publicKeyExchange(long sessionID, UniversalBody distantBody, byte[] my_pub, byte[] my_cert, byte[] sig_code)
           
 byte[] randomValue(long sessionID, byte[] cl_rand)
           
 int receiveFTMessage(FTMessage fte)
          For sending a message to the FTManager linked to this object
 int receiveReply(Reply r)
          Receives a reply in response to a former request.
 int receiveRequest(Request r)
          Receives a request for later processing.
 byte[][] secretKeyExchange(long sessionID, byte[] tmp, byte[] tmp1, byte[] tmp2, byte[] tmp3, byte[] tmp4)
           
 void setExceptionHandler(Handler handler, java.lang.Class exception)
          Set a new handler within the table of the Handlerizable Object
 void setImmediateService(java.lang.String methodName)
          For setting an immediate service for this body.
 long startNewSession(Communication policy)
           
 void terminate()
          Terminate the body.
 void terminateSession(long sessionID)
           
 void unreferenced()
           
 Handler unsetExceptionHandler(java.lang.Class exception)
          Remove a handler from the table of the Handlerizable Object
 void updateLocation(UniqueID id, UniversalBody remoteBody)
          Signals to this body that the body identified by id is now to a new remote location.
 
Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, unexportObject
 
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

logger

protected static org.apache.log4j.Logger logger

body

protected transient UniversalBody body
The encapsulated local body transient to deal with custom serialization of requests.

Constructor Detail

RemoteBodyImpl

public RemoteBodyImpl()
               throws java.rmi.RemoteException

RemoteBodyImpl

public RemoteBodyImpl(UniversalBody body)
               throws java.rmi.RemoteException

RemoteBodyImpl

public RemoteBodyImpl(UniversalBody body,
                      java.rmi.server.RMIServerSocketFactory sf,
                      java.rmi.server.RMIClientSocketFactory cf)
               throws java.rmi.RemoteException
Method Detail

getJobID

public java.lang.String getJobID()
Specified by:
getJobID in interface RemoteBody

receiveRequest

public int receiveRequest(Request r)
                   throws java.io.IOException,
                          RenegotiateSessionException
Description copied from interface: RemoteBody
Receives a request for later processing. The call to this method is non blocking unless the body cannot temporary receive the request.

Specified by:
receiveRequest in interface RemoteBody
Parameters:
r - the request to process
Returns:
value for fault-tolerance protocol
Throws:
java.io.IOException - if the request cannot be accepted
RenegotiateSessionException

receiveReply

public int receiveReply(Reply r)
                 throws java.io.IOException
Description copied from interface: RemoteBody
Receives a reply in response to a former request.

Specified by:
receiveReply in interface RemoteBody
Parameters:
r - the reply received
Returns:
value for fault-tolerance protocol
Throws:
java.io.IOException - if the reply cannot be accepted

terminate

public void terminate()
               throws java.io.IOException
Description copied from interface: RemoteBody
Terminate the body. After this call the body is no more alive and no more active although the active thread is not interrupted. The body is unuseable after this call.

Specified by:
terminate in interface RemoteBody
Throws:
java.io.IOException
See Also:
RemoteBody.terminate()

getNodeURL

public java.lang.String getNodeURL()
Description copied from interface: RemoteBody
Returns the url of the node this body is associated to The url of the node can change if the active object migrates

Specified by:
getNodeURL in interface RemoteBody
Returns:
the url of the node this body is associated to

getID

public UniqueID getID()
Description copied from interface: RemoteBody
Returns the UniqueID of this body This identifier is unique accross all JVMs

Specified by:
getID in interface RemoteBody
Returns:
the UniqueID of this body

updateLocation

public void updateLocation(UniqueID id,
                           UniversalBody remoteBody)
                    throws java.io.IOException
Description copied from interface: RemoteBody
Signals to this body that the body identified by id is now to a new remote location. The body given in parameter is a new stub pointing to this new location. This call is a way for a body to signal to his peer that it has migrated to a new location

Specified by:
updateLocation in interface RemoteBody
Parameters:
id - the id of the body
remoteBody - the stub to the new location
Throws:
java.io.IOException - if an exception occured during the remote communication

unreferenced

public void unreferenced()
Specified by:
unreferenced in interface java.rmi.server.Unreferenced

enableAC

public void enableAC()
              throws java.io.IOException
Description copied from interface: RemoteBody
Enables automatic continuation mechanism for this body

Specified by:
enableAC in interface RemoteBody
Throws:
java.io.IOException

disableAC

public void disableAC()
               throws java.io.IOException
Description copied from interface: RemoteBody
Disables automatic continuation mechanism for this body

Specified by:
disableAC in interface RemoteBody
Throws:
java.io.IOException

setImmediateService

public void setImmediateService(java.lang.String methodName)
                         throws java.io.IOException
Description copied from interface: RemoteBody
For setting an immediate service for this body. An immediate service is a method that will bw excecuted by the calling thread.

Specified by:
setImmediateService in interface RemoteBody
Throws:
java.io.IOException

getHandlerizableInfo

public java.lang.String getHandlerizableInfo()
                                      throws java.io.IOException
Get information about the handlerizable object

Specified by:
getHandlerizableInfo in interface Handlerizable
Throws:
java.io.IOException

getHandlersLevel

public java.util.HashMap getHandlersLevel()
                                   throws java.io.IOException
Give a reference to a local map of handlers

Specified by:
getHandlersLevel in interface Handlerizable
Returns:
A reference to a map of handlers
Throws:
java.io.IOException

clearHandlersLevel

public void clearHandlersLevel()
                        throws java.io.IOException
Clear the local map of handlers

Specified by:
clearHandlersLevel in interface Handlerizable
Throws:
java.io.IOException

setExceptionHandler

public void setExceptionHandler(Handler handler,
                                java.lang.Class exception)
                         throws java.io.IOException
Set a new handler within the table of the Handlerizable Object

Specified by:
setExceptionHandler in interface Handlerizable
Parameters:
handler - A handler associated with a class of non functional exception.
exception - A class of non functional exception. It is a subclass of NonFunctionalException.
Throws:
java.io.IOException

unsetExceptionHandler

public Handler unsetExceptionHandler(java.lang.Class exception)
                              throws java.io.IOException
Remove a handler from the table of the Handlerizable Object

Specified by:
unsetExceptionHandler in interface Handlerizable
Parameters:
exception - A class of non functional exception. It is a subclass of NonFunctionalException.
Returns:
The removed handler or null
Throws:
java.io.IOException

initiateSession

public void initiateSession(int type,
                            UniversalBody rbody)
                     throws java.io.IOException,
                            CommunicationForbiddenException,
                            AuthenticationException,
                            RenegotiateSessionException,
                            SecurityNotAvailableException
Specified by:
initiateSession in interface RemoteBody
Throws:
java.io.IOException
CommunicationForbiddenException
AuthenticationException
RenegotiateSessionException
SecurityNotAvailableException

terminateSession

public void terminateSession(long sessionID)
                      throws java.io.IOException,
                             SecurityNotAvailableException
Specified by:
terminateSession in interface RemoteBody
Throws:
java.io.IOException
SecurityNotAvailableException

getCertificate

public java.security.cert.X509Certificate getCertificate()
                                                  throws SecurityNotAvailableException,
                                                         java.io.IOException
Specified by:
getCertificate in interface RemoteBody
Throws:
SecurityNotAvailableException
java.io.IOException

getProActiveSecurityManager

public ProActiveSecurityManager getProActiveSecurityManager()
                                                     throws SecurityNotAvailableException,
                                                            java.io.IOException
Specified by:
getProActiveSecurityManager in interface RemoteBody
Throws:
SecurityNotAvailableException
java.io.IOException

getPolicyFrom

public Policy getPolicyFrom(java.security.cert.X509Certificate certificate)
                     throws SecurityNotAvailableException,
                            java.io.IOException
Specified by:
getPolicyFrom in interface RemoteBody
Throws:
SecurityNotAvailableException
java.io.IOException

startNewSession

public long startNewSession(Communication policy)
                     throws SecurityNotAvailableException,
                            java.io.IOException,
                            RenegotiateSessionException
Specified by:
startNewSession in interface RemoteBody
Throws:
SecurityNotAvailableException
java.io.IOException
RenegotiateSessionException

negociateKeyReceiverSide

public ConfidentialityTicket negociateKeyReceiverSide(ConfidentialityTicket confidentialityTicket,
                                                      long sessionID)
                                               throws SecurityNotAvailableException,
                                                      KeyExchangeException,
                                                      java.io.IOException
Specified by:
negociateKeyReceiverSide in interface RemoteBody
Throws:
SecurityNotAvailableException
KeyExchangeException
java.io.IOException

getPublicKey

public java.security.PublicKey getPublicKey()
                                     throws SecurityNotAvailableException,
                                            java.io.IOException
Specified by:
getPublicKey in interface RemoteBody
Throws:
SecurityNotAvailableException
java.io.IOException

randomValue

public byte[] randomValue(long sessionID,
                          byte[] cl_rand)
                   throws java.lang.Exception
Specified by:
randomValue in interface RemoteBody
Throws:
java.lang.Exception

publicKeyExchange

public byte[][] publicKeyExchange(long sessionID,
                                  UniversalBody distantBody,
                                  byte[] my_pub,
                                  byte[] my_cert,
                                  byte[] sig_code)
                           throws java.lang.Exception
Specified by:
publicKeyExchange in interface RemoteBody
Throws:
java.lang.Exception

secretKeyExchange

public byte[][] secretKeyExchange(long sessionID,
                                  byte[] tmp,
                                  byte[] tmp1,
                                  byte[] tmp2,
                                  byte[] tmp3,
                                  byte[] tmp4)
                           throws java.lang.Exception
Specified by:
secretKeyExchange in interface RemoteBody
Throws:
java.lang.Exception

getPolicyTo

public Communication getPolicyTo(java.lang.String type,
                                 java.lang.String from,
                                 java.lang.String to)
                          throws java.io.IOException,
                                 SecurityNotAvailableException
Specified by:
getPolicyTo in interface RemoteBody
Throws:
java.io.IOException
SecurityNotAvailableException

getVNName

public java.lang.String getVNName()
                           throws java.io.IOException,
                                  SecurityNotAvailableException
Specified by:
getVNName in interface RemoteBody
Returns:
virtual node name where the object has been created
Throws:
java.io.IOException
SecurityNotAvailableException

getCertificateEncoded

public byte[] getCertificateEncoded()
                             throws java.io.IOException,
                                    SecurityNotAvailableException
Specified by:
getCertificateEncoded in interface RemoteBody
Returns:
object certificate as byte array
Throws:
java.io.IOException
SecurityNotAvailableException

getPolicy

public SecurityContext getPolicy(SecurityContext securityContext)
                          throws java.io.IOException,
                                 SecurityNotAvailableException
Specified by:
getPolicy in interface RemoteBody
Throws:
java.io.IOException
SecurityNotAvailableException

getEntities

public java.util.ArrayList getEntities()
                                throws SecurityNotAvailableException,
                                       java.io.IOException
Specified by:
getEntities in interface RemoteBody
Throws:
SecurityNotAvailableException
java.io.IOException

receiveFTMessage

public int receiveFTMessage(FTMessage fte)
                     throws java.io.IOException
Description copied from interface: RemoteBody
For sending a message to the FTManager linked to this object

Specified by:
receiveFTMessage in interface RemoteBody
Parameters:
fte - the message
Returns:
still not used
Throws:
java.io.IOException

changeProxiedBody

public void changeProxiedBody(Body newBody)
Description copied from interface: RemoteBody
Change the body referenced by this adapter

Specified by:
changeProxiedBody in interface RemoteBody
Parameters:
newBody - the body referenced after the call


Copyright ? April 2005 INRIA All Rights Reserved.