org.ow2.proactive.resourcemanager.common.util

Class RMProxyUserInterface

java.lang.Object

org.ow2.proactive.resourcemanager.frontend.RMGroupEventListener

org.ow2.proactive.resourcemanager.common.util.RMListenerProxy

org.ow2.proactive.resourcemanager.common.util.RMProxyUserInterface

All Implemented Interfaces:

ServiceUsingPermission, ResourceManager, RMEventListener

public class RMProxyUserInterface
extends RMListenerProxy
implements ResourceManager

This class implements an active object managing a connection to the Resource Manager (a proxy to the Resource Manager) You must init the proxy by calling the RMListenerProxy.init(String, Credentials) method after having created it

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RMProxyUserInterface.MBeanAttributeType Enum of managed MBean attribute types Convert a String MBean attribute value to Object

Field Summary

Fields inherited from class org.ow2.proactive.resourcemanager.common.util.RMListenerProxy

counter, credentials, jmxClient, logger, MONITORING_INTERFACE_TIMEOUT, nodeConnector, nodeConnectorUrl, rmAuth, rmInitialState, RMstate, target

Constructor Summary

Constructors

Constructor and Description
RMProxyUserInterface()

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 arg0) Adds an existing node to the default node source of the resource manager.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	addNode(String arg0, String arg1) 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
boolean	checkPermission(String method) Checks if the current user is allowed to execute the provided method
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	createNodeSource(String arg0, String arg1, Object[] arg2, String arg3, Object[] arg4, boolean arg5)
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	defineNodeSource(String arg0, String arg1, Object[] arg2, String arg3, Object[] arg4, boolean arg5) Defines a new node source in the resource manager.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	deployNodeSource(String arg0) Start acquiring the nodes of a node source that has been defined before.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	editNodeSource(String arg0, String arg1, Object[] arg2, String arg3, Object[] arg4, boolean arg5) 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 arg0, List<SelectionScript> arg1, NodeSet arg2) Finds "number" nodes for computations according to the selection scripts (node must be complaint to all scripts).
NodeSet	getAtMostNodes(int arg0, SelectionScript arg1) Finds "number" nodes for computations according to the selection script.
NodeSet	getAtMostNodes(int arg0, SelectionScript arg1, NodeSet arg2) Finds "number" nodes for computations according to the selection script.
NodeSet	getAtMostNodes(int number, TopologyDescriptor descriptor, List<SelectionScript> selectionScriptsList, 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.
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
AttributeList	getMBeanAttributes(ObjectName name, String[] attributes) returns a list of attributes whose names come from attributes of the MBean with the name name
MBeanInfo	getMBeanInfo(ObjectName name) MBeanInfo object of the mbean represented by its objectname name
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 arg0) 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 arg0) 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 arg0) Releases the node after computations.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	releaseNodes(NodeSet arg0) Releases nodes after computations.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	removeNode(String arg0, boolean arg1) Removes a node from the resource manager.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	removeNodeSource(String arg0, boolean arg1) Remove a node source from the RM.
void	removeNodeToken(String nodeUrl, String token) Remove a token from the given node
void	setMBeanAttribute(ObjectName objectName, String type, String name, String value) Set a single JMX attribute of the MBean objectName.
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 arg0, String arg1) 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 arg0) Initiate the shutdowns the resource manager.
org.objectweb.proactive.core.util.wrapper.BooleanWrapper	undeployNodeSource(String arg0, boolean arg1) 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 arg0, String arg1, Object[] arg2, String arg3, Object[] arg4) Update the infrastructure or policy parameters of a node source that marked with 'dynamic'.

Methods inherited from class org.ow2.proactive.resourcemanager.common.util.RMListenerProxy

disconnect, getNodeMBeanHistory, getNodeMBeanInfo, getNodeMBeansHistory, getNodeMBeansInfo, getRMStateDelta, getRMStateFull, init, init, nodeEvent, nodeSourceEvent, rmEvent

Methods inherited from class org.ow2.proactive.resourcemanager.frontend.RMGroupEventListener

notify

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ow2.proactive.resourcemanager.frontend.ResourceManager

disconnect

Constructor Detail

RMProxyUserInterface

public RMProxyUserInterface()

Method Detail

addNode

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

Description copied from interface: ResourceManager

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

Specified by:

addNode in interface ResourceManager

Parameters:

arg0 - URL of the node to add.

Returns:

true if new node is added successfully, runtime exception otherwise

See Also:

ResourceManager.addNode(java.lang.String)

addNode

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper addNode(String arg0,
                                                                        String arg1)

Description copied from interface: ResourceManager

Adds an existing node to the particular node source.

Specified by:

addNode in interface ResourceManager

Parameters:

arg0 - URL of the node to add.

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

Returns:

true if new node is added successfully, runtime exception otherwise

See Also:

ResourceManager.addNode(java.lang.String, java.lang.String)

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

getExistingNodeSourcesList

public List<RMNodeSourceEvent> getExistingNodeSourcesList()

Description copied from interface: ResourceManager

Returns the list of existing node source infrastructures

Specified by:

getExistingNodeSourcesList in interface ResourceManager

Returns:

the list of existing node source infrastructures

defineNodeSource

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper defineNodeSource(String arg0,
                                                                                 String arg1,
                                                                                 Object[] arg2,
                                                                                 String arg3,
                                                                                 Object[] arg4,
                                                                                 boolean arg5)

Description copied from interface: ResourceManager

Defines a new node source in the resource manager.

Specified by:

defineNodeSource in interface ResourceManager

Parameters:

arg0 - the name of the node source

arg1 - type of the underlying infrastructure

arg2 - parameters for infrastructure creation

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

arg4 - parameters for policy creation

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

See Also:

ResourceManager.defineNodeSource(String, String, Object[], String, Object[], boolean)

editNodeSource

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper editNodeSource(String arg0,
                                                                               String arg1,
                                                                               Object[] arg2,
                                                                               String arg3,
                                                                               Object[] arg4,
                                                                               boolean arg5)

Description copied from interface: ResourceManager

Edit an existing node source in the resource manager.

Specified by:

editNodeSource in interface ResourceManager

Parameters:

arg0 - the name of the node source to edit

arg1 - type of the underlying infrastructure

arg2 - parameters for infrastructure creation

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

arg4 - parameters for policy creation

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

Returns:

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

See Also:

ResourceManager.editNodeSource(String, String, Object[], String, Object[], boolean)

updateDynamicParameters

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper updateDynamicParameters(String arg0,
                                                                                        String arg1,
                                                                                        Object[] arg2,
                                                                                        String arg3,
                                                                                        Object[] arg4)

Description copied from interface: ResourceManager

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:

arg0 - the name of the node source

arg1 - type of the underlying infrastructure

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

arg3 - name of the policy type

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

Returns:

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

See Also:

ResourceManager.updateDynamicParameters(String, String, Object[], String, Object[])

createNodeSource

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper createNodeSource(String arg0,
                                                                                 String arg1,
                                                                                 Object[] arg2,
                                                                                 String arg3,
                                                                                 Object[] arg4,
                                                                                 boolean arg5)

Specified by:

createNodeSource in interface ResourceManager

Parameters:

arg0 - the name of the node source

arg1 - type of the underlying infrastructure

arg2 - parameters for infrastructure creation

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

arg4 - parameters for policy creation

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

See Also:

ResourceManager.createNodeSource(String, String, Object[], String, Object[], boolean)

deployNodeSource

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

Description copied from interface: ResourceManager

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:

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

See Also:

ResourceManager.deployNodeSource(String)

undeployNodeSource

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper undeployNodeSource(String arg0,
                                                                                   boolean arg1)

Description copied from interface: ResourceManager

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:

arg0 - the name of the node source to undeploy

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

See Also:

ResourceManager.undeployNodeSource(String, boolean)

getAtMostNodes

public NodeSet getAtMostNodes(int arg0,
                              SelectionScript arg1)

Description copied from interface: ResourceManager

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:

arg0 - the number of nodes

arg1 - criterion to be verified by the returned nodes

Returns:

a list of nodes

See Also:

ResourceManager.getAtMostNodes(int, org.ow2.proactive.scripting.SelectionScript)

getAtMostNodes

public NodeSet getAtMostNodes(int arg0,
                              SelectionScript arg1,
                              NodeSet arg2)

Description copied from interface: ResourceManager

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:

arg0 - the number of nodes

arg1 - criterion to be verified by the returned nodes

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

Returns:

a list of nodes

See Also:

ResourceManager.getAtMostNodes(int, org.ow2.proactive.scripting.SelectionScript, org.ow2.proactive.utils.NodeSet)

getAtMostNodes

public NodeSet getAtMostNodes(int arg0,
                              List<SelectionScript> arg1,
                              NodeSet arg2)

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:

arg0 - the number of nodes

arg1 - criteria to be verified by the returned nodes

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

Returns:

a list of nodes

See Also:

ResourceManager.getAtMostNodes(int, java.util.List, org.ow2.proactive.utils.NodeSet)

getMonitoring

public RMMonitoring getMonitoring()

Description copied from interface: ResourceManager

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

Specified by:

getMonitoring in interface ResourceManager

Returns:

the resource manager monitoring interface

See Also:

ResourceManager.getMonitoring()

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

getNodeSourcePingFrequency

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

Description copied from interface: ResourceManager

Returns the ping frequency of a node source.

Specified by:

getNodeSourcePingFrequency in interface ResourceManager

Parameters:

arg0 - name of the node source

Returns:

the ping frequency

See Also:

ResourceManager.getNodeSourcePingFrequency(java.lang.String)

getState

public RMState getState()

Description copied from interface: ResourceManager

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.

See Also:

ResourceManager.getState()

getSupportedNodeSourceInfrastructures

public Collection<PluginDescriptor> getSupportedNodeSourceInfrastructures()

Description copied from interface: ResourceManager

Returns the list of supported node source infrastructures descriptors.

Specified by:

getSupportedNodeSourceInfrastructures in interface ResourceManager

Returns:

the list of supported node source infrastructures descriptors

See Also:

ResourceManager.getSupportedNodeSourceInfrastructures()

getSupportedNodeSourcePolicies

public Collection<PluginDescriptor> getSupportedNodeSourcePolicies()

Description copied from interface: ResourceManager

Returns the list of supported node source policies descriptors.

Specified by:

getSupportedNodeSourcePolicies in interface ResourceManager

Returns:

the list of supported node source policies descriptors

See Also:

ResourceManager.getSupportedNodeSourcePolicies()

getNodeSourceConfiguration

public NodeSourceConfiguration getNodeSourceConfiguration(String nodeSourceName)

Description copied from interface: ResourceManager

Returns the current configuration of a node source.

Specified by:

getNodeSourceConfiguration in interface ResourceManager

See Also:

ResourceManager.getNodeSourceConfiguration(String)

isActive

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

Description copied from interface: ResourceManager

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

See Also:

ResourceManager.isActive()

nodeIsAvailable

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

Description copied from interface: ResourceManager

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

Specified by:

nodeIsAvailable in interface ResourceManager

Parameters:

arg0 - of node to ping.

Returns:

true if the node nodeUrl is registered and not down.

See Also:

ResourceManager.nodeIsAvailable(java.lang.String)

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.

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

releaseNode

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

Description copied from interface: ResourceManager

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:

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

See Also:

ResourceManager.releaseNode(org.objectweb.proactive.core.node.Node)

releaseNodes

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

Description copied from interface: ResourceManager

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

Specified by:

releaseNodes in interface ResourceManager

Parameters:

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

See Also:

ResourceManager.releaseNodes(org.ow2.proactive.utils.NodeSet)

removeNode

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper removeNode(String arg0,
                                                                           boolean arg1)

Description copied from interface: ResourceManager

Removes a node from the resource manager.

Specified by:

removeNode in interface ResourceManager

Parameters:

arg0 - URL of the node to remove.

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

See Also:

ResourceManager.removeNode(java.lang.String, boolean)

removeNodeSource

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper removeNodeSource(String arg0,
                                                                                 boolean arg1)

Description copied from interface: ResourceManager

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

Specified by:

removeNodeSource in interface ResourceManager

Parameters:

arg0 - name of the source to remove.

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

See Also:

ResourceManager.removeNodeSource(java.lang.String, boolean)

setNodeSourcePingFrequency

public org.objectweb.proactive.core.util.wrapper.BooleanWrapper setNodeSourcePingFrequency(int arg0,
                                                                                           String arg1)

Description copied from interface: ResourceManager

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:

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

arg1 - name of the node source to set the frequency

Returns:

true if ping frequency is successfully changed, runtime exception otherwise

See Also:

ResourceManager.setNodeSourcePingFrequency(int, java.lang.String)

shutdown

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

Description copied from interface: ResourceManager

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.

Specified by:

shutdown in interface ResourceManager

Returns:

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

See Also:

ResourceManager.shutdown(boolean)

getAtMostNodes

public NodeSet getAtMostNodes(int number,
                              TopologyDescriptor descriptor,
                              List<SelectionScript> selectionScriptsList,
                              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

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:

ResourceManager.getAtMostNodes(int, org.ow2.proactive.topology.descriptor.TopologyDescriptor, java.util.List, org.ow2.proactive.utils.NodeSet)

getTopology

public Topology getTopology()

Description copied from interface: ResourceManager

Returns the topology information of nodes.

Specified by:

getTopology in interface ResourceManager

Returns:

nodes topology

See Also:

ResourceManager.getTopology()

lockNodes

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

Description copied from interface: ResourceManager

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.

See Also:

ResourceManager.lockNodes(java.util.Set)

unlockNodes

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

Description copied from interface: ResourceManager

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.

See Also:

ResourceManager.unlockNodes(java.util.Set)

getMBeanInfo

public MBeanInfo getMBeanInfo(ObjectName name)
                       throws InstanceNotFoundException,
                              IntrospectionException,
                              ReflectionException,
                              IOException

MBeanInfo object of the mbean represented by its objectname name

Parameters:

name - the objectname of the mbean

Returns:

the MBeanInfo of the mbean

Throws:

InstanceNotFoundException

IntrospectionException

ReflectionException

IOException

getMBeanAttributes

public AttributeList getMBeanAttributes(ObjectName name,
                                        String[] attributes)
                                 throws InstanceNotFoundException,
                                        IntrospectionException,
                                        ReflectionException,
                                        IOException

returns a list of attributes whose names come from attributes of the MBean with the name name

Parameters:

name - the object name of the mbean

attributes - the names of the request attributes

Returns:

an AttributeList with all the requested attributes

Throws:

InstanceNotFoundException

IntrospectionException

ReflectionException

IOException

setMBeanAttribute

public void setMBeanAttribute(ObjectName objectName,
                              String type,
                              String name,
                              String value)
                       throws InstanceNotFoundException,
                              IntrospectionException,
                              ReflectionException,
                              IOException,
                              MBeanException,
                              InvalidAttributeValueException,
                              AttributeNotFoundException,
                              IllegalArgumentException

Set a single JMX attribute of the MBean objectName. Only integer and string attributes are currently supported, see type.

Parameters:

objectName - the object name of the MBean

type - the type of the attribute to set ('integer' and 'string' are currently supported, see RMProxyUserInterface)

name - the name of the attribute to set

value - the new value of the attribute (defined as a String, it is automatically converted according to type)

Throws:

InstanceNotFoundException

IntrospectionException

ReflectionException

IOException

MBeanException

InvalidAttributeValueException

AttributeNotFoundException

IllegalArgumentException

isNodeAdmin

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

Description copied from interface: ResourceManager

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)

Description copied from interface: ResourceManager

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 <T> List<ScriptResult<T>> executeScript(Script<T> script,
                                               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.

targetType - must be either NODE_URL, NODESOURCE_NAME or HOSTNAME

targets - are names of particular resources

Returns:

the ScriptResult corresponding to the script execution.

getNodes

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

Deprecated.

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

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

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

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.

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

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:

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

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

addNodeToken

public void addNodeToken(String nodeUrl,
                         String token)
                  throws 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:

RMException

removeNodeToken

public void removeNodeToken(String nodeUrl,
                            String token)
                     throws 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:

RMException

setNodeTokens

public void setNodeTokens(String nodeUrl,
                          List<String> tokens)
                   throws 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:

RMException

getNodeTokens

public List<String> getNodeTokens(String nodeUrl)
                           throws 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:

RMException

getAllNodesTokens

public Map<String,List<String>> getAllNodesTokens()
                                           throws 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:

RMException

getAllEligibleNodesTokens

public Map<String,List<String>> getAllEligibleNodesTokens()
                                                   throws 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:

RMException

getNodeTags

public Set<String> getNodeTags(String nodeUrl)
                        throws 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:

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

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)

checkPermission

public boolean checkPermission(String method)
                        throws SecurityException

Description copied from interface: ServiceUsingPermission

Checks if the current user is allowed to execute the provided method

Specified by:

checkPermission in interface ServiceUsingPermission

Parameters:

method - method name

Returns:

true if authorization is successful

Throws:

SecurityException - if the user is not allowed to execute this method