RMNode (scheduling 13.1.0-SNAPSHOT API)

All Superinterfaces:

Comparable<RMNode>

All Known Implementing Classes:

AbstractRMNode, RMDeployingNode, RMNodeImpl
```
public interface RMNode
extends Comparable<RMNode>
```
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

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addToken(String token)`
`void`	`clean()` Cleaning method : remove all active objects on this node.
`RMNodeEvent`	`createNodeEvent()`
`RMNodeEvent`	`createNodeEvent(RMEventType eventType, NodeState previousNodeState, String initiator)`
`<T> ScriptResult<T>`	`executeScript(Script<T> script, Map<String,Serializable> bindings)` Execute a `Script` on this `RMNode`
`RMNodeEvent`	`getAddEvent()` Returns the id of the add event `RMNodeEvent`.
`Permission`	`getAdminPermission()` Gets the permission which defines who can remove this node.
`String`	`getDescriptorVMName()` This method call nodeInformation.getDescriptorVMName();
`String`	`getHostName()` This method call nodeInformation.getHostName();
`String`	`getJMXUrl(JMXTransportProtocol protocol)` Gets the JMX url of the node.
`String[]`	`getJmxUrls()` Gets the JMX urls of the node.
`RMNodeEvent`	`getLastEvent()` Returns the id of the last event `RMNodeEvent`.
`Client`	`getLockedBy()` Returns the client who has locked the node.
`long`	`getLockTime()` Returns the timestamp at which the node has been locked.
`org.objectweb.proactive.core.node.Node`	`getNode()` Gives the node object related.
`String`	`getNodeInfo()`
`String`	`getNodeName()` Returns the name of the node.
`NodeSource`	`getNodeSource()` Returns the Stub of the `NodeSource` that handles the node.
`String`	`getNodeSourceName()` Returns the NodeSource name of the node.
`Set<String>`	`getNodeTags()`
`List<String>`	`getNodeTokens()`
`String`	`getNodeURL()` Returns the unique ID of the node.
`Client`	`getOwner()` Gets the owner of the node (who currently running computations on it)
`Client`	`getProvider()` Gets the provider of the node (who created and deployed it)
`HashMap<SelectionScript,Integer>`	`getScriptStatus()` Deprecated. it currently returns empty result always. Selection script results are now handled by the `ProbablisticSelectionManager`
`NodeState`	`getState()` Returns the node state
`long`	`getStateChangeTime()` Returns the time of the last node state change.
`Map<String,String>`	`getUsageInfo()`
`Permission`	`getUserPermission()` Gets the permission which defines who can user this node.
`String`	`getVNodeName()`
`boolean`	`isBusy()`
`boolean`	`isConfiguring()`
`boolean`	`isDeploying()` Returns a boolean that says if the node is deploying or not.
`boolean`	`isDown()`
`boolean`	`isFree()`
`boolean`	`isLocked()` Returns a boolean saying whether the node is locked or not.
`boolean`	`isProtectedByToken()`
`boolean`	`isToRemove()`
`void`	`lock(Client client)` Set the node locked.
`long`	`millisSinceStateChanged()`
`void`	`removeToken(String token)`
`void`	`setAddEvent(RMNodeEvent addEvent)`
`void`	`setBusy(Client owner)` change the node's status to busy.
`void`	`setBusy(Client owner, Map<String,String> usageInfo)`
`void`	`setConfiguring(Client owner)` change the node's status to configuring
`void`	`setDown()` change the node's status to down.
`void`	`setFree()` change the node's status to free
`void`	`setJMXUrl(JMXTransportProtocol protocol, String address)` Sets the jmx url of the node.
`void`	`setLastEvent(RMNodeEvent lastEvent)`
`void`	`setNodeSource(NodeSource nodeSource)` Sets the Stub of the NodeSource to the specified value.
`void`	`setNodeTags(Set<String> tags)`
`void`	`setNodeTokens(String nodeUrl, List<String> tokens)`
`void`	`setProtectedByToken(boolean protectedByToken)`
`void`	`setStateChangeTime(long time)`
`void`	`setToRemove()` * change the node's status to 'to release'.
`void`	`setUsageInfo(Map<String,String> usageInfo)`
`void`	`unlock(Client client)` Unlock the node.

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - executeScript
```
<T> ScriptResult<T> executeScript(Script<T> script,
                                  Map<String,Serializable> bindings)
```
    Execute a Script on this RMNode
    
    Type Parameters:
    
    T - The parameterized result type of the script
    
    Parameters:
    
    script - a selection script to execute.
    
    bindings - bindings used to execute the selection scripts
    
    Returns:
    
    the ScriptResult corresponding to the script execution.
  - getScriptStatus
```
@Deprecated
HashMap<SelectionScript,Integer> getScriptStatus()
```
    Deprecated. it currently returns empty result always. Selection script results are now handled by the ProbablisticSelectionManager
    
    Get a map of all selection scripts already tested on this node, and the responses given.
    
    Returns:
    
    the map of Script and status
  - clean
```
void clean()
    throws org.objectweb.proactive.core.node.NodeException
```
    Cleaning method : remove all active objects on this node.
    
    Throws:
    
    org.objectweb.proactive.core.node.NodeException
  - getNodeInfo
```
String getNodeInfo()
```
    Returns:
    
    a string describing the RMNode (status, vnode, host, pad, ...)
  - getNodeName
```
String getNodeName()
```
    Returns the name of the node.
    
    Returns:
    
    the name of the node.
  - getNode
```
org.objectweb.proactive.core.node.Node getNode()
```
    Gives the node object related.
    
    Returns:
    
    a node Object.
  - getVNodeName
```
String getVNodeName()
```
    Returns:
    
    the name of the virtual node
  - getHostName
```
String getHostName()
```
    This method call nodeInformation.getHostName();
    
    Returns:
    
    the name of the host machine
  - getDescriptorVMName
```
String getDescriptorVMName()
```
    This method call nodeInformation.getDescriptorVMName();
    
    Returns:
    
    the name of the virtual machine
  - getNodeSourceName
```
String getNodeSourceName()
```
    Returns the NodeSource name of the node.
    
    Returns:
    
    the NodeSource name of the node.
  - getNodeURL
```
String getNodeURL()
```
    Returns the unique ID of the node.
    
    Returns:
    
    the unique ID of the node represented by its URL.
  - getNodeSource
```
NodeSource getNodeSource()
```
    Returns the Stub of the NodeSource that handles the node.
    
    Returns:
    
    the stub of the NodeSource that handles the node.
  - getState
```
NodeState getState()
```
    Returns the node state
    
    Returns:
    
    the node state
  - getStateChangeTime
```
long getStateChangeTime()
```
    Returns the time of the last node state change.
    
    Returns:
    
    the time of the last node state change
  - getProvider
```
Client getProvider()
```
    Gets the provider of the node (who created and deployed it)
    
    Returns:
    
    the node provider
  - getOwner
```
Client getOwner()
```
    Gets the owner of the node (who currently running computations on it)
    
    Returns:
    
    the node owner
  - getUserPermission
```
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
```
Permission getAdminPermission()
```
    Gets the permission which defines who can remove this node.
  - getAddEvent
```
RMNodeEvent getAddEvent()
```
    Returns the id of the add event RMNodeEvent.
    
    Returns:
    
    the id of the add event
  - getLastEvent
```
RMNodeEvent getLastEvent()
```
    Returns the id of the last event RMNodeEvent.
    
    Returns:
    
    the id of the last event
  - isDeploying
```
boolean isDeploying()
```
    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.
  - isFree
```
boolean isFree()
```
    Returns:
    
    true if the node is free, false otherwise.
  - isDown
```
boolean isDown()
```
    Returns:
    
    true if the node is down, false otherwise.
  - isToRemove
```
boolean isToRemove()
```
    Returns:
    
    true if the node has to be released, false otherwise.
  - isBusy
```
boolean isBusy()
```
    Returns:
    
    true if the node is busy, false otherwise.
  - isConfiguring
```
boolean isConfiguring()
```
    Returns:
    
    true if the node is configuring, false otherwise.
  - isLocked
```
boolean isLocked()
```
    Returns a boolean saying whether the node is locked or not.
    
    Returns:
    
    true if the node is locked, false otherwise.
  - getLockTime
```
long getLockTime()
```
    Returns the timestamp at which the node has been locked.
    The value returned by this method is meaningful when the node is locked only.
    
    Returns:
    
    the timestamp at which the node has been locked or -1 if the node is not locked.
    
    See Also:
    
    isLocked()
  - getLockedBy
```
Client getLockedBy()
```
    Returns the client who has locked the node.
    
    Returns:
    
    the client who has locked the node, or null if the node is not locked.
  - setFree
```
void setFree()
```
    change the node's status to free
  - setBusy
```
void setBusy(Client owner)
```
    change the node's status to busy.
    
    Parameters:
    
    owner -
  - setBusy
```
void setBusy(Client owner,
             Map<String,String> usageInfo)
```
  - setToRemove
```
void setToRemove()
```
    * change the node's status to 'to release'.
  - setDown
```
void setDown()
```
    change the node's status to down.
  - setConfiguring
```
void setConfiguring(Client owner)
```
    change the node's status to configuring
  - lock
```
void lock(Client client)
```
    Set the node locked.
    
    Parameters:
    
    client - the client that locks the node.
  - unlock
```
void unlock(Client client)
```
    Unlock the node.
    
    Parameters:
    
    client - the client that unlocks the node.
  - setNodeSource
```
void setNodeSource(NodeSource nodeSource)
```
    Sets the Stub of the NodeSource to the specified value.
    
    Parameters:
    
    nodeSource - the new NodeSource Stub to use.
  - setAddEvent
```
void setAddEvent(RMNodeEvent addEvent)
```
  - setLastEvent
```
void setLastEvent(RMNodeEvent lastEvent)
```
  - setJMXUrl
```
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
```
String getJMXUrl(JMXTransportProtocol protocol)
```
    Gets the JMX url of the node.
    
    Parameters:
    
    protocol - protocol to be used for accessing the node
    
    Returns:
    
    a jmx url
  - getJmxUrls
```
String[] getJmxUrls()
```
    Gets the JMX urls of the node.
    
    Returns:
    
    an array of jmx urls
  - isProtectedByToken
```
boolean isProtectedByToken()
```
    Returns:
    
    true if node is protected with token
  - setProtectedByToken
```
void setProtectedByToken(boolean protectedByToken)
```
  - addToken
```
void addToken(String token)
```
  - removeToken
```
void removeToken(String token)
```
  - createNodeEvent
```
RMNodeEvent createNodeEvent(RMEventType eventType,
                            NodeState previousNodeState,
                            String initiator)
```
  - createNodeEvent
```
RMNodeEvent createNodeEvent()
```
  - millisSinceStateChanged
```
long millisSinceStateChanged()
```
  - setUsageInfo
```
void setUsageInfo(Map<String,String> usageInfo)
```
  - getUsageInfo
```
Map<String,String> getUsageInfo()
```
  - getNodeTokens
```
List<String> getNodeTokens()
```
  - setNodeTokens
```
void setNodeTokens(String nodeUrl,
                   List<String> tokens)
```
  - getNodeTags
```
Set<String> getNodeTags()
```
  - setNodeTags
```
void setNodeTags(Set<String> tags)
```
  - setStateChangeTime
```
void setStateChangeTime(long time)
```

Interface RMNode

Method Summary

Methods inherited from interface java.lang.Comparable

Method Detail

executeScript

getScriptStatus

clean

getNodeInfo

getNodeName

getNode

getVNodeName

getHostName

getDescriptorVMName

getNodeSourceName

getNodeURL

getNodeSource

getState

getStateChangeTime

getProvider

getOwner

getUserPermission

getAdminPermission

getAddEvent

getLastEvent

isDeploying

isFree

isDown

isToRemove

isBusy

isConfiguring

isLocked

getLockTime

getLockedBy

setFree

setBusy

setBusy

setToRemove

setDown

setConfiguring

lock

unlock

setNodeSource

setAddEvent

setLastEvent

setJMXUrl

getJMXUrl

getJmxUrls

isProtectedByToken

setProtectedByToken

addToken

removeToken

createNodeEvent

createNodeEvent

millisSinceStateChanged

setUsageInfo

getUsageInfo

getNodeTokens

setNodeTokens

getNodeTags

setNodeTags

setStateChangeTime