org.objectweb.proactive.core.body
Class BodyAdapterForwarder

java.lang.Object
  extended byorg.objectweb.proactive.core.body.BodyAdapter
      extended byorg.objectweb.proactive.core.body.BodyAdapterForwarder
All Implemented Interfaces:
java.lang.Cloneable, Job, NFEProducer, RemoteBody, SecurityEntity, java.io.Serializable, UniversalBody

public class BodyAdapterForwarder
extends BodyAdapter
implements java.lang.Cloneable, RemoteBody

An adapter for a RemoteBodyForwarder. The Adpater is the generic entry point for remote calls to a RemoteBodyForwarder using different protocols such as RMI, RMISSH, IBIS, HTTP, JINI. This also allows to cache informations, and so to avoid crossing the network when calling some methods. A BodyAdapterForwarder has also an UniqueID which permit to associate an adapter to a body on the forwarder since forwarder basically works like a multiplexer.

Author:
ProActiveTeam
See Also:
BodyForwarderImpl, Serialized Form

Field Summary
protected  RemoteBodyForwarder proxiedRemoteBody
          The encapsulated RmiRemoteBody Points to the BodyForwarder running on the forwarder.
 
Fields inherited from class org.objectweb.proactive.core.body.BodyAdapter
bodyID, jobID
 
Fields inherited from interface org.objectweb.proactive.core.body.RemoteBody
bodyLogger
 
Fields inherited from interface org.objectweb.proactive.core.body.UniversalBody
bodyLogger
 
Constructor Summary
BodyAdapterForwarder(BodyAdapterForwarder defaultAdapterForwarder, BodyAdapter remoteAdapter)
          Create an adpater pointing on the remoteBody pointed by defaultAdapterForwarder and associated to the ID contained in remoteAdapter.
BodyAdapterForwarder(RemoteBodyForwarder remoteBodyForwarder)
          Create an adapter on the local RemoteBodyForwarder.
BodyAdapterForwarder(RemoteBodyForwarder remoteBodyForwarder, UniqueID id)
          Create an adapter pointing on remoteBodyForwarder and associated to the id.
 
Method Summary
 void addNFEListener(NFEListener listener)
           
 void changeProxiedBody(Body newBody)
          Change the body referenced by this adapter
protected  void construct(BodyAdapterForwarder localBody, BodyAdapter remoteBody, UniqueID id)
           
 void createShortcut(Shortcut shortcut)
          similar to the UniversalBody.updateLocation(org.objectweb.proactive.core.UniqueID, UniversalBody) method, it allows direct communication to the target of a functional call, accross membranes of composite components.
 void disableAC()
          Disables automatic continuation mechanism for this body
 void enableAC()
          Enables automatic continuation mechanism for this body
 boolean equals(java.lang.Object o)
           
 int fireNFE(NonFunctionalException e)
           
 java.security.cert.X509Certificate getCertificate()
          entity certificate
 byte[] getCertificateEncoded()
          Entity's X509Certificate as byte array
 java.util.ArrayList getEntities()
          Retrieves all the entity's ID which contain this entity plus this entity ID.
 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)
          Ask the entity to fill the securityContext parameters with its own policy according to the communication details contained in the given securityContext
 java.security.PublicKey getPublicKey()
          entity public key
 BodyAdapter getRemoteAdapter()
          Returns the remote friendly version of this body
 int hashCode()
           
 UniversalBody lookup(java.lang.String url)
          Looks-up an active object previously registered in a registry.
 byte[][] publicKeyExchange(long sessionID, byte[] myPublicKey, byte[] myCertificate, byte[] signature)
          exchange entity certificate and/or public key if certificate are not available
 byte[] randomValue(long sessionID, byte[] cl_rand)
          Exchange random value between client and server entity
 java.lang.Object receiveFTMessage(FTMessage ev)
          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 request)
          Receives a request for later processing.
 void register(java.lang.String url)
          Registers an active object into protocol-specific registry.
 void removeImmediateService(java.lang.String methodName, java.lang.Class[] parametersTypes)
          Removes an immediate service for this body An immediate service is a method that will bw excecuted by the calling thread.
 void removeNFEListener(NFEListener listener)
           
 byte[][] secretKeyExchange(long sessionID, byte[] encodedAESKey, byte[] encodedIVParameters, byte[] encodedClientMacKey, byte[] encodedLockData, byte[] parametersSignature)
          this method sends encoded secret parameters to the target entity
 void setImmediateService(java.lang.String methodName)
          For setting an immediate service for this body.
 void setImmediateService(java.lang.String methodName, java.lang.Class[] parametersTypes)
          Adds an immediate service for this body An immediate service is a method that will bw excecuted by the calling thread.
 long startNewSession(Communication policy)
          start an unvalidated empty session
 void terminate()
          Terminate the body.
 void terminateSession(long sessionID)
          terminate a given session
 void unregister(java.lang.String url)
          Unregisters an active object previously registered into a registry.
 void updateLocation(UniqueID uid, UniversalBody body)
          Signals to this body that the body identified by id is now to a new remote location.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

proxiedRemoteBody

protected RemoteBodyForwarder proxiedRemoteBody
The encapsulated RmiRemoteBody Points to the BodyForwarder running on the forwarder.

Constructor Detail

BodyAdapterForwarder

public BodyAdapterForwarder(RemoteBodyForwarder remoteBodyForwarder)
Create an adapter on the local RemoteBodyForwarder. An adapter created by this constructor must not be send over the network


BodyAdapterForwarder

public BodyAdapterForwarder(RemoteBodyForwarder remoteBodyForwarder,
                            UniqueID id)
Create an adapter pointing on remoteBodyForwarder and associated to the id.

Parameters:
remoteBodyForwarder - the bodyForwarder on the forwarder
id - the ID of the associated BodyAdapter

BodyAdapterForwarder

public BodyAdapterForwarder(BodyAdapterForwarder defaultAdapterForwarder,
                            BodyAdapter remoteAdapter)
Create an adpater pointing on the remoteBody pointed by defaultAdapterForwarder and associated to the ID contained in remoteAdapter.

Parameters:
defaultAdapterForwarder - the original adapter
remoteAdapter -
Method Detail

changeProxiedBody

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

Specified by:
changeProxiedBody in interface RemoteBody
Specified by:
changeProxiedBody in class BodyAdapter
Parameters:
newBody - the body referenced after the call
Throws:
java.io.IOException - if a pb occurs during this method call

lookup

public UniversalBody lookup(java.lang.String url)
                     throws java.io.IOException
Description copied from class: BodyAdapter
Looks-up an active object previously registered in a registry. In fact it is the remote version of the body of an active object that can be registered into the Registry under a given URL.

Specified by:
lookup in class BodyAdapter
Parameters:
url - the url the remote Body is registered to
Returns:
a UniversalBody
Throws:
java.io.IOException - if the remote body cannot be found under the given url or if the object found is not of type RemoteBody

register

public void register(java.lang.String url)
              throws java.io.IOException
Description copied from class: BodyAdapter
Registers an active object into protocol-specific registry. In fact it is the remote version of the body of the active object that is registered into the Registry under the given URL.

Specified by:
register in class BodyAdapter
Parameters:
url - the url under which the remote body is registered.
Throws:
java.io.IOException - if the remote body cannot be registered

unregister

public void unregister(java.lang.String url)
                throws java.io.IOException
Description copied from class: BodyAdapter
Unregisters an active object previously registered into a registry.

Specified by:
unregister in class BodyAdapter
Parameters:
url - the url under which the active object is registered.
Throws:
java.io.IOException - if the remote object cannot be removed from the registry

equals

public boolean equals(java.lang.Object o)

hashCode

public int hashCode()

construct

protected void construct(BodyAdapterForwarder localBody,
                         BodyAdapter remoteBody,
                         UniqueID id)
                  throws ProActiveException
Throws:
ProActiveException

getJobID

public java.lang.String getJobID()
Specified by:
getJobID in interface RemoteBody
Returns:
the JobID of the remote body
See Also:
Job.getJobID()

receiveRequest

public int receiveRequest(Request request)
                   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:
request - the request to process
Returns:
value for fault-tolerance protocol
Throws:
java.io.IOException - if the request cannot be accepted
RenegotiateSessionException
See Also:
UniversalBody.receiveRequest(org.objectweb.proactive.core.body.request.Request)

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
See Also:
UniversalBody.receiveReply(org.objectweb.proactive.core.body.reply.Reply)

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
See Also:
UniversalBody.getNodeURL()

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
See Also:
UniversalBody.getID()

updateLocation

public void updateLocation(UniqueID uid,
                           UniversalBody body)
                    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:
uid - the id of the body
body - the stub to the new location
Throws:
java.io.IOException - if an exception occured during the remote communication
See Also:
UniversalBody.updateLocation(org.objectweb.proactive.core.UniqueID, org.objectweb.proactive.core.body.UniversalBody)

createShortcut

public void createShortcut(Shortcut shortcut)
                    throws java.io.IOException
Description copied from interface: UniversalBody
similar to the UniversalBody.updateLocation(org.objectweb.proactive.core.UniqueID, UniversalBody) method, it allows direct communication to the target of a functional call, accross membranes of composite components.

Specified by:
createShortcut in interface UniversalBody
Parameters:
shortcut - the shortcut to create
Throws:
java.io.IOException - if a pb occurs during this method call
See Also:
UniversalBody.createShortcut(org.objectweb.proactive.core.component.request.Shortcut)

getRemoteAdapter

public BodyAdapter getRemoteAdapter()
Description copied from interface: UniversalBody
Returns the remote friendly version of this body

Specified by:
getRemoteAdapter in interface UniversalBody
Returns:
the remote friendly version of this body
See Also:
UniversalBody.getRemoteAdapter()

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 - if an exception occured during the remote communication
See Also:
UniversalBody.terminate()

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 - if an exception occured during the remote communication
See Also:
UniversalBody.enableAC()

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 - if an exception occured during the remote communication
See Also:
UniversalBody.disableAC()

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 - if an exception occured during the remote communication
See Also:
UniversalBody.setImmediateService(java.lang.String)

setImmediateService

public void setImmediateService(java.lang.String methodName,
                                java.lang.Class[] parametersTypes)
                         throws java.io.IOException
Description copied from interface: UniversalBody
Adds 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
See Also:
UniversalBody.setImmediateService(java.lang.String, java.lang.Class[])

removeImmediateService

public void removeImmediateService(java.lang.String methodName,
                                   java.lang.Class[] parametersTypes)
                            throws java.io.IOException
Description copied from interface: UniversalBody
Removes an immediate service for this body An immediate service is a method that will bw excecuted by the calling thread.

Specified by:
removeImmediateService in interface RemoteBody
Throws:
java.io.IOException
See Also:
UniversalBody.removeImmediateService(java.lang.String, java.lang.Class[])

terminateSession

public void terminateSession(long sessionID)
                      throws java.io.IOException,
                             SecurityNotAvailableException
Description copied from interface: SecurityEntity
terminate a given session

Specified by:
terminateSession in interface SecurityEntity
Parameters:
sessionID -
Throws:
SecurityNotAvailableException - id security is not available
java.io.IOException
See Also:
SecurityEntity.terminateSession(long)

getCertificate

public java.security.cert.X509Certificate getCertificate()
                                                  throws SecurityNotAvailableException,
                                                         java.io.IOException
Description copied from interface: SecurityEntity
entity certificate

Specified by:
getCertificate in interface SecurityEntity
Returns:
returns entity certificate
Throws:
java.io.IOException - if communication fails
SecurityNotAvailableException - if security is not available
See Also:
SecurityEntity.getCertificate()

startNewSession

public long startNewSession(Communication policy)
                     throws SecurityNotAvailableException,
                            java.io.IOException,
                            RenegotiateSessionException
Description copied from interface: SecurityEntity
start an unvalidated empty session

Specified by:
startNewSession in interface SecurityEntity
Parameters:
policy - policy associated to the session
Returns:
session ID
Throws:
RenegotiateSessionException - if the session immediatly expires
SecurityNotAvailableException - if security is not available
java.io.IOException
See Also:
SecurityEntity.startNewSession(org.objectweb.proactive.ext.security.Communication)

getPublicKey

public java.security.PublicKey getPublicKey()
                                     throws SecurityNotAvailableException,
                                            java.io.IOException
Description copied from interface: SecurityEntity
entity public key

Specified by:
getPublicKey in interface SecurityEntity
Returns:
returns entity public key
Throws:
SecurityNotAvailableException
java.io.IOException
See Also:
SecurityEntity.getPublicKey()

randomValue

public byte[] randomValue(long sessionID,
                          byte[] cl_rand)
                   throws SecurityNotAvailableException,
                          RenegotiateSessionException,
                          java.io.IOException
Description copied from interface: SecurityEntity
Exchange random value between client and server entity

Specified by:
randomValue in interface SecurityEntity
Parameters:
sessionID - the session ID
cl_rand - client random value
Returns:
server random value
Throws:
RenegotiateSessionException - if the session has expired
SecurityNotAvailableException - if the security is not available
java.io.IOException
See Also:
SecurityEntity.randomValue(long, byte[])

secretKeyExchange

public byte[][] secretKeyExchange(long sessionID,
                                  byte[] encodedAESKey,
                                  byte[] encodedIVParameters,
                                  byte[] encodedClientMacKey,
                                  byte[] encodedLockData,
                                  byte[] parametersSignature)
                           throws SecurityNotAvailableException,
                                  RenegotiateSessionException,
                                  java.io.IOException
Description copied from interface: SecurityEntity
this method sends encoded secret parameters to the target entity

Specified by:
secretKeyExchange in interface SecurityEntity
Parameters:
sessionID - session ID
encodedAESKey - the AES key use to exchange secret message
encodedIVParameters - Initilization parameters for the AES key
encodedClientMacKey - MAC key for checking signature of future messages
encodedLockData - random value to prevent message replays by an external attacker
parametersSignature - encoded signature of the previous parameters
Returns:
an array containing : - encoded server AES key - encoded IV parameters - encoded server MAC key - encoded lock data to prevent message replays - encoded signature of previous parameters
Throws:
java.io.IOException - if communication fails
RenegotiateSessionException - if the session has expired or has been cancelled during this exchange
SecurityNotAvailableException - if this entity does not support security
See Also:
SecurityEntity.secretKeyExchange(long, byte[], byte[], byte[], byte[], byte[])

getPolicy

public SecurityContext getPolicy(SecurityContext securityContext)
                          throws SecurityNotAvailableException,
                                 java.io.IOException
Description copied from interface: SecurityEntity
Ask the entity to fill the securityContext parameters with its own policy according to the communication details contained in the given securityContext

Specified by:
getPolicy in interface SecurityEntity
Parameters:
securityContext - communication details allowing the entity to look for a matching policy
Returns:
securityContext filled with this entity's policy
Throws:
SecurityNotAvailableException - thrown the entity doest not support the security
java.io.IOException
See Also:
SecurityEntity.getPolicy(org.objectweb.proactive.ext.security.SecurityContext)

getCertificateEncoded

public byte[] getCertificateEncoded()
                             throws SecurityNotAvailableException,
                                    java.io.IOException
Description copied from interface: SecurityEntity
Entity's X509Certificate as byte array

Specified by:
getCertificateEncoded in interface SecurityEntity
Returns:
entity's X509Certificate as byte array
Throws:
SecurityNotAvailableException
java.io.IOException
See Also:
SecurityEntity.getCertificateEncoded()

getEntities

public java.util.ArrayList getEntities()
                                throws SecurityNotAvailableException,
                                       java.io.IOException
Description copied from interface: SecurityEntity
Retrieves all the entity's ID which contain this entity plus this entity ID.

Specified by:
getEntities in interface SecurityEntity
Returns:
returns all the entity's ID which contain this entity plus this entity ID.
Throws:
SecurityNotAvailableException - if the target entity does not support security
java.io.IOException
See Also:
SecurityEntity.getEntities()

receiveFTMessage

public java.lang.Object receiveFTMessage(FTMessage ev)
                                  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:
ev - the message
Returns:
depends on the message meaning
Throws:
java.io.IOException - if an exception occured during the remote communication

addNFEListener

public void addNFEListener(NFEListener listener)
Specified by:
addNFEListener in interface RemoteBody

removeNFEListener

public void removeNFEListener(NFEListener listener)
Specified by:
removeNFEListener in interface RemoteBody

fireNFE

public int fireNFE(NonFunctionalException e)
Specified by:
fireNFE in interface RemoteBody

publicKeyExchange

public byte[][] publicKeyExchange(long sessionID,
                                  byte[] myPublicKey,
                                  byte[] myCertificate,
                                  byte[] signature)
                           throws SecurityNotAvailableException,
                                  RenegotiateSessionException,
                                  KeyExchangeException,
                                  java.io.IOException
Description copied from interface: SecurityEntity
exchange entity certificate and/or public key if certificate are not available

Specified by:
publicKeyExchange in interface SecurityEntity
Parameters:
sessionID - the session ID
myPublicKey - encoded public key
myCertificate - encoded certificate
signature - encoded signature of previous paramaters
Returns:
an array containing : - server certificate and/or server public key - encoded signature of these parameters
Throws:
SecurityNotAvailableException - if the security is not available
KeyExchangeException - if a key data/length/algorithm is not supported
RenegotiateSessionException - if the session has expired
java.io.IOException


Copyright 2001-2005 INRIA All Rights Reserved.