org.ow2.proactive.resourcemanager.rmnode

Class RMNodeImpl

java.lang.Object

org.ow2.proactive.resourcemanager.rmnode.AbstractRMNode

org.ow2.proactive.resourcemanager.rmnode.RMNodeImpl

All Implemented Interfaces:

Serializable, Comparable<RMNode>, RMNode

public class RMNodeImpl
extends AbstractRMNode

Implementation of the RMNode Interface. An RMNode is a ProActive node able to execute schedulers tasks. So an RMNode is a representation of a ProActive node object with its associated NodeSource, and its state in the Resource Manager :
-free : node is ready to perform a task.
-busy : node is executing a task.
-to be released : node is busy and have to be removed at the end of the its current task.
-down : node is broken, and not anymore able to perform tasks.

Resource Manager can select nodes that verify criteria. this selection is implemented with SelectionScript objects. Each node memorize results of executed scripts, in order to answer faster to a selection already asked.

Since:

ProActive Scheduling 0.9

See Also:

NodeSource, SelectionScript, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODE_HOST_BINDING
static String	NODE_NAME_BINDING
static String	NODE_TOKENS_BINDING
static String	NODE_URL_BINDING

Fields inherited from class org.ow2.proactive.resourcemanager.rmnode.AbstractRMNode

addEvent, isLocked, lastEvent, lockedBy, lockTime, nodeName, nodeSource, nodeSourceName, provider, state, stateChangeTime, usageInfo

Constructor Summary

Constructors

Constructor and Description
RMNodeImpl(org.objectweb.proactive.core.node.Node node, NodeSource nodeSource, Client provider, Permission nodeAccessPermission) Constructs a new instance.
RMNodeImpl(org.objectweb.proactive.core.node.Node node, NodeSource nodeSource, Client provider, Permission nodeAccessPermission, NodeState state)
RMNodeImpl(org.objectweb.proactive.core.node.Node node, NodeSource nodeSource, String nodeName, String nodeUrl, Client provider, String hostName, String[] jmxUrls, String jvmName, Permission nodeAccessPermission, NodeState state, Set<String> tags) A constructor of RMNodeImpl that already has all the configuration information.

Method Summary

Modifier and Type	Method and Description
void	addToken(String token)
void	clean() Clean the node.
int	compareTo(RMNode rmnode)
<T> ScriptResult<T>	executeScript(Script<T> script, Map<String,Serializable> bindings) Execute a selection Script in order to test the Node.
Permission	getAdminPermission() Gets the permission which defines who can remove this node.
String	getDescriptorVMName() Returns the java virtual machine name of the RMNode.
ScriptHandler	getHandler() Returns the ProActive stub on the remote script handler.
String	getHostName() Returns the host name of the RMNode.
String	getJMXUrl(JMXTransportProtocol protocol) Gets the JMX url of the node.
String[]	getJmxUrls() Gets the JMX urls of the node.
org.objectweb.proactive.core.node.Node	getNode() Gives the node object related.
String	getNodeInfo()
Set<String>	getNodeTags()
List<String>	getNodeTokens()
Client	getOwner() Gets the owner of the node (who currently running computations on it)
HashMap<SelectionScript,Integer>	getScriptStatus() Gives the HashMap of all scripts tested with corresponding results.
Permission	getUserPermission() Gets the permission which defines who can user this node.
String	getVNodeName() Returns the Virtual node name of the RMNode.
boolean	isBusy()
boolean	isConfiguring()
boolean	isDeploying() Returns a boolean that says if the node is deploying or not.
boolean	isDown()
boolean	isFree()
boolean	isProtectedByToken()
boolean	isToRemove()
void	removeToken(String token)
void	setBusy(Client owner) Changes the state of this node to NodeState.BUSY.
void	setBusy(Client owner, Map<String,String> usageInfo)
void	setConfiguring(Client owner) Changes the state of this node to NodeState.CONFIGURING
void	setDown() Changes the state of this node to NodeState.DOWN.
void	setFree() Changes the state of this node to NodeState.FREE.
void	setJMXUrl(JMXTransportProtocol protocol, String address) Sets the jmx url of the node.
void	setNodeTags(Set<String> tags)
void	setNodeTokens(String nodeUrl, List<String> tokens)
void	setProtectedByToken(boolean protectedByToken)
void	setState(NodeState nodeState)
void	setToRemove() Changes the state of this node to NodeState.TO_BE_REMOVED.
protected void	updateProtectedByToken()

Methods inherited from class org.ow2.proactive.resourcemanager.rmnode.AbstractRMNode

changeState, copyLockStatusFrom, createNodeEvent, createNodeEvent, equals, getAddEvent, getLastEvent, getLockedBy, getLockStatus, getLockTime, getNodeName, getNodeSource, getNodeSourceName, getNodeURL, getProvider, getState, getStateChangeTime, getUsageInfo, hashCode, isLocked, lock, millisSinceStateChanged, setAddEvent, setLastEvent, setNodeSource, setStateChangeTime, setUsageInfo, toNodeDescriptor, toString, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NODE_URL_BINDING

public static final String NODE_URL_BINDING

See Also:

Constant Field Values

NODE_NAME_BINDING

public static final String NODE_NAME_BINDING

See Also:

Constant Field Values

NODE_HOST_BINDING

public static final String NODE_HOST_BINDING

See Also:

Constant Field Values

NODE_TOKENS_BINDING

public static final String NODE_TOKENS_BINDING

See Also:

Constant Field Values

Constructor Detail

RMNodeImpl

public RMNodeImpl(org.objectweb.proactive.core.node.Node node,
                  NodeSource nodeSource,
                  Client provider,
                  Permission nodeAccessPermission)

Constructs a new instance. Initial state is set to NodeState.FREE.

Parameters:

node - ProActive node deployed.

nodeSource - NodeSource Stub of NodeSource that handles the Node.

provider - the client who deployed the Node.

nodeAccessPermission - the permissions associated with the Node.

RMNodeImpl

public RMNodeImpl(org.objectweb.proactive.core.node.Node node,
                  NodeSource nodeSource,
                  Client provider,
                  Permission nodeAccessPermission,
                  NodeState state)

RMNodeImpl

public RMNodeImpl(org.objectweb.proactive.core.node.Node node,
                  NodeSource nodeSource,
                  String nodeName,
                  String nodeUrl,
                  Client provider,
                  String hostName,
                  String[] jmxUrls,
                  String jvmName,
                  Permission nodeAccessPermission,
                  NodeState state,
                  Set<String> tags)

A constructor of RMNodeImpl that already has all the configuration information.

Method Detail

getNode

public org.objectweb.proactive.core.node.Node getNode()

Description copied from interface: RMNode

Gives the node object related.

Returns:

a node Object.

See Also:

RMNode.getNode()

getVNodeName

public String getVNodeName()

Returns the Virtual node name of the RMNode.

Returns:

the Virtual node name of the RMNode.

getHostName

public String getHostName()

Returns the host name of the RMNode.

Returns:

the host name of the RMNode.

getDescriptorVMName

public String getDescriptorVMName()

Returns the java virtual machine name of the RMNode.

Returns:

the java virtual machine name of the RMNode.

setBusy

public void setBusy(Client owner)

Changes the state of this node to NodeState.BUSY.

setBusy

public void setBusy(Client owner,
                    Map<String,String> usageInfo)

setFree

public void setFree()

Changes the state of this node to NodeState.FREE.

setConfiguring

public void setConfiguring(Client owner)

Changes the state of this node to NodeState.CONFIGURING

setDown

public void setDown()

Changes the state of this node to NodeState.DOWN.

setToRemove

public void setToRemove()

Changes the state of this node to NodeState.TO_BE_REMOVED.

isFree

public boolean isFree()

Returns:

true if the node is free, false otherwise.

isBusy

public boolean isBusy()

Returns:

true if the node is busy, false otherwise.

isDown

public boolean isDown()

Returns:

true if the node is down, false otherwise.

isToRemove

public boolean isToRemove()

Returns:

true if the node is 'to be released', false otherwise.

isConfiguring

public boolean isConfiguring()

Returns:

true if the node is 'configuring', false otherwise.

getNodeInfo

public String getNodeInfo()

Returns:

a String showing information about the node.

getHandler

public ScriptHandler getHandler()
                         throws org.objectweb.proactive.core.node.NodeException

Returns the ProActive stub on the remote script handler.

Returns:

the ProActive stub on the script handler.

Throws:

org.objectweb.proactive.core.node.NodeException

executeScript

public <T> ScriptResult<T> executeScript(Script<T> script,
                                         Map<String,Serializable> bindings)

Execute a selection Script in order to test the Node. If no script handler is defined, create one, and execute the script.

Type Parameters:

T - The parameterized result type of the script

Parameters:

script - Selection script to execute

bindings - bindings to use to execute the selection scripts

Returns:

Result of the test.

clean

public void clean()
           throws org.objectweb.proactive.core.node.NodeException

Clean the node. kill all active objects on the node.

Throws:

org.objectweb.proactive.core.node.NodeException

getScriptStatus

public HashMap<SelectionScript,Integer> getScriptStatus()

Gives the HashMap of all scripts tested with corresponding results.

Returns:

the HashMap of all scripts tested with corresponding results.

compareTo

public int compareTo(RMNode rmnode)

Parameters:

rmnode - the RMNode object to compare

Returns:

an integer

See Also:

Comparable.compareTo(java.lang.Object)

setState

public void setState(NodeState nodeState)

getOwner

public Client getOwner()

Gets the owner of the node (who currently running computations on it)

Returns:

the node owner

getUserPermission

public Permission getUserPermission()

Gets the permission which defines who can user this node. For instance if at the moment of node source creation "node users" is set to "PROVIDER" it means that only node providers can use it for computations.

Returns:

node usage permission

getAdminPermission

public Permission getAdminPermission()

Gets the permission which defines who can remove this node.

setJMXUrl

public void setJMXUrl(JMXTransportProtocol protocol,
                      String address)

Sets the jmx url of the node.

Parameters:

protocol - protocol to be used for accessing the node

address - url of the jmx server

getJMXUrl

public String getJMXUrl(JMXTransportProtocol protocol)

Description copied from interface: RMNode

Gets the JMX url of the node.

Parameters:

protocol - protocol to be used for accessing the node

Returns:

a jmx url

getJmxUrls

public String[] getJmxUrls()

Description copied from interface: RMNode

Gets the JMX urls of the node.

Returns:

an array of jmx urls

isProtectedByToken

public boolean isProtectedByToken()

Returns:

true if node is protected with token

setProtectedByToken

public void setProtectedByToken(boolean protectedByToken)

isDeploying

public boolean isDeploying()

Description copied from interface: RMNode

Returns a boolean that says if the node is deploying or not.

Returns:

true if the node is an instance of RMDeployingNode, false if it is an instance of RMNodeImpl.

addToken

public void addToken(String token)

removeToken

public void removeToken(String token)

updateProtectedByToken

protected void updateProtectedByToken()

getNodeTokens

public List<String> getNodeTokens()

setNodeTokens

public void setNodeTokens(String nodeUrl,
                          List<String> tokens)

getNodeTags

public Set<String> getNodeTags()

setNodeTags

public void setNodeTags(Set<String> tags)