org.objectweb.proactive.ext.mixedlocation
Class UniversalBodyWrapper

java.lang.Object
  org.objectweb.proactive.ext.mixedlocation.UniversalBodyWrapper

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, UniversalBody, NFEProducer, SecurityEntity, Job

public class UniversalBodyWrapper
extends java.lang.Object
implements UniversalBody, java.lang.Runnable

See Also:

Serialized Form

Field Summary

protected long	creationTime
protected UniqueID	id
protected java.lang.String	jobID
protected boolean	stop
protected long	time
protected UniversalBody	wrappedBody

Fields inherited from interface org.objectweb.proactive.core.body.UniversalBody

bodyLogger

Constructor Summary

UniversalBodyWrapper(UniversalBody body, long time)
Create a time-limited wrapper around a UniversalBody

Method Summary

void	addNFEListener(NFEListener listener)
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
int	fireNFE(NonFunctionalException e)
java.security.cert.X509Certificate	getCertificate() entity certificate
byte[]	getCertificateEncoded() Entity's X509Certificate as byte array
java.util.ArrayList<Entity>	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
byte[][]	publicKeyExchange(long sessionID, byte[] my_pub, byte[] my_cert, byte[] sig_code) 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 non fonctional 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	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)
void	run()
byte[][]	secretKeyExchange(long sessionID, byte[] tmp, byte[] tmp1, byte[] tmp2, byte[] tmp3, byte[] tmp4) 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	updateLocation(UniqueID id, UniversalBody body) Signals to this body that the body identified by id is now to a new remote location.
protected void	updateServer()

Methods inherited from class java.lang.Object

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

Field Detail

wrappedBody

protected UniversalBody wrappedBody

time

protected long time

id

protected UniqueID id

stop

protected boolean stop

creationTime

protected long creationTime

jobID

protected java.lang.String jobID

Constructor Detail

UniversalBodyWrapper

public UniversalBodyWrapper(UniversalBody body,
                            long time)

Create a time-limited wrapper around a UniversalBody

Parameters:

body - the wrapped UniversalBody

time - the life expectancy of this wrapper in milliseconds

Method Detail

receiveRequest

public int receiveRequest(Request request)
                   throws java.io.IOException,
                          RenegotiateSessionException

Description copied from interface: UniversalBody

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 UniversalBody

Parameters:

request - 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: UniversalBody

Receives a reply in response to a former request.

Specified by:

receiveReply in interface UniversalBody

Parameters:

r - the reply received

Returns:

value for fault-tolerance procotol

Throws:

java.io.IOException - if the reply cannot be accepted

terminate

public void terminate()
               throws java.io.IOException

Description copied from interface: UniversalBody

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 UniversalBody

Throws:

java.io.IOException - if a pb occurs during this method call

See Also:

UniversalBody.terminate()

getNodeURL

public java.lang.String getNodeURL()

Description copied from interface: UniversalBody

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 UniversalBody

Returns:

the url of the node this body is associated to

getID

public UniqueID getID()

Description copied from interface: UniversalBody

Returns the UniqueID of this body This identifier is unique accross all JVMs

Specified by:

getID in interface UniversalBody

Returns:

the UniqueID of this body

getJobID

public java.lang.String getJobID()

Specified by:

getJobID in interface Job

Returns:

the jobID associated with this object

updateLocation

public void updateLocation(UniqueID id,
                           UniversalBody body)
                    throws java.io.IOException

Description copied from interface: UniversalBody

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 UniversalBody

Parameters:

id - the id of the body

body - the stub to the new location

Throws:

java.io.IOException - if a pb occurs during this method call

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

enableAC

public void enableAC()
              throws java.io.IOException

Description copied from interface: UniversalBody

Enables automatic continuation mechanism for this body

Specified by:

enableAC in interface UniversalBody

Throws:

java.io.IOException - if a pb occurs during this method call

disableAC

public void disableAC()
               throws java.io.IOException

Description copied from interface: UniversalBody

Disables automatic continuation mechanism for this body

Specified by:

disableAC in interface UniversalBody

Throws:

java.io.IOException - if a pb occurs during this method call

setImmediateService

public void setImmediateService(java.lang.String methodName)
                         throws java.io.IOException

Description copied from interface: UniversalBody

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 UniversalBody

Throws:

java.io.IOException - if a pb occurs during this method call

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 UniversalBody

Parameters:

methodName - the name of the method

parametersTypes - the types of the parameters of the method

Throws:

java.io.IOException - if a pb occurs during this method call

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 UniversalBody

Parameters:

methodName - the name of the method

parametersTypes - the types of the parameters of the method

Throws:

java.io.IOException - if a pb occurs during this method call

updateServer

protected void updateServer()

run

public void run()

Specified by:

run in interface java.lang.Runnable

addNFEListener

public void addNFEListener(NFEListener listener)

Specified by:

addNFEListener in interface NFEProducer

removeNFEListener

public void removeNFEListener(NFEListener listener)

Specified by:

removeNFEListener in interface NFEProducer

fireNFE

public int fireNFE(NonFunctionalException e)

Specified by:

fireNFE in interface NFEProducer

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

Throws:

SecurityNotAvailableException - id security is not available

java.io.IOException

getCertificate

public java.security.cert.X509Certificate getCertificate()
                                                  throws java.io.IOException,
                                                         SecurityNotAvailableException

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

startNewSession

public long startNewSession(Communication policy)
                     throws java.io.IOException,
                            RenegotiateSessionException,
                            SecurityNotAvailableException

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

getPublicKey

public java.security.PublicKey getPublicKey()
                                     throws java.io.IOException,
                                            SecurityNotAvailableException

Description copied from interface: SecurityEntity

entity public key

Specified by:

getPublicKey in interface SecurityEntity

Returns:

returns entity public key

Throws:

SecurityNotAvailableException

java.io.IOException

randomValue

public byte[] randomValue(long sessionID,
                          byte[] cl_rand)
                   throws java.io.IOException,
                          SecurityNotAvailableException,
                          RenegotiateSessionException

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:

SecurityNotAvailableException - if the security is not available

RenegotiateSessionException - if the session has expired

java.io.IOException

publicKeyExchange

public byte[][] publicKeyExchange(long sessionID,
                                  byte[] my_pub,
                                  byte[] my_cert,
                                  byte[] sig_code)
                           throws java.io.IOException,
                                  SecurityNotAvailableException,
                                  RenegotiateSessionException,
                                  KeyExchangeException

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

my_pub - encoded public key

my_cert - encoded certificate

sig_code - 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

RenegotiateSessionException - if the session has expired

KeyExchangeException - if a key data/length/algorithm is not supported

java.io.IOException

secretKeyExchange

public byte[][] secretKeyExchange(long sessionID,
                                  byte[] tmp,
                                  byte[] tmp1,
                                  byte[] tmp2,
                                  byte[] tmp3,
                                  byte[] tmp4)
                           throws java.io.IOException,
                                  SecurityNotAvailableException,
                                  RenegotiateSessionException

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

tmp - the AES key use to exchange secret message

tmp1 - Initilization parameters for the AES key

tmp2 - MAC key for checking signature of future messages

tmp3 - random value to prevent message replays by an external attacker

tmp4 - 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

SecurityNotAvailableException - if this entity does not support security

RenegotiateSessionException - if the session has expired or has been cancelled during this exchange

getCertificateEncoded

public byte[] getCertificateEncoded()
                             throws java.io.IOException,
                                    SecurityNotAvailableException

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:

java.io.IOException

SecurityNotAvailableException

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

getEntities

public java.util.ArrayList<Entity> 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

receiveFTMessage

public java.lang.Object receiveFTMessage(FTMessage ev)
                                  throws java.io.IOException

Description copied from interface: UniversalBody

For sending a non fonctional message to the FTManager linked to this object.

Specified by:

receiveFTMessage in interface UniversalBody

Parameters:

ev - the message to send

Returns:

depends on the message meaning

Throws:

java.io.IOException - if a pb occurs during this method call

See Also:

UniversalBody.receiveFTMessage(org.objectweb.proactive.core.body.ft.internalmsg.FTMessage)

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