NodeSource (scheduling 14.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.resourcemanager.nodesource.NodeSource

All Implemented Interfaces:

org.objectweb.proactive.Active, org.objectweb.proactive.InitActive, org.objectweb.proactive.RunActive
```
public class NodeSource
extends Object
implements org.objectweb.proactive.InitActive, org.objectweb.proactive.RunActive
```
Abstract class designed to manage a NodeSource. A NodeSource active object is designed to manage acquisition, monitoring and removing of a set of Node objects in the Resource Manager. Each node source consists of two entities InfrastructureManager and NodeSourcePolicy.
Each particular InfrastructureManager defines a specific infrastructure and ways to manipulate nodes.
The node source policy NodeSourcePolicy defines a strategy of nodes acquisition. It can be static acquiring nodes once and forever or dynamic where nodes acquisition takes into account different external factors such as time, scheduling state, etc.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_LOCAL_NODES_NODE_SOURCE_RECOVERABLE` Default recovery mode for NS with local nodes started with the RM by default
`static boolean`	`DEFAULT_RECOVERABLE`
`static int`	`EXTERNAL_POOL`
`static int`	`INTERNAL_POOL`
`static int`	`NUMBER_OF_THREAD_POOLS`
`static int`	`PINGER_POOL`

Constructor Summary

Constructors
Constructor and Description
`NodeSource()` Creates a new instance of NodeSource.
`NodeSource(String registrationURL, String name, InfrastructureManager im, NodeSourcePolicy policy, RMCore rmcore, RMMonitoringImpl monitor, NodeSourceDescriptor nodeSourceDescriptor)` Creates a new instance of NodeSource.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acquireAllNodes()` Requests all nodes to be acquired from the infrastructure.
`void`	`acquireAllNodes(Map<String,?> nodeConfiguration)`
`void`	`acquireNode()` Requests one node to be acquired from the underlying infrastructure.
`org.objectweb.proactive.core.util.wrapper.BooleanWrapper`	`acquireNode(String nodeUrl, Client provider)` Acquires the existing node with specific url.
`void`	`acquireNodes(int n, long timeout, Map<String,?> nodeConfiguration)`
`void`	`acquireNodes(int n, Map<String,?> nodeConfiguration)`
`org.objectweb.proactive.core.util.wrapper.BooleanWrapper`	`activate()` Activates a node source policy.
`RMNodeSourceEvent`	`createNodeSourceEvent()`
`void`	`detectedPingedDownNode(String nodeName, String nodeUrl)` Marks node as down.
`void`	`executeInParallel(Runnable task)` Executed command in parallel using thread pool.
`void`	`finishNodeSourceShutdown(Client initiator)` Terminates a node source active object when the policy is shutdown.
`LinkedHashMap<String,String>`	`getAdditionalInformation()`
`Client`	`getAdministrator()` The provider of the node source is the resource manager client initiated the node source creation.
`Permission`	`getAdminPermission()` Returns the permission which administrator must have.
`LinkedList<org.objectweb.proactive.core.node.Node>`	`getAliveNodes()` Retrieves a list of alive nodes
`LinkedList<RMDeployingNode>`	`getDeployingAndLostNodes()` Retrieves the list of deploying nodes handled by the infrastructure manager
`String`	`getDescription()` Creates a node source string representation
`NodeSourceDescriptor`	`getDescriptor()` Get the information that describe the node source and that are needed to instantiate it
`LinkedList<org.objectweb.proactive.core.node.Node>`	`getDownNodes()` Retrieves a list of down nodes
`String`	`getName()` Gets name of the node source
`RMDeployingNode`	`getNodeInDeployingOrLostNodes(String nodeUrl)` Returns the deploying node identified by the specified `nodeUrl`.
`int`	`getNodesCount()` Gets the nodes size excluding down nodes.
`AccessType`	`getNodeUserAccessType()`
`org.objectweb.proactive.core.util.wrapper.IntWrapper`	`getPingFrequency()` Gets the ping frequency.
`NodeSourcePolicy`	`getPolicy()`
`Permission`	`getProviderPermission()` Returns the permission required to add/remove nodes to/from the node source.
`String`	`getRegistrationURL()` Returns the registration url the node spawn by this nodesource must use.
`RMCore`	`getRMCore()` Gets resource manager core.
`NodeSourceStatus`	`getStatus()`
`NodeSource`	`getStub()` Returns the the node source stub
`void`	`initActivity(org.objectweb.proactive.Body body)` Initialization of node source.
`static void`	`initThreadPools()`
`RMNode`	`internalAddNodeAfterRecovery(org.objectweb.proactive.core.node.Node node, RMNodeData rmNodeData)` Recover the internal data structure of the node source so that recovered nodes and RMnodes are linked again to the node source.
`void`	`internalEmitDeployingNodeEvent(RMNodeEvent event)` To emit a deploying node event
`org.objectweb.proactive.core.node.Node`	`lookupNode(String nodeUrl, long timeout)` Lookups a node with specified timeout.
`boolean`	`nodesRecoverable()`
`void`	`pingNode(org.objectweb.proactive.core.node.Node node)` Pings the node with specified url.
`void`	`putAndPersistAdditionalInformation(String key, String value)`
`void`	`reconfigure(Object[] updatedInfrastructureParams, Object[] updatedPolicyParams)`
`boolean`	`removeDeployingNode(String pnUrl)` Removes the deploying node from the nodesource's infrastructure manager.
`org.objectweb.proactive.core.util.wrapper.BooleanWrapper`	`removeNode(String nodeUrl, Client initiator)` Removes the node from the node source.
`void`	`runActivity(org.objectweb.proactive.Body body)`
`void`	`setActivePolicy(NodeSourcePolicy policy)`
`boolean`	`setDeploying(RMDeployingNode deployingNode)`
`void`	`setInfrastructureManager(InfrastructureManager infrastructureManager)`
`boolean`	`setNodeAvailable(RMNode node)`
`void`	`setPingFrequency(int frequency)` Sets the ping frequency (in ms)
`void`	`setStatus(NodeSourceStatus status)`
`org.objectweb.proactive.core.util.wrapper.BooleanWrapper`	`shutdown(Client initiator)` Shutdowns the node source and releases all its nodes.
`protected void`	`shutdownNodeSourceServices(Client initiator)` Initiates node source services shutdown, such as pinger, policy, thread pool.
`static void`	`shutdownThreadPools()`
`RMDeployingNode`	`update(RMDeployingNode rmNode)`
`NodeSourceDescriptor`	`updateDynamicParameters(List<Serializable> infrastructureParamsWithDynamicUpdated, List<Serializable> policyParamsWithDynamicUpdated)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LOCAL_NODES_NODE_SOURCE_RECOVERABLE
```
public static final boolean DEFAULT_LOCAL_NODES_NODE_SOURCE_RECOVERABLE
```
    Default recovery mode for NS with local nodes started with the RM by default
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RECOVERABLE
```
public static final boolean DEFAULT_RECOVERABLE
```
    See Also:
    
    Constant Field Values
  - INTERNAL_POOL
```
public static final int INTERNAL_POOL
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_POOL
```
public static final int EXTERNAL_POOL
```
    See Also:
    
    Constant Field Values
  - PINGER_POOL
```
public static final int PINGER_POOL
```
    See Also:
    
    Constant Field Values
  - NUMBER_OF_THREAD_POOLS
```
public static final int NUMBER_OF_THREAD_POOLS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NodeSource
```
public NodeSource()
```
    Creates a new instance of NodeSource. This constructor is used by Proactive as one of requirements for active objects.
  - NodeSource
```
public NodeSource(String registrationURL,
                  String name,
                  InfrastructureManager im,
                  NodeSourcePolicy policy,
                  RMCore rmcore,
                  RMMonitoringImpl monitor,
                  NodeSourceDescriptor nodeSourceDescriptor)
```
    Creates a new instance of NodeSource.
    
    Parameters:
    
    name - node source name
    
    registrationURL - the url used by the spawn nodes to register
    
    im - underlying infrastructure manager
    
    policy - nodes acquisition policy
    
    rmcore - resource manager core
- Method Detail
  - getNodeUserAccessType
```
public AccessType getNodeUserAccessType()
```
  - initThreadPools
```
public static void initThreadPools()
```
  - shutdownThreadPools
```
public static void shutdownThreadPools()
```
  - initActivity
```
public void initActivity(org.objectweb.proactive.Body body)
```
    Initialization of node source. Creates and activates a pinger to monitor nodes.
    
    Specified by:
    
    initActivity in interface org.objectweb.proactive.InitActive
    
    Parameters:
    
    body - active object body
  - runActivity
```
public void runActivity(org.objectweb.proactive.Body body)
```
    Specified by:
    
    runActivity in interface org.objectweb.proactive.RunActive
  - internalAddNodeAfterRecovery
```
public RMNode internalAddNodeAfterRecovery(org.objectweb.proactive.core.node.Node node,
                                           RMNodeData rmNodeData)
```
    Recover the internal data structure of the node source so that recovered nodes and RMnodes are linked again to the node source.
    
    Returns:
    
    the RMNode that could be recovered.
  - acquireNode
```
public org.objectweb.proactive.core.util.wrapper.BooleanWrapper acquireNode(String nodeUrl,
                                                                            Client provider)
```
    Acquires the existing node with specific url. The node have to be up and running.
    
    Parameters:
    
    nodeUrl - the url of the node
    
    provider -
  - setNodeAvailable
```
public boolean setNodeAvailable(RMNode node)
```
  - update
```
public RMDeployingNode update(RMDeployingNode rmNode)
```
  - setDeploying
```
public boolean setDeploying(RMDeployingNode deployingNode)
```
  - setInfrastructureManager
```
public void setInfrastructureManager(InfrastructureManager infrastructureManager)
```
  - getPolicy
```
public NodeSourcePolicy getPolicy()
```
  - setActivePolicy
```
public void setActivePolicy(NodeSourcePolicy policy)
```
  - getStatus
```
public NodeSourceStatus getStatus()
```
  - setStatus
```
public void setStatus(NodeSourceStatus status)
```
  - getAdditionalInformation
```
public LinkedHashMap<String,String> getAdditionalInformation()
```
  - putAndPersistAdditionalInformation
```
public void putAndPersistAdditionalInformation(String key,
                                               String value)
```
  - updateDynamicParameters
```
public NodeSourceDescriptor updateDynamicParameters(List<Serializable> infrastructureParamsWithDynamicUpdated,
                                                    List<Serializable> policyParamsWithDynamicUpdated)
```
  - reconfigure
```
public void reconfigure(Object[] updatedInfrastructureParams,
                        Object[] updatedPolicyParams)
                 throws Exception
```
    Throws:
    
    Exception
  - lookupNode
```
public org.objectweb.proactive.core.node.Node lookupNode(String nodeUrl,
                                                         long timeout)
                                                  throws Exception
```
    Lookups a node with specified timeout.
    
    Parameters:
    
    nodeUrl - a url of the node
    
    timeout - to wait in ms
    
    Returns:
    
    node if it was successfully obtained, null otherwise
    
    Throws:
    
    Exception - if node was not looked up
  - acquireNode
```
public void acquireNode()
```
    Requests one node to be acquired from the underlying infrastructure.
  - acquireNodes
```
public void acquireNodes(int n,
                         long timeout,
                         Map<String,?> nodeConfiguration)
```
  - acquireNodes
```
public void acquireNodes(int n,
                         Map<String,?> nodeConfiguration)
```
  - acquireAllNodes
```
public void acquireAllNodes()
```
    Requests all nodes to be acquired from the infrastructure.
  - acquireAllNodes
```
public void acquireAllNodes(Map<String,?> nodeConfiguration)
```
  - removeNode
```
public org.objectweb.proactive.core.util.wrapper.BooleanWrapper removeNode(String nodeUrl,
                                                                           Client initiator)
```
    Removes the node from the node source.
    
    Parameters:
    
    nodeUrl - the url of the node to be released
  - shutdown
```
public org.objectweb.proactive.core.util.wrapper.BooleanWrapper shutdown(Client initiator)
```
    Shutdowns the node source and releases all its nodes.
  - internalEmitDeployingNodeEvent
```
public void internalEmitDeployingNodeEvent(RMNodeEvent event)
```
    To emit a deploying node event
    
    Parameters:
    
    event - the deploying node event to emit
  - removeDeployingNode
```
public boolean removeDeployingNode(String pnUrl)
```
    Removes the deploying node from the nodesource's infrastructure manager.
    
    Parameters:
    
    pnUrl - the deploying url
    
    Returns:
    
    true in case of succes, false otherwise
  - getPingFrequency
```
public org.objectweb.proactive.core.util.wrapper.IntWrapper getPingFrequency()
```
    Gets the ping frequency.
    
    Returns:
    
    ping frequency
  - setPingFrequency
```
public void setPingFrequency(int frequency)
```
    Sets the ping frequency (in ms)
    
    Parameters:
    
    frequency - new value of monitoring period
  - getDescription
```
public String getDescription()
```
    Creates a node source string representation
    
    Returns:
    
    string representation of the node source
  - getName
```
public String getName()
```
    Gets name of the node source
    
    Returns:
    
    name of the node source
  - getDescriptor
```
public NodeSourceDescriptor getDescriptor()
```
    Get the information that describe the node source and that are needed to instantiate it
    
    Returns:
    
    the node source descriptor
  - nodesRecoverable
```
public boolean nodesRecoverable()
```
    Returns:
    
    whether nodes recovery is activated for this node source
  - activate
```
public org.objectweb.proactive.core.util.wrapper.BooleanWrapper activate()
```
    Activates a node source policy.
  - shutdownNodeSourceServices
```
protected void shutdownNodeSourceServices(Client initiator)
```
    Initiates node source services shutdown, such as pinger, policy, thread pool.
  - finishNodeSourceShutdown
```
public void finishNodeSourceShutdown(Client initiator)
```
    Terminates a node source active object when the policy is shutdown.
  - getAliveNodes
```
public LinkedList<org.objectweb.proactive.core.node.Node> getAliveNodes()
```
    Retrieves a list of alive nodes
    
    Returns:
    
    a list of alive nodes
  - getDownNodes
```
public LinkedList<org.objectweb.proactive.core.node.Node> getDownNodes()
```
    Retrieves a list of down nodes
    
    Returns:
    
    a list of down nodes
  - getDeployingAndLostNodes
```
public LinkedList<RMDeployingNode> getDeployingAndLostNodes()
```
    Retrieves the list of deploying nodes handled by the infrastructure manager
    
    Returns:
    
    the list of deploying nodes handled by the infrastructure manager
  - getNodeInDeployingOrLostNodes
```
public RMDeployingNode getNodeInDeployingOrLostNodes(String nodeUrl)
```
    Returns the deploying node identified by the specified nodeUrl.
    
    Parameters:
    
    nodeUrl - the URL of the deploying node to lookup.
    
    Returns:
    
    the deploying node found, or null. Since a node source is an Active Object, the caller will receive a deep copy of the original object.
  - getNodesCount
```
public int getNodesCount()
```
    Gets the nodes size excluding down nodes.
    
    Returns:
    
    the node size
  - detectedPingedDownNode
```
public void detectedPingedDownNode(String nodeName,
                                   String nodeUrl)
```
    Marks node as down. Remove it from node source node set. It remains in rmcore nodes list until user decides to remove them or node source is shutdown.
    
    See Also:
    
    detectedPingedDownNode(String, String)
  - getRMCore
```
public RMCore getRMCore()
```
    Gets resource manager core. Used by policies.
    
    Returns:
    
    RMCore instance.
  - executeInParallel
```
public void executeInParallel(Runnable task)
```
    Executed command in parallel using thread pool.
    
    Parameters:
    
    task - to execute
  - pingNode
```
public void pingNode(org.objectweb.proactive.core.node.Node node)
```
    Pings the node with specified url. If the node is dead sends the request to the node source.
  - getAdministrator
```
public Client getAdministrator()
```
    The provider of the node source is the resource manager client initiated the node source creation.
    
    Returns:
    
    the node source provider
  - getStub
```
public NodeSource getStub()
```
    Returns the the node source stub
  - getAdminPermission
```
public Permission getAdminPermission()
```
    Returns the permission which administrator must have. Administrator of the node source can remove it, add nodes to this node source and remove any node.
  - getProviderPermission
```
public Permission getProviderPermission()
```
    Returns the permission required to add/remove nodes to/from the node source. Provider can remove only its one nodes.
  - getRegistrationURL
```
public String getRegistrationURL()
```
    Returns the registration url the node spawn by this nodesource must use.
    
    Returns:
    
    the registration url the node spawn by this nodesource must use.
  - createNodeSourceEvent
```
public RMNodeSourceEvent createNodeSourceEvent()
```

Class NodeSource

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOCAL_NODES_NODE_SOURCE_RECOVERABLE

DEFAULT_RECOVERABLE

INTERNAL_POOL

EXTERNAL_POOL

PINGER_POOL

NUMBER_OF_THREAD_POOLS

Constructor Detail

NodeSource

NodeSource

Method Detail

getNodeUserAccessType

initThreadPools

shutdownThreadPools

initActivity

runActivity

internalAddNodeAfterRecovery

acquireNode

setNodeAvailable

update

setDeploying

setInfrastructureManager

getPolicy

setActivePolicy

getStatus

setStatus

getAdditionalInformation

putAndPersistAdditionalInformation

updateDynamicParameters

reconfigure

lookupNode

acquireNode

acquireNodes

acquireNodes

acquireAllNodes

acquireAllNodes

removeNode

shutdown

internalEmitDeployingNodeEvent

removeDeployingNode

getPingFrequency

setPingFrequency

getDescription

getName

getDescriptor

nodesRecoverable

activate

shutdownNodeSourceServices

finishNodeSourceShutdown

getAliveNodes

getDownNodes

getDeployingAndLostNodes

getNodeInDeployingOrLostNodes

getNodesCount

detectedPingedDownNode

getRMCore

executeInParallel

pingNode

getAdministrator

getStub

getAdminPermission

getProviderPermission

getRegistrationURL

createNodeSourceEvent