org.ow2.proactive.resourcemanager.core

Class RMCore

java.lang.Object

org.ow2.proactive.resourcemanager.core.RMCore

All Implemented Interfaces:

org.objectweb.proactive.Active, org.objectweb.proactive.InitActive, org.objectweb.proactive.RunActive, ResourceManager

public class RMCore
extends Object
implements ResourceManager, org.objectweb.proactive.InitActive, org.objectweb.proactive.RunActive

The main active object of the Resource Manager (RM), the RMCore has to provide nodes to clients.

The RMCore functions are:

• Create Resource Manager's active objects at its initialization
• Keep an up-to-date list of nodes able to perform scheduler's tasks.
• Give nodes to the Scheduler asked by RMProxyUserInterface object, with a node selection mechanism performed by SelectionScript.
• Dialog with node sources which add and remove nodes to the Core.
• Perform creation and removal of NodeSource objects.
• Treat removing nodes and adding nodes requests
• Create and launch RMEvents concerning nodes and nodes sources to RMMonitoring active object.

Nodes in Resource Manager are represented by objects. RMcore has to manage different states of nodes:

• Free: node is ready to perform a task.
• Busy: node is executing a task.
• To be removed: 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.

RMCore is not responsible of creation, acquisition and monitoring of nodes, these points are performed by NodeSource objects.

WARNING: you must instantiate this class as an Active Object!

RmCore should be non-blocking which means:

• No direct access to nodes.
• All method calls to other active objects should be either asynchronous or non-blocking immediate services.
• Methods which have to return something depending on another active objects should use an automatic continuation.

Since:

ProActive Scheduling 0.9

Field Summary

Fields

Modifier and Type	Field and Description
static Map<org.objectweb.proactive.core.UniqueID,Client>	clients Map of connected clients and internal services that have an access to the core.
static String	HAS_BEEN_SUCCESSFULLY
static String	NODE_SOURCE_STRING
static String	REQUESTED_BY_STRING
static TopologyManager	topologyManager Nodes topology

Constructor Summary

Constructors

Constructor and Description
RMCore() ProActive Empty constructor
RMCore(Map<String,NodeSource> deployedNodeSources, Map<String,RMNode> allNodes, Client caller, RMMonitoringImpl monitoring, SelectionManager manager, List<RMNode> freeNodesList, RMDBManager newDataBaseManager)
RMCore(String id, org.objectweb.proactive.core.node.Node nodeRM) Creates the RMCore object.

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.
void	addEligibleNodesToRecover(List<RMNode> eligibleNodes)
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
protected Client	checkPermissionAndGetClientIsSuccessful()
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)
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.
void	disconnect(org.objectweb.proactive.core.UniqueID clientId) Disconnects the client and releases all nodes held by him
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> scripts, NodeSet exclusion) Finds "number" nodes for computations according to the selection scripts (node must be complaint to all scripts).
NodeSet	getAtMostNodes(int nbNodes, SelectionScript selectionScript) Finds "number" nodes for computations according to the selection script.
NodeSet	getAtMostNodes(int number, SelectionScript selectionScript, NodeSet exclusion) Finds "number" nodes for computations according to the selection script.
NodeSet	getAtMostNodes(int number, TopologyDescriptor descriptor, List<SelectionScript> selectionScrips, NodeSet exclusion) Finds "number" nodes for computations according to the selection scripts (node must be complaint to all scripts).
org.objectweb.proactive.core.util.wrapper.StringWrapper	getCurrentUser() Returns the user currently connected
UserData	getCurrentUserData() Returns the groups associated with the current connected user.
RMDBManager	getDbManager()
NodeSet	getExactlyNodes(int nb, SelectionScript selectionScript)
List<org.ow2.proactive.resourcemanager.common.event.RMNodeSourceEvent>	getExistingNodeSourcesList() Gives list of existing Node Sources
List<RMNode>	getFreeNodes()
String	getId()
Map<String,List<String>>	getInfrasToPoliciesMapping() Return the associations of infrastructures and policy For each infrastructure name, the list of policies which can be associated
Map<String,Boolean>	getMapOnNodeUrlSet(Set<String> nodeUrls, com.google.common.base.Predicate<RMNode> operation, String operationName)
org.ow2.proactive.resourcemanager.frontend.RMMonitoring	getMonitoring() Gets RM monitoring stub
protected RMNode	getNodeByUrlIncludingDeployingNodes(String url)
NodeSet	getNodes(Criteria criteria) Finds and books nodes for computations.
NodeSet	getNodes(int number, TopologyDescriptor topology, List<SelectionScript> selectionScrips, NodeSet exclusion, boolean bestEffort) Finds "number" nodes for computations according to the selection scripts (node must be complaint to all scripts).
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<org.ow2.proactive.resourcemanager.common.event.RMNodeHistory>	getNodesHistory(long windowStart, long windowEnd) Return all node state events for the given period
List<org.ow2.proactive.resourcemanager.common.event.RMNodeEvent>	getNodesList() Deprecated.
org.ow2.proactive.resourcemanager.nodesource.common.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.
org.ow2.proactive.resourcemanager.common.NodeState	getNodeState(String nodeUrl)
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.ow2.proactive.resourcemanager.common.event.RMInitialState	getRMInitialState() Builds and returns a snapshot of RMCore's current state.
org.objectweb.proactive.core.util.wrapper.StringWrapper	getRMThreadDump() Returns the string content of the thread dump asked to the Node of the Resource Manager.
org.ow2.proactive.resourcemanager.common.RMState	getState() Returns the resource manager summary state.
Collection<org.ow2.proactive.resourcemanager.nodesource.common.PluginDescriptor>	getSupportedNodeSourceInfrastructures() Returns the list of supported node source infrastructures descriptors.
Collection<org.ow2.proactive.resourcemanager.nodesource.common.PluginDescriptor>	getSupportedNodeSourcePolicies() Returns the list of supported node source policies descriptors.
List<String>	getToBeRemovedUnavailableNodesUrls()
Topology	getTopology() Returns the topology information of nodes.
int	getTotalAliveNodesNumber() Gives total number of alive nodes handled by RM
void	initActivity(org.objectweb.proactive.Body body) Initialization part of the RMCore active object.
protected void	initiateRecoveryIfRequired()
void	internalAddNodeToCore(RMNode configuredNode) Internal operation of registering a new node in the Core This step is done after node configuration ran by RMNodeConfigurator active object.
void	internalRegisterConfiguringNode(RMNode rmnode) Internal operation of configuring a node.
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	lockNodes(Set<String> urls, Client caller)
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	mapOnNodeUrlSet(Set<String> nodeUrls, com.google.common.base.Predicate<RMNode> operation, String operationName)
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	nodeIsAvailable(String nodeUrl) Returns true if the node nodeUrl is registered (i.e.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	nodeSourceUnregister(String nodeSourceName, NodeSourceStatus nodeSourceStatus, org.ow2.proactive.resourcemanager.common.event.RMNodeSourceEvent evt) Unregisters node source from the resource manager core.
void	recoverNodeSource(NodeSourceDescriptor nodeSourceDescriptor) Recreate a node source from a node source descriptor and deploy it if the node source descriptor specifies a deployed status.
void	registerAndEmitNodeEvent(org.ow2.proactive.resourcemanager.common.event.RMNodeEvent event)
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	registerAvailableNode(RMNode rmNode) Add the node in the list of all nodes to make it pingable.
void	releaseBusyNodesNotInList(List<NodeSet> nodesToNotRelease) 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.
void	removeAllNodes(String nodeSourceName, boolean preemptive) Removes all nodes from the specified node source.
void	removeAllNodes(String nodeSourceName, boolean preemptive, boolean isTriggeredFromShutdownHook) Removes all nodes from the specified node source.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	removeNode(String nodeUrl, boolean preempt) Removes a node from the RM.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	removeNode(String nodeUrl, boolean preempt, boolean isTriggeredFromShutdownHook)
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	removeNodeFromCore(String nodeUrl) Removed a node with given url from the internal structures of the core.
void	removeNodes(int number, String nodeSourceName, boolean preemptive) Removes "number" of nodes from the node source.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	removeNodeSource(String nodeSourceName, boolean preempt) Remove a node source from the RM.
void	removeNodeToken(String nodeUrl, String token) Remove a token from the given node
void	runActivity(org.objectweb.proactive.Body body) RunActivity periodically send "alive" event to listeners
void	setBusyNode(String nodeUrl, Client owner)
void	setBusyNode(String nodeUrl, Client owner, Map<String,String> usageInfo) Set a node state to busy.
void	setBusyNodes(List<String> nodeUrlList, Client owner, List<Map<String,String>> usageInfoList, int usageInfoCriteriaSize) Set a list of nodes state to busy.
boolean	setDeploying(RMNode rmNode)
void	setDownNode(String nodeUrl) Sets a node state to down and updates all internal structures of rm core accordingly.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	setFreeNodes(List<RMNode> nodes) Mark nodes as free after cleaning procedure.
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) Shutdown the resource manager
protected void	signalRMCoreIsInitialized()
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NODE_SOURCE_STRING

public static final String NODE_SOURCE_STRING

See Also:

Constant Field Values

REQUESTED_BY_STRING

public static final String REQUESTED_BY_STRING

See Also:

Constant Field Values

HAS_BEEN_SUCCESSFULLY

public static final String HAS_BEEN_SUCCESSFULLY

See Also:

Constant Field Values

clients

public static final Map<org.objectweb.proactive.core.UniqueID,Client> clients

Map of connected clients and internal services that have an access to the core. It is statically used due to drawbacks in the client pinger functionality

See Also:

Client

topologyManager

public static TopologyManager topologyManager

Nodes topology

Constructor Detail

RMCore

public RMCore()

ProActive Empty constructor

RMCore

public RMCore(String id,
              org.objectweb.proactive.core.node.Node nodeRM)
       throws org.objectweb.proactive.ActiveObjectCreationException,
              org.objectweb.proactive.core.node.NodeException

Creates the RMCore object.

Parameters:

id - Name for RMCOre.

nodeRM - Name of the ProActive Node object containing RM active objects.

Throws:

org.objectweb.proactive.ActiveObjectCreationException - if creation of the active object failed.

org.objectweb.proactive.core.node.NodeException - if a problem occurs on the target node.

RMCore

public RMCore(Map<String,NodeSource> deployedNodeSources,
              Map<String,RMNode> allNodes,
              Client caller,
              RMMonitoringImpl monitoring,
              SelectionManager manager,
              List<RMNode> freeNodesList,
              RMDBManager newDataBaseManager)

Method Detail

initActivity

public void initActivity(org.objectweb.proactive.Body body)

Initialization part of the RMCore active object. Create RM's active objects and the default static Node Source named RMConstants.DEFAULT_STATIC_SOURCE_NAME. Finally, it throws the RM started event.

Specified by:

initActivity in interface org.objectweb.proactive.InitActive

Parameters:

body - the active object's body.

signalRMCoreIsInitialized

protected void signalRMCoreIsInitialized()

initiateRecoveryIfRequired

protected void initiateRecoveryIfRequired()

runActivity

public void runActivity(org.objectweb.proactive.Body body)

RunActivity periodically send "alive" event to listeners

Specified by:

runActivity in interface org.objectweb.proactive.RunActive

getNodeByUrlIncludingDeployingNodes

protected RMNode getNodeByUrlIncludingDeployingNodes(String url)

setFreeNodes

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper setFreeNodes(List<RMNode> nodes)

Mark nodes as free after cleaning procedure.

Parameters:

nodes - to be free

Returns:

true if all successful, false if there is a down node among nodes

internalAddNodeToCore

public void internalAddNodeToCore(RMNode configuredNode)

Internal operation of registering a new node in the Core This step is done after node configuration ran by RMNodeConfigurator active object.

Parameters:

configuredNode - the node that is going to be added.

getTotalAliveNodesNumber

public int getTotalAliveNodesNumber()

Gives total number of alive nodes handled by RM

Returns:

total number of alive nodes

registerAvailableNode

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper registerAvailableNode(RMNode rmNode)

Add the node in the list of all nodes to make it pingable.

Parameters:

rmNode - the node to make available

internalRegisterConfiguringNode

public void internalRegisterConfiguringNode(RMNode rmnode)

Internal operation of configuring a node. The node is not useable by a final user ( not eligible thanks to getNode methods ) if it is in configuration state. This method is called by RMNodeConfigurator to notify the core that the process of configuring the rmnode has started. The end of the process will be notified thanks to the method internalAddNodeToCore(RMNode)

Parameters:

rmnode - the node in the configuration state

getId

public String getId()

addNode

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

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

Specified by:

addNode in interface ResourceManager

Parameters:

nodeUrl - URL of the node to add.

Returns:

true if new node is added successfully, runtime exception otherwise

addNode

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

Adds an existing node to the particular node source.

Specified by:

addNode in interface ResourceManager

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

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

Description copied from interface: ResourceManager

Acquires new nodes in the particular node source.

Specified by:

acquireNodes in interface ResourceManager

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

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

Removes a node from the RM. This method also handles deploying node removal ( deploying node's url follow the scheme deploying:// ). In such a case, the preempt parameter is not used.

Specified by:

removeNode in interface ResourceManager

Parameters:

nodeUrl - URL of the node to remove.

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

Returns:

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

removeNode

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

removeNodes

public void removeNodes(int number,
                        String nodeSourceName,
                        boolean preemptive)

Removes "number" of nodes from the node source.

Parameters:

number - amount of nodes to be released

nodeSourceName - a node source name

preemptive - if true remove nodes immediately without waiting while they will be freed

removeAllNodes

public void removeAllNodes(String nodeSourceName,
                           boolean preemptive)

Removes all nodes from the specified node source.

Parameters:

nodeSourceName - a name of the node source

preemptive - if true remove nodes immediately without waiting while they will be freed

removeAllNodes

public void removeAllNodes(String nodeSourceName,
                           boolean preemptive,
                           boolean isTriggeredFromShutdownHook)

Removes all nodes from the specified node source.

Parameters:

nodeSourceName - a name of the node source

preemptive - if true remove nodes immediately without waiting while they will be freed

isTriggeredFromShutdownHook - boolean saying if the calling is performed from a shutdown hook.

addEligibleNodesToRecover

public void addEligibleNodesToRecover(List<RMNode> eligibleNodes)

nodeIsAvailable

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

Returns true if the node nodeUrl is registered (i.e. known by the RM). Note that true is returned even if the node is down.

Specified by:

nodeIsAvailable in interface ResourceManager

Parameters:

nodeUrl - the tested node.

Returns:

true if the node nodeUrl is registered.

setNodesAvailable

public 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.

The method is defined as Immediate Service. This way it is executed in a dedicated Thread. It is essential in order to allow other methods to be executed immediately even if incoming connection to the Nodes is stopped or filtered while a timeout occurs when this method tries to send back a reply.

The allNodes data-structure is written by a single Thread only but read by multiple Threads.

Parallel executions of this method must involves different nodeUrls.

The underlying calls to setBusyNode and internalSetFree are writing to the freeNodes data-structure. It explains why this last is synchronized (thread-safe).

Specified by:

setNodesAvailable in interface ResourceManager

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).

getNodeState

public org.ow2.proactive.resourcemanager.common.NodeState getNodeState(String nodeUrl)

defineNodeSource

public 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.

Specified by:

defineNodeSource in interface ResourceManager

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

public 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.

Specified by:

editNodeSource in interface ResourceManager

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

public 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.

Specified by:

updateDynamicParameters in interface ResourceManager

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
public 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)

Specified by:

createNodeSource in interface ResourceManager

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

public 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.

Specified by:

deployNodeSource in interface ResourceManager

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

recoverNodeSource

public void recoverNodeSource(NodeSourceDescriptor nodeSourceDescriptor)

Recreate a node source from a node source descriptor and deploy it if the node source descriptor specifies a deployed status. The flow is inspired from defineNodeSource(java.lang.String, java.lang.String, java.lang.Object[], java.lang.String, java.lang.Object[], boolean) and deployNodeSource(java.lang.String) but this version does not emit events as the recovered node sources are supposed to have been created and deployed already in the past.

Parameters:

nodeSourceDescriptor - the descriptor of the node source to recover

undeployNodeSource

public 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.

Specified by:

undeployNodeSource in interface ResourceManager

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

shutdown

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

Shutdown the resource manager

Specified by:

shutdown in interface ResourceManager

Returns:

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

releaseNode

public 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.

Specified by:

releaseNode in interface ResourceManager

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

public 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.

Specified by:

releaseNodes in interface ResourceManager

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.

getAtMostNodes

public NodeSet getAtMostNodes(int nbNodes,
                              SelectionScript selectionScript)

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.

Specified by:

getAtMostNodes in interface ResourceManager

Parameters:

nbNodes - the number of nodes

selectionScript - criterion to be verified by the returned nodes

Returns:

a list of nodes

getAtMostNodes

public NodeSet getAtMostNodes(int number,
                              SelectionScript selectionScript,
                              NodeSet exclusion)

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.

Specified by:

getAtMostNodes in interface ResourceManager

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

public NodeSet getAtMostNodes(int number,
                              List<SelectionScript> scripts,
                              NodeSet exclusion)

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.

Specified by:

getAtMostNodes in interface ResourceManager

Parameters:

number - the number of nodes

scripts - 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

public NodeSet getAtMostNodes(int number,
                              TopologyDescriptor descriptor,
                              List<SelectionScript> selectionScrips,
                              NodeSet exclusion)

Description copied from interface: ResourceManager

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.

Specified by:

getAtMostNodes in interface ResourceManager

Parameters:

number - the number of nodes

descriptor - the topology descriptor of nodes

selectionScrips - 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

getDbManager

public RMDBManager getDbManager()

getNodes

public NodeSet getNodes(int number,
                        TopologyDescriptor topology,
                        List<SelectionScript> selectionScrips,
                        NodeSet exclusion,
                        boolean bestEffort)

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.

Specified by:

getNodes in interface ResourceManager

Parameters:

number - the number of nodes

topology - the topology descriptor of nodes

selectionScrips - 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

public NodeSet getNodes(Criteria criteria)

Description copied from interface: ResourceManager

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

Specified by:

getNodes in interface ResourceManager

Parameters:

criteria - criteria to select nodes

Returns:

a list of nodes according to the criteria

See Also:

Criteria

getExactlyNodes

public NodeSet getExactlyNodes(int nb,
                               SelectionScript selectionScript)

getRMInitialState

public org.ow2.proactive.resourcemanager.common.event.RMInitialState getRMInitialState()

Builds and returns a snapshot of RMCore's current state. Initial state must be understood as a new Monitor point of view. A new monitor start to receive RMCore events, so must be informed of the current state of the Core at the beginning of monitoring. The monitor is built in three parts first with all the nodes knows by the RMCore, then with all deploying nodes known by the deployed node sources and then with all the defined node sources.

Returns:

RMInitialState containing nodes and nodeSources of the RMCore.

getMonitoring

public org.ow2.proactive.resourcemanager.frontend.RMMonitoring getMonitoring()

Gets RM monitoring stub

Specified by:

getMonitoring in interface ResourceManager

Returns:

the resource manager monitoring interface

getRMThreadDump

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

Description copied from interface: ResourceManager

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

Specified by:

getRMThreadDump in interface ResourceManager

Returns:

the thread dump on the RM node

getNodeThreadDump

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

Description copied from interface: ResourceManager

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

Specified by:

getNodeThreadDump in interface ResourceManager

Parameters:

nodeUrl - node to ask the thread dump to

Returns:

the thread dump on this node

listAliveNodeUrls

public Set<String> listAliveNodeUrls()

Description copied from interface: ResourceManager

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

Specified by:

listAliveNodeUrls in interface ResourceManager

Returns:

list of node urls

listAliveNodeUrls

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

Description copied from interface: ResourceManager

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

Specified by:

listAliveNodeUrls in interface ResourceManager

Parameters:

nodeSourceNames - set of node sources containing the nodes.

Returns:

list of node urls

listNodeUrls

public Set<String> listNodeUrls()

Description copied from interface: ResourceManager

Returns a list of all nodes Urls known by RMCore.

Specified by:

listNodeUrls in interface ResourceManager

Returns:

set of node urls

nodeSourceUnregister

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper nodeSourceUnregister(String nodeSourceName,
                                                                                     NodeSourceStatus nodeSourceStatus,
                                                                                     org.ow2.proactive.resourcemanager.common.event.RMNodeSourceEvent evt)

Unregisters node source from the resource manager core.

setBusyNode

public void setBusyNode(String nodeUrl,
                        Client owner)
                 throws NotConnectedException

Throws:

NotConnectedException

setBusyNode

public void setBusyNode(String nodeUrl,
                        Client owner,
                        Map<String,String> usageInfo)
                 throws NotConnectedException

Set a node state to busy. Set the node to busy, and move the node to the internal busy nodes list. An event informing the node state's change is thrown to RMMonitoring.

Parameters:

owner -

nodeUrl - node to set

Throws:

NotConnectedException

setBusyNodes

public void setBusyNodes(List<String> nodeUrlList,
                         Client owner,
                         List<Map<String,String>> usageInfoList,
                         int usageInfoCriteriaSize)
                  throws NotConnectedException

Set a list of nodes state to busy. Set the nodes to busy, and move the nodes to the internal busy nodes list. An event informing the node state's change is thrown to RMMonitoring.

Parameters:

nodeUrlList - list of node to mark as busy

owner - who is using the nodes

usageInfoList - list of usage information for each node

usageInfoCriteriaSize - original size of the usage information criteria

Throws:

NotConnectedException

setDownNode

public void setDownNode(String nodeUrl)

Sets a node state to down and updates all internal structures of rm core accordingly. Sends an event indicating that the node is down.

registerAndEmitNodeEvent

public void registerAndEmitNodeEvent(org.ow2.proactive.resourcemanager.common.event.RMNodeEvent event)

removeNodeFromCore

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

Removed a node with given url from the internal structures of the core.

Parameters:

nodeUrl - down node to be removed

Returns:

true if the nodes was successfully removed, false otherwise

getFreeNodes

public List<RMNode> getFreeNodes()

getNodeSourcePingFrequency

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

Returns the ping frequency of a node source.

Specified by:

getNodeSourcePingFrequency in interface ResourceManager

Parameters:

sourceName - name of the node source

Returns:

the ping frequency

setNodeSourcePingFrequency

public 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.

Specified by:

setNodeSourcePingFrequency in interface ResourceManager

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

getExistingNodeSourcesList

public List<org.ow2.proactive.resourcemanager.common.event.RMNodeSourceEvent> getExistingNodeSourcesList()

Gives list of existing Node Sources

Specified by:

getExistingNodeSourcesList in interface ResourceManager

Returns:

list of existing Node Sources

getNodesList

@Deprecated
public List<org.ow2.proactive.resourcemanager.common.event.RMNodeEvent> getNodesList()

Deprecated.

removeNodeSource

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

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

Specified by:

removeNodeSource in interface ResourceManager

Parameters:

nodeSourceName - 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

getState

public org.ow2.proactive.resourcemanager.common.RMState getState()

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

Specified by:

getState in interface ResourceManager

Returns:

the resource manager summary state.

getToBeRemovedUnavailableNodesUrls

public List<String> getToBeRemovedUnavailableNodesUrls()

isActive

public 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.

Specified by:

isActive in interface ResourceManager

Returns:

true if the resource manager is operational, false otherwise

checkPermissionAndGetClientIsSuccessful

protected Client checkPermissionAndGetClientIsSuccessful()

disconnect

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

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

Specified by:

disconnect in interface ResourceManager

Returns:

true if successfully disconnected, runtime exception otherwise

disconnect

public void disconnect(org.objectweb.proactive.core.UniqueID clientId)

Disconnects the client and releases all nodes held by him

getSupportedNodeSourceInfrastructures

public Collection<org.ow2.proactive.resourcemanager.nodesource.common.PluginDescriptor> getSupportedNodeSourceInfrastructures()

Returns the list of supported node source infrastructures descriptors.

Specified by:

getSupportedNodeSourceInfrastructures in interface ResourceManager

Returns:

the list of supported node source infrastructures descriptors

getSupportedNodeSourcePolicies

public Collection<org.ow2.proactive.resourcemanager.nodesource.common.PluginDescriptor> getSupportedNodeSourcePolicies()

Returns the list of supported node source policies descriptors.

Specified by:

getSupportedNodeSourcePolicies in interface ResourceManager

Returns:

the list of supported node source policies descriptors

getNodeSourceConfiguration

public org.ow2.proactive.resourcemanager.nodesource.common.NodeSourceConfiguration getNodeSourceConfiguration(String nodeSourceName)

Returns the current configuration of a node source.

Specified by:

getNodeSourceConfiguration in interface ResourceManager

getTopology

public Topology getTopology()

Description copied from interface: ResourceManager

Returns the topology information of nodes.

Specified by:

getTopology in interface ResourceManager

Returns:

nodes topology

lockNodes

public 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.

Specified by:

lockNodes in interface ResourceManager

Parameters:

urls - is a set of nodes

Returns:

true if all the nodes become locked, false otherwise.

lockNodes

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

unlockNodes

public 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.

Specified by:

unlockNodes in interface ResourceManager

Parameters:

urls - is a set of nodes to be unlocked.

Returns:

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

mapOnNodeUrlSet

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper mapOnNodeUrlSet(Set<String> nodeUrls,
                                                                                com.google.common.base.Predicate<RMNode> operation,
                                                                                String operationName)

getMapOnNodeUrlSet

public Map<String,Boolean> getMapOnNodeUrlSet(Set<String> nodeUrls,
                                              com.google.common.base.Predicate<RMNode> operation,
                                              String operationName)

isNodeAdmin

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

Checks if the currently connected user is the node administrator

Specified by:

isNodeAdmin in interface ResourceManager

Returns:

true if yes, false otherwise

isNodeUser

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

Checks if the currently connected user can use node for computations

Specified by:

isNodeUser in interface ResourceManager

Returns:

true if yes, false otherwise

executeScript

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

Description copied from interface: ResourceManager

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

Specified by:

executeScript in interface ResourceManager

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.

executeScript

public <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.

Specified by:

executeScript in interface ResourceManager

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.

setDeploying

public boolean setDeploying(RMNode rmNode)

getCurrentUser

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

Description copied from interface: ResourceManager

Returns the user currently connected

Specified by:

getCurrentUser in interface ResourceManager

Returns:

user name

getCurrentUserData

public UserData getCurrentUserData()

Description copied from interface: ResourceManager

Returns the groups associated with the current connected user.

Specified by:

getCurrentUserData in interface ResourceManager

Returns:

a set of groups

releaseBusyNodesNotInList

public void releaseBusyNodesNotInList(List<NodeSet> nodesToNotRelease)

Description copied from interface: ResourceManager

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

Specified by:

releaseBusyNodesNotInList in interface ResourceManager

Parameters:

nodesToNotRelease - nodes that should not be released

areNodesKnown

public boolean areNodesKnown(NodeSet nodes)

Description copied from interface: ResourceManager

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

Specified by:

areNodesKnown in interface ResourceManager

Parameters:

nodes - the node set to verify

Returns:

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

areNodesRecoverable

public Map<String,Boolean> areNodesRecoverable(NodeSet nodes)

Description copied from interface: ResourceManager

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

Specified by:

areNodesRecoverable in interface ResourceManager

Parameters:

nodes - the node set to verify

Returns:

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

setNeededNodes

public void setNeededNodes(int neededNodes)

Description copied from interface: ResourceManager

Set the amount of nodes currently needed by the resource manager

Specified by:

setNeededNodes in interface ResourceManager

Parameters:

neededNodes - number of nodes needed

getInfrasToPoliciesMapping

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

Description copied from interface: ResourceManager

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

Specified by:

getInfrasToPoliciesMapping in interface ResourceManager

Returns:

infrastructure and policies associations

getNodesHistory

public List<org.ow2.proactive.resourcemanager.common.event.RMNodeHistory> getNodesHistory(long windowStart,
                                                                                          long windowEnd)

Description copied from interface: ResourceManager

Return all node state events for the given period

Specified by:

getNodesHistory in interface ResourceManager

Parameters:

windowStart - period start time

windowEnd - period end time

Returns:

a list of node state events

addNodeToken

public void addNodeToken(String nodeUrl,
                         String token)
                  throws org.ow2.proactive.resourcemanager.exception.RMException

Description copied from interface: ResourceManager

Add a token to the given node

Specified by:

addNodeToken in interface ResourceManager

Parameters:

nodeUrl - url of the node

token - token to add

Throws:

org.ow2.proactive.resourcemanager.exception.RMException

getNodeTokens

public List<String> getNodeTokens(String nodeUrl)
                           throws org.ow2.proactive.resourcemanager.exception.RMException

Description copied from interface: ResourceManager

Get the list of tokens associated with the given node

Specified by:

getNodeTokens in interface ResourceManager

Parameters:

nodeUrl - url of the node

Returns:

list of tokens

Throws:

org.ow2.proactive.resourcemanager.exception.RMException

getAllNodesTokens

public Map<String,List<String>> getAllNodesTokens()
                                           throws org.ow2.proactive.resourcemanager.exception.RMException

Description copied from interface: ResourceManager

Get the list of tokens associated with all resource manager nodes

Specified by:

getAllNodesTokens in interface ResourceManager

Returns:

nodes / token list association

Throws:

org.ow2.proactive.resourcemanager.exception.RMException

getAllEligibleNodesTokens

public Map<String,List<String>> getAllEligibleNodesTokens()
                                                   throws org.ow2.proactive.resourcemanager.exception.RMException

Description copied from interface: ResourceManager

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

Specified by:

getAllEligibleNodesTokens in interface ResourceManager

Returns:

eligible nodes / token list association

Throws:

org.ow2.proactive.resourcemanager.exception.RMException

getNodeTags

public Set<String> getNodeTags(String nodeUrl)
                        throws org.ow2.proactive.resourcemanager.exception.RMException

Description copied from interface: ResourceManager

Return the set of tags associated with the given node

Specified by:

getNodeTags in interface ResourceManager

Parameters:

nodeUrl - url of the node

Returns:

set of tags

Throws:

org.ow2.proactive.resourcemanager.exception.RMException

getNodesByTag

public Set<String> getNodesByTag(String tag)

Description copied from interface: ResourceManager

Returns a list of nodes Urls which contain the specified tag

Specified by:

getNodesByTag in interface ResourceManager

Parameters:

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

Returns:

node urls which contain the tag

getNodesByTags

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

Description copied from interface: ResourceManager

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

Specified by:

getNodesByTags in interface ResourceManager

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

removeNodeToken

public void removeNodeToken(String nodeUrl,
                            String token)
                     throws org.ow2.proactive.resourcemanager.exception.RMException

Description copied from interface: ResourceManager

Remove a token from the given node

Specified by:

removeNodeToken in interface ResourceManager

Parameters:

nodeUrl - url of the node

token - token to remove

Throws:

org.ow2.proactive.resourcemanager.exception.RMException

setNodeTokens

public void setNodeTokens(String nodeUrl,
                          List<String> tokens)
                   throws org.ow2.proactive.resourcemanager.exception.RMException

Description copied from interface: ResourceManager

Overwrite the tokens list associated with the given node

Specified by:

setNodeTokens in interface ResourceManager

Parameters:

nodeUrl - url of the node

tokens - list of tokens

Throws:

org.ow2.proactive.resourcemanager.exception.RMException

checkNodePermission

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

Description copied from interface: ResourceManager

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

Specified by:

checkNodePermission in interface ResourceManager

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

See Also:

ResourceManager.checkNodePermission(String, boolean)

checkNodeSourcePermission

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

Description copied from interface: ResourceManager

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

Specified by:

checkNodeSourcePermission in interface ResourceManager

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

See Also:

ResourceManager.checkNodeSourcePermission(String, boolean)