org.objectweb.proactive.core.descriptor.data
Class VirtualNodeLookup

java.lang.Object
  extended byorg.objectweb.proactive.core.descriptor.data.RuntimeDeploymentProperties
      extended byorg.objectweb.proactive.core.descriptor.data.VirtualNodeLookup
All Implemented Interfaces:
Job, java.io.Serializable, VirtualNode

public class VirtualNodeLookup
extends RuntimeDeploymentProperties
implements VirtualNode

A VirtualNode represents a conceptual entity. After activation a VirtualNode represents one or several nodes. This class represents a remote VirtualNode resulting from a lookup in some registry such as RMIRegistry or JINI Lookup service. Objects of this class will be created when in an XML descriptor a VirtualNode is declared in the virtualNodesAcquisition tag and defined with

 lookup virtualNode="Dispatcher" host="hostname" protocol="rmi or jini"
 

Since:
ProActive 1.0.2
Version:
1.0, 2003/04/01
Author:
ProActive Team
See Also:
Serialized Form

Field Summary
protected  java.lang.String runtimeHostForLookup
           
protected  java.lang.String runtimePortForLookup
           
 
Fields inherited from class org.objectweb.proactive.core.descriptor.data.RuntimeDeploymentProperties
runtimeProperties
 
Fields inherited from interface org.objectweb.proactive.core.descriptor.data.VirtualNode
vnLogger
 
Constructor Summary
VirtualNodeLookup(java.lang.String name)
           
 
Method Summary
 void activate()
          Activates all the Nodes mapped to this VirtualNode in the XML Descriptor
 void addVirtualMachine(VirtualMachine virtualMachine)
          Adds a VirtualMachine entity to this VirtualNode
 int createdNodeCount()
          Deprecated. use getNumberOfCurrentlyCreatedNodes() or getNumberOfCreatedNodesAfterDeployment() instead
 void createNodeOnCurrentJvm(java.lang.String protocol)
          Creates a node with the given protocol(or null) on the current jvm, ie the jvm that originates the creation of this VirtualNode.
 java.lang.String getJobID()
           
 int getMinNumberOfNodes()
          Returns the minimum number of nodes needed for this VirtualNode.
 java.lang.String getName()
          Returns the name of this VirtualNode
 Node getNode()
          Returns the first Node created among Nodes mapped to this VirtualNode in the XML Descriptor Another call to this method will return the following created node if any.
 Node getNode(int index)
          Returns the Node mapped to this VirtualNode with the specified index.
 Node getNode(java.lang.String url)
          Returns the node of the given url among nodes mapped to this VirtualNode in the xml descriptor or null if such node does not exist.
 int getNodeCount()
          Returns the number of Nodes mapped to this VirtualNode in the XML Descriptor
 Node[] getNodes()
          Returns all nodes mapped to this VirtualNode
 java.lang.String[] getNodesURL()
          Returns all nodes url mapped to this VirualNode
 int getNumberOfCreatedNodesAfterDeployment()
          Returns the number of Nodes that could successfully be created at the end of the deployment
 int getNumberOfCurrentlyCreatedNodes()
          Returns the number of Nodes already created (at the time of the reception of method call) among the Nodes mapped to this VirtualNode in the XML Descriptor
 java.lang.String getProperty()
          Returns the value of property attribute.
 long getTimeout()
          Returns the timeout of this VirtualNode
 java.lang.Object getUniqueAO()
          Returns the unique active object created on the unique node mapped to this VirtualNode.
 VirtualMachine getVirtualMachine()
          Returns the virtualMachine entity linked to this VirtualNode or if cyclic, returns one of the VirtualMachines linked to this VirtualNode with a cyclic manner(internal count incremented each time this method is called).
 boolean isActivated()
          Returns true is this VirtualNode is already activated, false otherwise
 boolean isLookup()
           
 boolean isMultiple()
          checks the cardinality of the virtual node (i.e. whether the node is mapped to several nodes or not)
 void killAll(boolean softly)
          Kills all nodes mapped to this VirtualNode.
 void setLookupInformations(java.lang.String host, java.lang.String protocol, java.lang.String port)
           
 void setRuntimeInformations(java.lang.String information, java.lang.String value)
          Allows to set runtime informations for this VirtualNode activation.
 
Methods inherited from class org.objectweb.proactive.core.descriptor.data.RuntimeDeploymentProperties
checkProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

runtimeHostForLookup

protected java.lang.String runtimeHostForLookup

runtimePortForLookup

protected java.lang.String runtimePortForLookup
Constructor Detail

VirtualNodeLookup

public VirtualNodeLookup(java.lang.String name)
Method Detail

getProperty

public java.lang.String getProperty()
Description copied from interface: VirtualNode
Returns the value of property attribute.

Specified by:
getProperty in interface VirtualNode
Returns:
String
See Also:
VirtualNode.getProperty()

getName

public java.lang.String getName()
Description copied from interface: VirtualNode
Returns the name of this VirtualNode

Specified by:
getName in interface VirtualNode
Returns:
String
See Also:
VirtualNode.getName()

getTimeout

public long getTimeout()
Description copied from interface: VirtualNode
Returns the timeout of this VirtualNode

Specified by:
getTimeout in interface VirtualNode
Returns:
the timeout of this VirtualNode
See Also:
VirtualNode.getTimeout()

addVirtualMachine

public void addVirtualMachine(VirtualMachine virtualMachine)
Description copied from interface: VirtualNode
Adds a VirtualMachine entity to this VirtualNode

Specified by:
addVirtualMachine in interface VirtualNode
Parameters:
virtualMachine -
See Also:
VirtualNode.addVirtualMachine(VirtualMachine)

getVirtualMachine

public VirtualMachine getVirtualMachine()
Description copied from interface: VirtualNode
Returns the virtualMachine entity linked to this VirtualNode or if cyclic, returns one of the VirtualMachines linked to this VirtualNode with a cyclic manner(internal count incremented each time this method is called).

Specified by:
getVirtualMachine in interface VirtualNode
Returns:
VirtualMachine
See Also:
VirtualNode.getVirtualMachine()

activate

public void activate()
Description copied from interface: VirtualNode
Activates all the Nodes mapped to this VirtualNode in the XML Descriptor

Specified by:
activate in interface VirtualNode
See Also:
VirtualNode.activate()

getNodeCount

public int getNodeCount()
Description copied from interface: VirtualNode
Returns the number of Nodes mapped to this VirtualNode in the XML Descriptor

Specified by:
getNodeCount in interface VirtualNode
Returns:
int
See Also:
VirtualNode.getNodeCount()

createdNodeCount

public int createdNodeCount()
Deprecated. use getNumberOfCurrentlyCreatedNodes() or getNumberOfCreatedNodesAfterDeployment() instead

Specified by:
createdNodeCount in interface VirtualNode

getNumberOfCurrentlyCreatedNodes

public int getNumberOfCurrentlyCreatedNodes()
Description copied from interface: VirtualNode
Returns the number of Nodes already created (at the time of the reception of method call) among the Nodes mapped to this VirtualNode in the XML Descriptor

Specified by:
getNumberOfCurrentlyCreatedNodes in interface VirtualNode
Returns:
int the number of nodes created at the time of the method call
See Also:
VirtualNode.getNumberOfCurrentlyCreatedNodes()

getNode

public Node getNode()
             throws NodeException
Description copied from interface: VirtualNode
Returns the first Node created among Nodes mapped to this VirtualNode in the XML Descriptor Another call to this method will return the following created node if any. Note that the order in which Nodes are created has nothing to do with the order defined in the XML descriptor.

Specified by:
getNode in interface VirtualNode
Returns:
Node
Throws:
NodeException
See Also:
VirtualNode.getNode()

getNumberOfCreatedNodesAfterDeployment

public int getNumberOfCreatedNodesAfterDeployment()
Description copied from interface: VirtualNode
Returns the number of Nodes that could successfully be created at the end of the deployment

Specified by:
getNumberOfCreatedNodesAfterDeployment in interface VirtualNode
Returns:
int the number of nodes effectively created

getNode

public Node getNode(int index)
             throws NodeException
Description copied from interface: VirtualNode
Returns the Node mapped to this VirtualNode with the specified index. There is no relationship between, the order in the xml descriptor and the order in the array.

Specified by:
getNode in interface VirtualNode
Parameters:
index -
Returns:
Node the node at the specified index in the array of nodes mapped to this VirtualNode
Throws:
NodeException
See Also:
VirtualNode.getNode(int)

getNodesURL

public java.lang.String[] getNodesURL()
                               throws NodeException
Description copied from interface: VirtualNode
Returns all nodes url mapped to this VirualNode

Specified by:
getNodesURL in interface VirtualNode
Returns:
String[]. An array of string containing the url of all nodes mapped to this VirtualNode in the XML descriptor.
Throws:
NodeException
See Also:
VirtualNode.getNodesURL()

getNodes

public Node[] getNodes()
                throws NodeException
Description copied from interface: VirtualNode
Returns all nodes mapped to this VirtualNode

Specified by:
getNodes in interface VirtualNode
Returns:
Node[] An array of Node conataining all the nodes mapped to this VirtualNode in the XML descriptor
Throws:
NodeException
See Also:
VirtualNode.getNodes()

getNode

public Node getNode(java.lang.String url)
             throws NodeException
Description copied from interface: VirtualNode
Returns the node of the given url among nodes mapped to this VirtualNode in the xml descriptor or null if such node does not exist.

Specified by:
getNode in interface VirtualNode
Parameters:
url -
Returns:
Node the node of the given url or null if such node does not exist
Throws:
NodeException
See Also:
VirtualNode.getNode(String)

killAll

public void killAll(boolean softly)
Description copied from interface: VirtualNode
Kills all nodes mapped to this VirtualNode. It is in fact the runtime(so the jvm) on which the node is running that is killed. Nodes are previously unregistered from any registry.

Specified by:
killAll in interface VirtualNode
Parameters:
softly - if false, all jvms created when activating this VirtualNode are killed abruptely if true a jvm that originates the creation of a rmi registry waits until registry is empty before dying. To be more precise a thraed is created to ask periodically the registry if objects are still registered.

createNodeOnCurrentJvm

public void createNodeOnCurrentJvm(java.lang.String protocol)
Description copied from interface: VirtualNode
Creates a node with the given protocol(or null) on the current jvm, ie the jvm that originates the creation of this VirtualNode. This newly created node will is mapped on this VirtualNode

Specified by:
createNodeOnCurrentJvm in interface VirtualNode
Parameters:
protocol - the protocol to create the node. If null protocol will be set to the system property: proactive.communication.protocol.
See Also:
VirtualNode.createNodeOnCurrentJvm(String)

getUniqueAO

public java.lang.Object getUniqueAO()
                             throws ProActiveException
Description copied from interface: VirtualNode
Returns the unique active object created on the unique node mapped to this VirtualNode. This method should be called on a virtualNode, with unique_singleAO property defined in the XML descriptor. If more than one active object are found, a warning is generated, and the first active object found is returned

Specified by:
getUniqueAO in interface VirtualNode
Returns:
Object the unique active object created on the unique node mapped to this VirtualNode. If many active objects are found, the first one is returned
Throws:
ProActiveException - if no active objects are created on this VirtualNode.

isActivated

public boolean isActivated()
Description copied from interface: VirtualNode
Returns true is this VirtualNode is already activated, false otherwise

Specified by:
isActivated in interface VirtualNode

isLookup

public boolean isLookup()
Specified by:
isLookup in interface VirtualNode
Returns:
true if this VirtualNode is a VirtualNodeLookup, false if it is a VirtualNodeImpl
See Also:
VirtualNode.isLookup()

getJobID

public java.lang.String getJobID()
Specified by:
getJobID in interface Job
Returns:
the jobID associated with this object
See Also:
Job.getJobID()

setRuntimeInformations

public void setRuntimeInformations(java.lang.String information,
                                   java.lang.String value)
                            throws ProActiveException
Description copied from interface: VirtualNode
Allows to set runtime informations for this VirtualNode activation. This method allows to give to this VirtualNode some informations retrieved at runtime and not defined in the XML descriptor. In the current release, this method can be called on a VirtualNode resulting from a lookup. The only one information that can be set is LOOKUP_HOST. This information has a sense if in the XML descriptor this VirtualNode is defined with the line:
 lookup virtualNode="vnName" host="*" protocol="rmi or jini", ie the name of the host where to perform the lookup
 will be known at runtime.
 
We expect to implement several runtime informations. If this method fails, for instance, if the property does not exist or has already been set, or is performed on a VirtualNode not resulting from a lookup, an exception will be thrown but the application will carry on.

Specified by:
setRuntimeInformations in interface VirtualNode
Parameters:
information - the information to be set at runtime
value - the value of the information
Throws:
ProActiveException - if the given information does not exist or has alredy been set
See Also:
At the moment the only property that can be set at runtime is LOOKUP_HOST.

setLookupInformations

public void setLookupInformations(java.lang.String host,
                                  java.lang.String protocol,
                                  java.lang.String port)

getMinNumberOfNodes

public int getMinNumberOfNodes()
Description copied from interface: VirtualNode
Returns the minimum number of nodes needed for this VirtualNode. This number represents the minimum number of nodes, this VirtualNode needs in order to be suitable for the application. Default value is the total number of nodes requested in the XML file

Specified by:
getMinNumberOfNodes in interface VirtualNode
See Also:
VirtualNode.getMinNumberOfNodes()

isMultiple

public boolean isMultiple()
Description copied from interface: VirtualNode
checks the cardinality of the virtual node (i.e. whether the node is mapped to several nodes or not)

Specified by:
isMultiple in interface VirtualNode
Returns:
true if the virtual node is mapped to several nodes, false otherwise
See Also:
VirtualNode.isMultiple()


Copyright 2001-2005 INRIA All Rights Reserved.