org.ow2.proactive.resourcemanager.frontend

Interface ResourceManager

All Superinterfaces:

ServiceUsingPermission

All Known Implementing Classes:

RMCore, RMProxyUserInterface

@PublicAPI
public interface ResourceManager
extends ServiceUsingPermission

This class represents the interface of the resource manager.

The resource manager is used to aggregate resources across the network which are represented by ProActive nodes. Its main features are

• deployment, acquisition and release of ProActive nodes to/from an underlying infrastructure
• providing nodes for computations, based on clients criteria (@see SelectionScript)
• maintaining and monitoring its list of resources and managing their states (free, busy, down...)

This interface provides means to create/remove node sources in the resource manager, add remove nodes to node sources, track the state of the resource manager and get nodes for computations.

All the methods of this interface are asynchronous.

Method Summary

Modifier and Type	Method and Description
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	acquireNodes(String sourceName, int numberNodes, long timeout, Map<String,?> nodeConfiguration) Acquires new nodes in the particular node source.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	addNode(String nodeUrl) Adds an existing node to the default node source of the resource manager.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	addNode(String nodeUrl, String sourceName) Adds an existing node to the particular node source.
void	addNodeToken(String nodeUrl, String token) Add a token to the given node
boolean	areNodesKnown(NodeSet nodes) Check whether the nodes in the given node set are known by the resource manager
Map<String,Boolean>	areNodesRecoverable(NodeSet nodes) Check whether the nodes in the given node set can be recovered in case of a crash
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	checkNodePermission(String nodeUrl, boolean provider) Check is the user has admin permission for the given node or it is a node source provider
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	checkNodeSourcePermission(String nodeSourceName, boolean provider) Check is the user has admin permission for the given node source or it is a node source provider
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	createNodeSource(String nodeSourceName, String infrastructureType, Object[] infrastructureParameters, String policyType, Object[] policyParameters, boolean nodesRecoverable) Deprecated. As of version 8.1, replaced by defineNodeSource(String, String, Object[], String, Object[], boolean) and deployNodeSource(String) The node source is the set of nodes acquired from specific infrastructure and characterized by particular acquisition policy. This method creates a new node source with specified name, infrastructure manager and acquisition policy. Parameters required to create infrastructure manager and policy can be obtained from corresponding PluginDescriptor.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	defineNodeSource(String nodeSourceName, String infrastructureType, Object[] infraParams, String policyType, Object[] policyParams, boolean nodesRecoverable) Defines a new node source in the resource manager.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	deployNodeSource(String nodeSourceName) Start acquiring the nodes of a node source that has been defined before.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	disconnect() Disconnects from resource manager and releases all the nodes taken by user for computations.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	editNodeSource(String nodeSourceName, String infrastructureType, Object[] infraParams, String policyType, Object[] policyParams, boolean nodesRecoverable) Edit an existing node source in the resource manager.
<T> List<ScriptResult<T>>	executeScript(Script<T> script, String targetType, Set<String> targets) Executes the script on the specified targets depending on the target type.
List<ScriptResult<Object>>	executeScript(String script, String scriptEngine, String targetType, Set<String> targets) Executes the script on the specified targets depending on the target type.
Map<String,List<String>>	getAllEligibleNodesTokens() Get the list of tokens associated with all resource manager eligible nodes
Map<String,List<String>>	getAllNodesTokens() Get the list of tokens associated with all resource manager nodes
NodeSet	getAtMostNodes(int number, List<SelectionScript> selectionScriptsList, NodeSet exclusion) Deprecated.
NodeSet	getAtMostNodes(int number, SelectionScript selectionScript) Deprecated.
NodeSet	getAtMostNodes(int number, SelectionScript selectionScript, NodeSet exclusion) Deprecated.
NodeSet	getAtMostNodes(int number, TopologyDescriptor descriptor, List<SelectionScript> selectionScriptsList, NodeSet exclusion) Deprecated.
org.objectweb.proactive.core.util.wrapper.StringWrapper	getCurrentUser() Returns the user currently connected
UserData	getCurrentUserData() Returns the groups associated with the current connected user.
List<RMNodeSourceEvent>	getExistingNodeSourcesList() Returns the list of existing node source infrastructures
Map<String,List<String>>	getInfrasToPoliciesMapping() Return the associations of infrastructures and policy For each infrastructure name, the list of policies which can be associated
RMMonitoring	getMonitoring() Returns the monitoring interface to manager listeners of the resource manager.
NodeSet	getNodes(Criteria criteria) Finds and books nodes for computations.
NodeSet	getNodes(int number, TopologyDescriptor descriptor, List<SelectionScript> selectionScriptsList, NodeSet exclusion, boolean bestEffort) Deprecated.
Set<String>	getNodesByTag(String tag) Returns a list of nodes Urls which contain the specified tag
Set<String>	getNodesByTags(Set<String> tags, boolean all) Returns a list of nodes Urls which contain all or any specified list of tags
List<RMNodeHistory>	getNodesHistory(long windowStart, long windowEnd) Return all node state events for the given period
NodeSourceConfiguration	getNodeSourceConfiguration(String nodeSourceName) Returns the current configuration of a node source.
org.objectweb.proactive.core.util.wrapper.IntWrapper	getNodeSourcePingFrequency(String sourceName) Returns the ping frequency of a node source.
Set<String>	getNodeTags(String nodeUrl) Return the set of tags associated with the given node
org.objectweb.proactive.core.util.wrapper.StringWrapper	getNodeThreadDump(String nodeUrl) Returns the string content of the thread dump asked to the Node identified by the given URL.
List<String>	getNodeTokens(String nodeUrl) Get the list of tokens associated with the given node
org.objectweb.proactive.core.util.wrapper.StringWrapper	getRMThreadDump() Returns the string content of the thread dump asked to the Node of the Resource Manager.
RMState	getState() Returns the resource manager summary state.
Collection<PluginDescriptor>	getSupportedNodeSourceInfrastructures() Returns the list of supported node source infrastructures descriptors.
Collection<PluginDescriptor>	getSupportedNodeSourcePolicies() Returns the list of supported node source policies descriptors.
Topology	getTopology() Returns the topology information of nodes.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	isActive() Returns true if the resource manager is operational and a client is connected.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	isNodeAdmin(String nodeUrl) Checks if the currently connected user is the node administrator
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	isNodeUser(String nodeUrl) Checks if the currently connected user can use node for computations
Set<String>	listAliveNodeUrls() Returns a list of all alive Nodes Urls.
Set<String>	listAliveNodeUrls(Set<String> nodeSourceNames) Returns a list of all alive Nodes Urls associated with the given node sources.
Set<String>	listNodeUrls() Returns a list of all nodes Urls known by RMCore.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	lockNodes(Set<String> urls) Locks the set of nodes and makes them not available for others.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	nodeIsAvailable(String nodeUrl) Returns true if the node nodeUrl is registered (i.e.
void	releaseBusyNodesNotInList(List<NodeSet> verifiedBusyNodes) Release the nodes that are busy and that are not part of the given node set
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	releaseNode(org.objectweb.proactive.core.node.Node node) Releases the node after computations.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	releaseNodes(NodeSet nodes) Releases nodes after computations.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	removeNode(String nodeUrl, boolean preempt) Removes a node from the resource manager.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	removeNodeSource(String sourceName, boolean preempt) Remove a node source from the RM.
void	removeNodeToken(String nodeUrl, String token) Remove a token from the given node
void	setNeededNodes(int neededNodes) Set the amount of nodes currently needed by the resource manager
Set<String>	setNodesAvailable(Set<String> nodeUrls) This method is called periodically by ProActive Nodes to inform the Resource Manager of a possible reconnection.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	setNodeSourcePingFrequency(int frequency, String sourceName) Each node source scan its nodes periodically to check their states.
void	setNodeTokens(String nodeUrl, List<String> tokens) Overwrite the tokens list associated with the given node
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	shutdown(boolean preempt) Initiate the shutdowns the resource manager.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	undeployNodeSource(String nodeSourceName, boolean preempt) Remove the nodes of a node source that has been deployed before, and keep the node source defined in the resource manager.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	unlockNodes(Set<String> urls) Unlock nodes.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	updateDynamicParameters(String nodeSourceName, String infrastructureType, Object[] infraParams, String policyType, Object[] policyParams) Update the infrastructure or policy parameters of a node source that marked with 'dynamic'.

Methods inherited from interface org.ow2.proactive.permissions.ServiceUsingPermission

checkPermission

Method Detail

defineNodeSource

org.objectweb.proactive.core.util.wrapper.BooleanWrapper defineNodeSource(String nodeSourceName,
                                                                          String infrastructureType,
                                                                          Object[] infraParams,
                                                                          String policyType,
                                                                          Object[] policyParams,
                                                                          boolean nodesRecoverable)

Defines a new node source in the resource manager.

Parameters:

nodeSourceName - the name of the node source

infrastructureType - type of the underlying infrastructure

infraParams - parameters for infrastructure creation

policyType - name of the policy type. It passed as a string due to plug-able approach

policyParams - parameters for policy creation

nodesRecoverable - whether the nodes can be recovered in case of a scheduler crash

Returns:

true if a new node source was created successfully, runtime exception otherwise

editNodeSource

org.objectweb.proactive.core.util.wrapper.BooleanWrapper editNodeSource(String nodeSourceName,
                                                                        String infrastructureType,
                                                                        Object[] infraParams,
                                                                        String policyType,
                                                                        Object[] policyParams,
                                                                        boolean nodesRecoverable)

Edit an existing node source in the resource manager.

Parameters:

nodeSourceName - the name of the node source to edit

infrastructureType - type of the underlying infrastructure

infraParams - parameters for infrastructure creation

policyType - name of the policy type. It passed as a string due to plug-able approach

policyParams - parameters for policy creation

nodesRecoverable - whether the nodes can be recovered in case of a scheduler crash

Returns:

true if the node source was edited successfully, runtime exception otherwise

updateDynamicParameters

org.objectweb.proactive.core.util.wrapper.BooleanWrapper updateDynamicParameters(String nodeSourceName,
                                                                                 String infrastructureType,
                                                                                 Object[] infraParams,
                                                                                 String policyType,
                                                                                 Object[] policyParams)

Update the infrastructure or policy parameters of a node source that marked with 'dynamic'. Only these parameters will be updated.

Parameters:

nodeSourceName - the name of the node source

infrastructureType - type of the underlying infrastructure

infraParams - parameters of the infrastructure, including the dynamic parameters values to update

policyType - name of the policy type

policyParams - parameters of the policy, including the dynamic parameters values to update

Returns:

true if a new node source was edited successfully, runtime exception otherwise

createNodeSource

@Deprecated
org.objectweb.proactive.core.util.wrapper.BooleanWrapper createNodeSource(String nodeSourceName,
                                                                                      String infrastructureType,
                                                                                      Object[] infrastructureParameters,
                                                                                      String policyType,
                                                                                      Object[] policyParameters,
                                                                                      boolean nodesRecoverable)

Deprecated. As of version 8.1, replaced by defineNodeSource(String, String, Object[], String, Object[], boolean) and deployNodeSource(String) The node source is the set of nodes acquired from specific infrastructure and characterized by particular acquisition policy.

This method creates a new node source with specified name, infrastructure manager and acquisition policy. Parameters required to create infrastructure manager and policy can be obtained from corresponding PluginDescriptor.

Parameters:

nodeSourceName - the name of the node source

infrastructureType - type of the underlying infrastructure

infrastructureParameters - parameters for infrastructure creation

policyType - name of the policy type. It passed as a string due to plug-able approach

policyParameters - parameters for policy creation

nodesRecoverable - whether the nodes can be recovered in case of a scheduler crash

Returns:

true if a new node source was created successfully, runtime exception otherwise

deployNodeSource

org.objectweb.proactive.core.util.wrapper.BooleanWrapper deployNodeSource(String nodeSourceName)

Start acquiring the nodes of a node source that has been defined before. If the node source is already deployed, then this method does nothing.

Parameters:

nodeSourceName - the name of the node source to deploy

Returns:

true if the node source was deployed successfully, false if the node source is already deployed, runtime exception otherwise

undeployNodeSource

org.objectweb.proactive.core.util.wrapper.BooleanWrapper undeployNodeSource(String nodeSourceName,
                                                                            boolean preempt)

Remove the nodes of a node source that has been deployed before, and keep the node source defined in the resource manager. If the node source is already undeployed, then this method does nothing.

Parameters:

nodeSourceName - the name of the node source to undeploy

preempt - if true remove the nodes immediately without waiting them to be freed.

Returns:

true if the node source was undeployed successfully, false if the node source is already undeployed, runtime exception otherwise

removeNodeSource

org.objectweb.proactive.core.util.wrapper.BooleanWrapper removeNodeSource(String sourceName,
                                                                          boolean preempt)

Remove a node source from the RM. All nodes handled by the node source are removed.

Parameters:

sourceName - name of the source to remove.

preempt - if true remove the node immediately without waiting while it will be freed.

Returns:

true if the node source was removed successfully, runtime exception otherwise

getExistingNodeSourcesList

List<RMNodeSourceEvent> getExistingNodeSourcesList()

Returns the list of existing node source infrastructures

Returns:

the list of existing node source infrastructures

getSupportedNodeSourceInfrastructures

Collection<PluginDescriptor> getSupportedNodeSourceInfrastructures()

Returns the list of supported node source infrastructures descriptors.

Returns:

the list of supported node source infrastructures descriptors

getSupportedNodeSourcePolicies

Collection<PluginDescriptor> getSupportedNodeSourcePolicies()

Returns the list of supported node source policies descriptors.

Returns:

the list of supported node source policies descriptors

getNodeSourceConfiguration

NodeSourceConfiguration getNodeSourceConfiguration(String nodeSourceName)

Returns the current configuration of a node source.

setNodeSourcePingFrequency

org.objectweb.proactive.core.util.wrapper.BooleanWrapper setNodeSourcePingFrequency(int frequency,
                                                                                    String sourceName)

Each node source scan its nodes periodically to check their states. This method changes the period of nodes scanning.

Parameters:

frequency - the frequency to set to the node source in ms.

sourceName - name of the node source to set the frequency

Returns:

true if ping frequency is successfully changed, runtime exception otherwise

getNodeSourcePingFrequency

org.objectweb.proactive.core.util.wrapper.IntWrapper getNodeSourcePingFrequency(String sourceName)

Returns the ping frequency of a node source.

Parameters:

sourceName - name of the node source

Returns:

the ping frequency

addNode

org.objectweb.proactive.core.util.wrapper.BooleanWrapper addNode(String nodeUrl)

Adds an existing node to the default node source of the resource manager.

Parameters:

nodeUrl - URL of the node to add.

Returns:

true if new node is added successfully, runtime exception otherwise

addNode

org.objectweb.proactive.core.util.wrapper.BooleanWrapper addNode(String nodeUrl,
                                                                 String sourceName)

Adds an existing node to the particular node source.

Parameters:

nodeUrl - URL of the node to add.

sourceName - name of the static node source that will handle the node

Returns:

true if new node is added successfully, runtime exception otherwise

acquireNodes

org.objectweb.proactive.core.util.wrapper.BooleanWrapper acquireNodes(String sourceName,
                                                                      int numberNodes,
                                                                      long timeout,
                                                                      Map<String,?> nodeConfiguration)

Acquires new nodes in the particular node source.

Parameters:

sourceName - name of the node source that will acquire the new nodes

numberNodes - the number of nodes to acquire

timeout - the maxime waiting time (in milliseconds) before starting to acquire nodes

nodeConfiguration - configuration of acquiring nodes

Returns:

true if the request of acquiring nodes is successfully received, false or exception otherwise

removeNode

org.objectweb.proactive.core.util.wrapper.BooleanWrapper removeNode(String nodeUrl,
                                                                    boolean preempt)

Removes a node from the resource manager.

Parameters:

nodeUrl - URL of the node to remove.

preempt - if true remove the node immediately without waiting while it will be freed.

Returns:

true if the node is removed successfully, false or exception otherwise

lockNodes

org.objectweb.proactive.core.util.wrapper.BooleanWrapper lockNodes(Set<String> urls)

Locks the set of nodes and makes them not available for others. The node state "locked" means that node cannot be used for computations by anyone. Could be called only by node administrator, which is one of the following: rm admin, node source admin or node provider. Nodes can be locked whatever their state is.

Parameters:

urls - is a set of nodes

Returns:

true if all the nodes become locked, false otherwise.

unlockNodes

org.objectweb.proactive.core.util.wrapper.BooleanWrapper unlockNodes(Set<String> urls)

Unlock nodes. The specified nodes become available to other users for computations. Real eligibility still depends on the Node state. Could be called only by node administrator, which is one of the following: rm admin, node source admin or node provider.

Parameters:

urls - is a set of nodes to be unlocked.

Returns:

true if all the nodes are unlocked with success, false otherwise.

nodeIsAvailable

org.objectweb.proactive.core.util.wrapper.BooleanWrapper nodeIsAvailable(String nodeUrl)

Returns true if the node nodeUrl is registered (i.e. known by the RM) and not down.

Parameters:

nodeUrl - of node to ping.

Returns:

true if the node nodeUrl is registered and not down.

setNodesAvailable

Set<String> setNodesAvailable(Set<String> nodeUrls)

This method is called periodically by ProActive Nodes to inform the Resource Manager of a possible reconnection. The method is also used by ProActive Nodes to know if they are still known by the Resource Manager. For instance a Node which has been removed by a user from the Resource Manager is no longer known.

Parameters:

nodeUrls - the URLs of the workers associated to the node that publishes the update.

Returns:

The set of worker node URLs that are unknown to the Resource Manager (i.e. have been removed by a user).

isActive

org.objectweb.proactive.core.util.wrapper.BooleanWrapper isActive()

Returns true if the resource manager is operational and a client is connected. Throws SecurityException if client is not connected.

Returns:

true if the resource manager is operational, false otherwise

getState

RMState getState()

Returns the resource manager summary state. To retrieve detailed state use RMMonitoring.getState() method.

Returns:

the resource manager summary state.

getMonitoring

RMMonitoring getMonitoring()

Returns the monitoring interface to manager listeners of the resource manager.

Returns:

the resource manager monitoring interface

getRMThreadDump

org.objectweb.proactive.core.util.wrapper.StringWrapper getRMThreadDump()

Returns the string content of the thread dump asked to the Node of the Resource Manager.

Returns:

the thread dump on the RM node

getNodeThreadDump

org.objectweb.proactive.core.util.wrapper.StringWrapper getNodeThreadDump(String nodeUrl)

Returns the string content of the thread dump asked to the Node identified by the given URL.

Parameters:

nodeUrl - node to ask the thread dump to

Returns:

the thread dump on this node

listAliveNodeUrls

Set<String> listAliveNodeUrls()

Returns a list of all alive Nodes Urls. Alive means neither down nor currently deploying.

Returns:

list of node urls

listAliveNodeUrls

Set<String> listAliveNodeUrls(Set<String> nodeSourceNames)

Returns a list of all alive Nodes Urls associated with the given node sources.

Parameters:

nodeSourceNames - set of node sources containing the nodes.

Returns:

list of node urls

listNodeUrls

Set<String> listNodeUrls()

Returns a list of all nodes Urls known by RMCore.

Returns:

set of node urls

getAtMostNodes

@Deprecated
NodeSet getAtMostNodes(int number,
                                   SelectionScript selectionScript)

Deprecated.

Finds "number" nodes for computations according to the selection script. All nodes which are returned to the client as marked internally as busy and cannot be used by others until the client frees them.

If the resource manager does not have enough nodes it returns as much as it has, but only those which correspond to the selection criteria.

Parameters:

number - the number of nodes

selectionScript - criterion to be verified by the returned nodes

Returns:

a list of nodes

getAtMostNodes

@Deprecated
NodeSet getAtMostNodes(int number,
                                   SelectionScript selectionScript,
                                   NodeSet exclusion)

Deprecated.

Finds "number" nodes for computations according to the selection script. All nodes which are returned to the client as marked internally as busy and cannot be used by others until the client frees them.

If the resource manager does not have enough nodes it returns as much as it has, but only those which correspond the to selection criteria.

Parameters:

number - the number of nodes

selectionScript - criterion to be verified by the returned nodes

exclusion - a list of node which should not be in the result set

Returns:

a list of nodes

getAtMostNodes

@Deprecated
NodeSet getAtMostNodes(int number,
                                   List<SelectionScript> selectionScriptsList,
                                   NodeSet exclusion)

Deprecated.

Finds "number" nodes for computations according to the selection scripts (node must be complaint to all scripts). All nodes which are returned to the client as marked internally as busy and cannot be used by others until the client frees them.

If the resource manager does not have enough nodes it returns as much as it has, but only those which correspond the to selection criteria.

Parameters:

number - the number of nodes

selectionScriptsList - criteria to be verified by the returned nodes

exclusion - a list of node which should not be in the result set

Returns:

a list of nodes

getAtMostNodes

@Deprecated
NodeSet getAtMostNodes(int number,
                                   TopologyDescriptor descriptor,
                                   List<SelectionScript> selectionScriptsList,
                                   NodeSet exclusion)

Deprecated.

Finds "number" nodes for computations according to the selection scripts (node must be complaint to all scripts). All nodes which are returned to the client as marked internally as busy and cannot be used by others until the client frees them.

If the resource manager does not have enough nodes it returns as much as it has, but only those which correspond the to selection criteria.

Parameters:

number - the number of nodes

descriptor - the topology descriptor of nodes

selectionScriptsList - criteria to be verified by the returned nodes

exclusion - a list of node which should not be in the result set

Returns:

a list of nodes

See Also:

TopologyDescriptor

getNodes

@Deprecated
NodeSet getNodes(int number,
                             TopologyDescriptor descriptor,
                             List<SelectionScript> selectionScriptsList,
                             NodeSet exclusion,
                             boolean bestEffort)

Deprecated.

Finds "number" nodes for computations according to the selection scripts (node must be complaint to all scripts). All nodes which are returned to the client as marked internally as busy and cannot be used by others until the client frees them.

If the resource manager does not have enough nodes the result depends on the bestEffort mode. If set to true, the method returns as many node as it has, but only those which correspond the to selection criteria. If bestEffort set to false the method returns either 0 or all required nodes.

Parameters:

number - the number of nodes

descriptor - the topology descriptor of nodes

selectionScriptsList - criteria to be verified by the returned nodes

exclusion - a list of node which should not be in the result set

bestEffort - the mode of node aggregation

Returns:

a list of nodes

See Also:

TopologyDescriptor

getNodes

NodeSet getNodes(Criteria criteria)

Finds and books nodes for computations. Nodes should satisfy specified criteria.

Parameters:

criteria - criteria to select nodes

Returns:

a list of nodes according to the criteria

See Also:

Criteria

releaseNode

org.objectweb.proactive.core.util.wrapper.BooleanWrapper releaseNode(org.objectweb.proactive.core.node.Node node)

Releases the node after computations. The specified node is marked as free and become available to other users.

Parameters:

node - the node to be released

Returns:

true if the node has been released successfully, runtime exception otherwise. SecurityException may be thrown if the user does not have right to release the node or it tries to release a foreign node.

releaseNodes

org.objectweb.proactive.core.util.wrapper.BooleanWrapper releaseNodes(NodeSet nodes)

Releases nodes after computations. The specified node is marked as free and become available to other users.

Parameters:

nodes - the set of nodes to be released

Returns:

true if nodes have been released successfully, runtime exception otherwise. SecurityException may be thrown if the user does not have right to release one of nodes or it tries to release a foreign node.

disconnect

org.objectweb.proactive.core.util.wrapper.BooleanWrapper disconnect()

Disconnects from resource manager and releases all the nodes taken by user for computations.

Returns:

true if successfully disconnected, runtime exception otherwise

shutdown

org.objectweb.proactive.core.util.wrapper.BooleanWrapper shutdown(boolean preempt)

Initiate the shutdowns the resource manager. During the shutdown resource manager removed all the nodes and kills them if necessary.

RMEvent(SHUTDOWN) will be send when the shutdown is finished.

Returns:

true if the shutdown process is successfully triggered, runtime exception otherwise

getTopology

Topology getTopology()

Returns the topology information of nodes.

Returns:

nodes topology

isNodeAdmin

org.objectweb.proactive.core.util.wrapper.BooleanWrapper isNodeAdmin(String nodeUrl)

Checks if the currently connected user is the node administrator

Returns:

true if yes, false otherwise

isNodeUser

org.objectweb.proactive.core.util.wrapper.BooleanWrapper isNodeUser(String nodeUrl)

Checks if the currently connected user can use node for computations

Returns:

true if yes, false otherwise

executeScript

<T> List<ScriptResult<T>> executeScript(Script<T> script,
                                        String targetType,
                                        Set<String> targets)

Executes the script on the specified targets depending on the target type.

Parameters:

script - a selection script to execute.

targetType - must be either NODE_URL, NODESOURCE_NAME or HOSTNAME

targets - are names of particular resources

Returns:

the ScriptResult corresponding to the script execution.

executeScript

List<ScriptResult<Object>> executeScript(String script,
                                         String scriptEngine,
                                         String targetType,
                                         Set<String> targets)

Executes the script on the specified targets depending on the target type.

Parameters:

script - a selection script to execute.

scriptEngine - script engine name

targetType - must be either NODE_URL, NODESOURCE_NAME or HOSTNAME

targets - are names of particular resources

Returns:

the ScriptResult corresponding to the script execution.

getCurrentUser

org.objectweb.proactive.core.util.wrapper.StringWrapper getCurrentUser()

Returns the user currently connected

Returns:

user name

getCurrentUserData

UserData getCurrentUserData()

Returns the groups associated with the current connected user.

Returns:

a set of groups

releaseBusyNodesNotInList

void releaseBusyNodesNotInList(List<NodeSet> verifiedBusyNodes)

Release the nodes that are busy and that are not part of the given node set

Parameters:

verifiedBusyNodes - nodes that should not be released

areNodesKnown

boolean areNodesKnown(NodeSet nodes)

Check whether the nodes in the given node set are known by the resource manager

Parameters:

nodes - the node set to verify

Returns:

whether all nodes in the node set appear in the resource manager

areNodesRecoverable

Map<String,Boolean> areNodesRecoverable(NodeSet nodes)

Check whether the nodes in the given node set can be recovered in case of a crash

Parameters:

nodes - the node set to verify

Returns:

a map containing recoverable status for each node of the node set

setNeededNodes

void setNeededNodes(int neededNodes)

Set the amount of nodes currently needed by the resource manager

Parameters:

neededNodes - number of nodes needed

getInfrasToPoliciesMapping

Map<String,List<String>> getInfrasToPoliciesMapping()

Return the associations of infrastructures and policy For each infrastructure name, the list of policies which can be associated

Returns:

infrastructure and policies associations

getNodesHistory

List<RMNodeHistory> getNodesHistory(long windowStart,
                                    long windowEnd)

Return all node state events for the given period

Parameters:

windowStart - period start time

windowEnd - period end time

Returns:

a list of node state events

addNodeToken

void addNodeToken(String nodeUrl,
                  String token)
           throws RMException

Add a token to the given node

Parameters:

nodeUrl - url of the node

token - token to add

Throws:

RMException

removeNodeToken

void removeNodeToken(String nodeUrl,
                     String token)
              throws RMException

Remove a token from the given node

Parameters:

nodeUrl - url of the node

token - token to remove

Throws:

RMException

setNodeTokens

void setNodeTokens(String nodeUrl,
                   List<String> tokens)
            throws RMException

Overwrite the tokens list associated with the given node

Parameters:

nodeUrl - url of the node

tokens - list of tokens

Throws:

RMException

getNodeTokens

List<String> getNodeTokens(String nodeUrl)
                    throws RMException

Get the list of tokens associated with the given node

Parameters:

nodeUrl - url of the node

Returns:

list of tokens

Throws:

RMException

getAllNodesTokens

Map<String,List<String>> getAllNodesTokens()
                                    throws RMException

Get the list of tokens associated with all resource manager nodes

Returns:

nodes / token list association

Throws:

RMException

getAllEligibleNodesTokens

Map<String,List<String>> getAllEligibleNodesTokens()
                                            throws RMException

Get the list of tokens associated with all resource manager eligible nodes

Returns:

eligible nodes / token list association

Throws:

RMException

getNodeTags

Set<String> getNodeTags(String nodeUrl)
                 throws RMException

Return the set of tags associated with the given node

Parameters:

nodeUrl - url of the node

Returns:

set of tags

Throws:

RMException

getNodesByTag

Set<String> getNodesByTag(String tag)

Returns a list of nodes Urls which contain the specified tag

Parameters:

tag - the expected tag which should be contained in the returned node

Returns:

node urls which contain the tag

getNodesByTags

Set<String> getNodesByTags(Set<String> tags,
                           boolean all)

Returns a list of nodes Urls which contain all or any specified list of tags

Parameters:

tags - list of tags

all - When true, the search return nodes which contain all tags; when false, the search return nodes which contain any tag among the list tags.

Returns:

nodes urls which contain all or any specified list of tags

checkNodePermission

org.objectweb.proactive.core.util.wrapper.BooleanWrapper checkNodePermission(String nodeUrl,
                                                                             boolean provider)

Check is the user has admin permission for the given node or it is a node source provider

Parameters:

nodeUrl - the node url

provider - if false, the method will check if the user is admin, if true, the method will also check if the node is a provider

Returns:

true if the user has permission to access the node, false otherwise

checkNodeSourcePermission

org.objectweb.proactive.core.util.wrapper.BooleanWrapper checkNodeSourcePermission(String nodeSourceName,
                                                                                   boolean provider)

Check is the user has admin permission for the given node source or it is a node source provider

Parameters:

nodeSourceName - the node source name

provider - if false, the method will check if the user is admin, if true, the method will also check if the node is a provider

Returns:

true if the user has permission to access the nodeSource, false otherwise