org.objectweb.proactive.core.node
Interface Node

All Known Implementing Classes:
NodeImpl

public interface Node

A Node offers a set of services needed by ProActive to work with remote JVM. Each JVM that is aimed to hold active objects should contains at least one instance of the node class. That instance, when created, will be registered to some registry where it is possible to perform a lookup (such as the RMI registry).

When ProActive needs to interact with a remote JVM, it will lookup for one node associated with that JVM (using typically the RMI Registry) and use this node to perform the interaction.

We expect several concrete implementations of the Node to be wrtten such as a RMI node, a JINI node ...

Since:
ProActive 0.9
Version:
1.1, 2002/08/28
Author:
ProActive Team

Method Summary
 java.lang.Object[] getActiveObjects()
          Returns all activeObjects deployed on this Node
 java.lang.Object[] getActiveObjects(java.lang.String className)
          Returns all activeObjects with the given name deployed on this Node or null if such objects do not exist
 NodeInformation getNodeInformation()
          Returns the node information as one object.
 int getNumberOfActiveObjects()
           
 ProActiveRuntime getProActiveRuntime()
          Returns a reference to the ProActiveRuntime where the node has been created
 java.lang.String getVnName()
          Returns the name of the VirtualNode this Node belongs to
 void killAllActiveObjects()
          Terminate body of all node's active objects.
 void setVnName(java.lang.String virtualNodeName)
          Sets the name of the VirtualNode this Node belongs to
 

Method Detail

getNodeInformation

public NodeInformation getNodeInformation()
Returns the node information as one object. This method allows to retrieve all node information in one call to optimize performance.

Returns:
the node information as one object

getProActiveRuntime

public ProActiveRuntime getProActiveRuntime()
Returns a reference to the ProActiveRuntime where the node has been created

Returns:
ProActiveRuntime. The reference to the ProActiveRuntime where the node has been created

getActiveObjects

public java.lang.Object[] getActiveObjects()
                                    throws NodeException,
                                           ActiveObjectCreationException
Returns all activeObjects deployed on this Node

Returns:
Object[] contains all activeObjects deployed on this Node
Throws:
NodeException
ActiveObjectCreationException

getActiveObjects

public java.lang.Object[] getActiveObjects(java.lang.String className)
                                    throws NodeException,
                                           ActiveObjectCreationException
Returns all activeObjects with the given name deployed on this Node or null if such objects do not exist

Parameters:
className - the class of the Active Objects
Returns:
Object[].The set of activeObjects deployed on this node of the given class
Throws:
NodeException
ActiveObjectCreationException

getNumberOfActiveObjects

public int getNumberOfActiveObjects()
                             throws NodeException
Returns:
The number of active objects deployed in this Node.
Throws:
NodeException - Cannot get Active Objects registered on this node.

getVnName

public java.lang.String getVnName()
Returns the name of the VirtualNode this Node belongs to

Returns:
the name of the VirtualNode this Node belongs to

setVnName

public void setVnName(java.lang.String virtualNodeName)
Sets the name of the VirtualNode this Node belongs to

Parameters:
virtualNodeName -

killAllActiveObjects

public void killAllActiveObjects()
                          throws NodeException,
                                 java.io.IOException
Terminate body of all node's active objects.

Throws:
NodeException
java.io.IOException


Copyright ? April 2005 INRIA All Rights Reserved.