RMNodeClient (scheduling 13.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.resourcemanager.task.client.RMNodeClient

All Implemented Interfaces:: Serializable, IRMClient

@PublicAPI
public class RMNodeClient
extends Object
implements IRMClient, Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

RMNodeClient(CredData userCreds, String schedulerRestUrl)

Constructors
Constructor and Description
`RMNodeClient(CredData userCreds, String schedulerRestUrl)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Set<String>`	`acquireNodes(String sourceName, int numberNodes, boolean synchronous, long timeout, String nodeConfigJson)` Acquire new nodes of a specified node source
`boolean`	`addNode(String url, String nodesource)` Adds an existing node to the particular node source.
`void`	`addNodeToken(String nodeUrl, String token)` Add access token to given node
`void`	`connect()`
`void`	`connect(String url)`
`NSState`	`createNodeSource(String nodeSourceName, String infrastructureType, String[] infrastructureParameters, String[] infrastructureFileParameters, String policyType, String[] policyParameters, String[] policyFileParameters)` Deprecated. As of version 8.1, replaced by `defineNodeSource(String, String, String[], String[], String, String[], String[], String)` and `deployNodeSource(String)`
`NSState`	`createNodeSource(String nodeSourceName, String infrastructureType, String[] infrastructureParameters, String[] infrastructureFileParameters, String policyType, String[] policyParameters, String[] policyFileParameters, String nodesRecoverable)` Deprecated. As of version 8.1, replaced by `defineNodeSource(String,String, String[], String[], String, String[], String[], String)` and `deployNodeSource(String)` Create a NodeSource
`NSState`	`defineNodeSource(String nodeSourceName, String infrastructureType, String[] infrastructureParameters, String[] infrastructureFileParameters, String policyType, String[] policyParameters, String[] policyFileParameters, String nodesRecoverable)`
`NSState`	`deployNodeSource(String nodeSourceName)` Start the nodes acquisition of the node source
`void`	`disconnect()` Disconnects from resource manager and releases all the nodes taken by user for computations.
`NSState`	`editNodeSource(String nodeSourceName, String infrastructureType, String[] infrastructureParameters, String[] infrastructureFileParameters, String policyType, String[] policyParameters, String[] policyFileParameters, String nodesRecoverable)`
`ScriptResult<Object>`	`executeHostScript(String host, String script, String scriptEngine)`
`ScriptResult<Object>`	`executeNodeScript(String nodeUrl, String script, String scriptEngine)`
`List<ScriptResult<Object>>`	`executeNodeSourceScript(String nodeSource, String script, String scriptEngine)`
`ConnectionInfo`	`getConnectionInfo()` Returns the connection info, if initialized previously
`List<RMNodeSourceEvent>`	`getExistingNodeSources()`
`Map<String,List<String>>`	`getInfrasToPoliciesMapping()`
`Object`	`getMBeanInfo(ObjectName name, List<String> attrs)` Returns the attributes `attr` of the mbean registered as `name`.
`String`	`getNodeMBeanHistory(String nodeJmxUrl, String objectName, List<String> attrs, String range)` Return the statistic history contained in the node RRD database, without redundancy, in a friendly JSON format.
`Object`	`getNodeMBeanInfo(String nodeJmxUrl, String objectName, List<String> attrs)` Retrieves attributes of the specified mbean.
`Object`	`getNodeMBeansHistory(String nodeJmxUrl, String objectNames, List<String> attrs, String range)`
`Object`	`getNodeMBeansInfo(String nodeJmxUrl, String objectNames, List<String> attrs)` Retrieves attributes of the specified mbeans.
`Map<String,Map<String,Map<String,List<RMNodeHistory>>>>`	`getNodesHistory(long windowStart, long windowEnd)`
`Map<String,Map<String,Object>>`	`getNodesMBeanHistory(List<String> nodesJmxUrl, String objectName, List<String> attrs, String range)` Return the statistic history of a list of nodes contained in the node RRD database, without redundancy, in a friendly JSON format.
`NodeSourceConfiguration`	`getNodeSourceConfiguration(String nodeSourceName)`
`int`	`getNodeSourcePingFrequency(String sourceName)` Returns the ping frequency of a node source
`String`	`getNodeThreadDump(String nodeUrl)`
`RMStateDelta`	`getRMStateDelta(String clientCounter)` Returns difference between current state of the resource manager and state that the client is aware of.
`RMStateFull`	`getRMStateFull()` Returns the full state of the RM, which does not include REMOVED node/nodesources
`String`	`getRMThreadDump()`
`String`	`getSession()` Retrieves the current session identifier, or null if the session was not initialized yet.
`RMState`	`getState()`
`String`	`getStatHistory(String range)` Return the statistic history contained in the RM's RRD database, without redundancy, in a friendly JSON format.
`Collection<PluginDescriptorData>`	`getSupportedNodeSourceInfrastructures()`
`Collection<PluginDescriptorData>`	`getSupportedNodeSourcePolicies()`
`TopologyData`	`getTopology()`
`String`	`getVersion()`
`void`	`init(ConnectionInfo connectionInfo)` Initialize this instance.
`boolean`	`isActive()`
`boolean`	`lockNodes(Set<String> nodeUrls)` prevent other users from using a set of locked nodes
`boolean`	`nodeIsAvailable(String url)`
`boolean`	`releaseNode(String url)` Release a node
`boolean`	`removeNode(String nodeUrl, boolean preempt)` Delete a node
`boolean`	`removeNodeSource(String sourceName, boolean preempt)` Delete a nodesource
`void`	`removeNodeToken(String nodeUrl, String token)` Remove access token from given node
`void`	`setMBeanInfo(ObjectName name, String type, String attr, String value)` Set a single JMX attribute of the MBean `name`.
`void`	`setNodeTokens(String nodeUrl, List<String> tokens)` Set all node tokens to given node
`void`	`setSession(String sid)` Sets the session identifier explicitly.
`boolean`	`shutdown(boolean preempt)` Initiate the shutdowns the resource manager.
`NSState`	`undeployNodeSource(String nodeSourceName, boolean preempt)` Remove the nodes of the node source and keep the node source undeployed
`boolean`	`unlockNodes(Set<String> nodeUrls)` allow other users to use a set of previously locked nodes
`NSState`	`updateDynamicParameters(String nodeSourceName, String infrastructureType, String[] infrastructureParameters, String[] infrastructureFileParameters, String policyType, String[] policyParameters, String[] policyFileParameters)`

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

Constructor Detail

RMNodeClient

public RMNodeClient(CredData userCreds,
                    String schedulerRestUrl)

Method Detail

connect

public void connect()
             throws Exception

Throws:: Exception

connect

public void connect(String url)
             throws Exception

Throws:: Exception

init
```
public void init(ConnectionInfo connectionInfo)
          throws Exception
```
Description copied from interface: IRMClient

Initialize this instance.

Specified by:

init in interface IRMClient

Parameters:

connectionInfo - various info about the connection attempt

Throws:

Exception - if an error occurs during the initialization

getConnectionInfo
```
public ConnectionInfo getConnectionInfo()
```
Description copied from interface: IRMClient

Returns the connection info, if initialized previously

Specified by:

getConnectionInfo in interface IRMClient

Returns:

the connection info

setSession
```
public void setSession(String sid)
```
Description copied from interface: IRMClient

Sets the session identifier explicitly. This might run on an uninitialized client.

Specified by:

setSession in interface IRMClient

Parameters:

sid - session identifier

getSession
```
public String getSession()
```
Description copied from interface: IRMClient

Retrieves the current session identifier, or null if the session was not initialized yet.

Specified by:

getSession in interface IRMClient

Returns:

the current session identifier if initialize, null otherwise

disconnect
```
public void disconnect()
                throws NotConnectedException
```
Disconnects from resource manager and releases all the nodes taken by user for computations.

Throws:

NotConnectedException

getState
```
public RMState getState()
                 throws NotConnectedException
```
Returns:

Returns the state of the Resource Manager

Throws:

NotConnectedException

getRMStateDelta
```
public RMStateDelta getRMStateDelta(String clientCounter)
                             throws NotConnectedException,
                                    PermissionRestException
```
Returns difference between current state of the resource manager and state that the client is aware of. Each event that changes state fo the RM has counter assosiacted to it. Thus client has to provide 'latestCounter', i.e. latest event he is aware of.

Parameters:

clientCounter - (optional) is the latest counter client has, if parameter is not provided then method returns all events

Returns:

the difference between current state and state that client knows

Throws:

NotConnectedException

PermissionRestException

getRMStateFull
```
public RMStateFull getRMStateFull()
                           throws NotConnectedException,
                                  PermissionRestException
```
Returns the full state of the RM, which does not include REMOVED node/nodesources

Returns:

the state of the RM, which does not include REMOVED node/nodesources

Throws:

NotConnectedException

PermissionRestException

isActive
```
public boolean isActive()
                 throws NotConnectedException
```
Returns:

true if the resource manager is operational.

Throws:

NotConnectedException

addNode
```
public boolean addNode(String url,
                       String nodesource)
                throws NotConnectedException
```
Adds an existing node to the particular node source.

Parameters:

url - the url of the node

nodesource - the node source, can be null

Returns:

true if new node is added successfully, runtime exception otherwise

Throws:

NotConnectedException

acquireNodes
```
public Set<String> acquireNodes(String sourceName,
                                int numberNodes,
                                boolean synchronous,
                                long timeout,
                                String nodeConfigJson)
                         throws NotConnectedException,
                                RestException
```
Acquire new nodes of a specified node source

Parameters:

sourceName - the name of the node source

numberNodes - the number of nodes to be acquired

synchronous - whether the request is synchronous or asynchronous, when true, the request returns the url of acquired nodes after the nodes are successfully deployed.

timeout - the maximum duration of the request, in seconds.

nodeConfigJson - the specific configuration of nodes to be acquired, in json format

Returns:

When synchronous is true, returns the url of acquired nodes after the nodes are successfully deployed. When synchronous is false, returns immediately with an empty list.

Throws:

NotConnectedException

RestException

nodeIsAvailable
```
public boolean nodeIsAvailable(String url)
                        throws NotConnectedException
```
Parameters:

url - the url of the node

Returns:

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

Throws:

NotConnectedException

getExistingNodeSources

public List<RMNodeSourceEvent> getExistingNodeSources()
                                               throws NotConnectedException,
                                                      PermissionRestException

Returns:: list of existing Node Sources
Throws:: NotConnectedException; PermissionRestException

defineNodeSource

public NSState defineNodeSource(String nodeSourceName,
                                String infrastructureType,
                                String[] infrastructureParameters,
                                String[] infrastructureFileParameters,
                                String policyType,
                                String[] policyParameters,
                                String[] policyFileParameters,
                                String nodesRecoverable)
                         throws NotConnectedException

Throws:: NotConnectedException

editNodeSource

public NSState editNodeSource(String nodeSourceName,
                              String infrastructureType,
                              String[] infrastructureParameters,
                              String[] infrastructureFileParameters,
                              String policyType,
                              String[] policyParameters,
                              String[] policyFileParameters,
                              String nodesRecoverable)
                       throws NotConnectedException

Throws:: NotConnectedException

updateDynamicParameters

public NSState updateDynamicParameters(String nodeSourceName,
                                       String infrastructureType,
                                       String[] infrastructureParameters,
                                       String[] infrastructureFileParameters,
                                       String policyType,
                                       String[] policyParameters,
                                       String[] policyFileParameters)
                                throws NotConnectedException,
                                       PermissionRestException

Throws:: NotConnectedException; PermissionRestException

createNodeSource

public NSState createNodeSource(String nodeSourceName,
                                String infrastructureType,
                                String[] infrastructureParameters,
                                String[] infrastructureFileParameters,
                                String policyType,
                                String[] policyParameters,
                                String[] policyFileParameters)
                         throws NotConnectedException,
                                PermissionRestException

Deprecated. As of version 8.1, replaced by

defineNodeSource(String, String, String[], String[],
 String, String[], String[], String)

and deployNodeSource(String)

Throws:: NotConnectedException; PermissionRestException

createNodeSource
```
public NSState createNodeSource(String nodeSourceName,
                                String infrastructureType,
                                String[] infrastructureParameters,
                                String[] infrastructureFileParameters,
                                String policyType,
                                String[] policyParameters,
                                String[] policyFileParameters,
                                String nodesRecoverable)
                         throws NotConnectedException
```
Deprecated. As of version 8.1, replaced by defineNodeSource(String,String, String[], String[], String, String[], String[], String) and deployNodeSource(String) Create a NodeSource

Parameters:

nodeSourceName - name of the node source to create

infrastructureType - fully qualified class name of the infrastructure to create

infrastructureParameters - String parameters of the infrastructure, without the parameters containing files or credentials

infrastructureFileParameters - File or credential parameters

policyType - fully qualified class name of the policy to create

policyParameters - String parameters of the policy, without the parameters containing files or credentials

policyFileParameters - File or credential parameters

nodesRecoverable - Whether the nodes can be recovered after a crash of the RM

Returns:

true if a node source has been created

Throws:

NotConnectedException

deployNodeSource
```
public NSState deployNodeSource(String nodeSourceName)
                         throws NotConnectedException,
                                PermissionRestException
```
Start the nodes acquisition of the node source

Parameters:

nodeSourceName - the name of the node source to start

Returns:

the result of the action, possibly containing the error message

Throws:

NotConnectedException

PermissionRestException

undeployNodeSource
```
public NSState undeployNodeSource(String nodeSourceName,
                                  boolean preempt)
                           throws NotConnectedException,
                                  PermissionRestException
```
Remove the nodes of the node source and keep the node source undeployed

Parameters:

nodeSourceName - the name of the node source to undeploy

Returns:

the result of the action, possibly containing the error message

Throws:

NotConnectedException

PermissionRestException

getNodeSourcePingFrequency

public int getNodeSourcePingFrequency(String sourceName)
                               throws NotConnectedException,
                                      PermissionRestException

Returns the ping frequency of a node source

Parameters:: sourceName - a node source
Returns:: the ping frequency
Throws:: NotConnectedException; PermissionRestException

releaseNode

public boolean releaseNode(String url)
                    throws RMNodeException,
                           NotConnectedException,
                           PermissionRestException

Release a node

Parameters:: url - node's URL
Returns:: true of the node has been released
Throws:: RMNodeException; NotConnectedException; PermissionRestException

removeNode
```
public boolean removeNode(String nodeUrl,
                          boolean preempt)
                   throws NotConnectedException,
                          PermissionRestException
```
Delete a node

Parameters:

nodeUrl - node's URL

preempt - if true remove node source immediatly whithout waiting for nodes to be freed

Returns:

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

Throws:

NotConnectedException

PermissionRestException

removeNodeSource
```
public boolean removeNodeSource(String sourceName,
                                boolean preempt)
                         throws NotConnectedException,
                                PermissionRestException
```
Delete a nodesource

Parameters:

sourceName - a node source

preempt - if true remove node source immediatly whithout waiting for nodes to be freed

Returns:

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

Throws:

NotConnectedException

PermissionRestException

lockNodes
```
public boolean lockNodes(Set<String> nodeUrls)
                  throws NotConnectedException,
                         PermissionRestException
```
prevent other users from using a set of locked nodes

Parameters:

nodeUrls - set of node urls to lock

Returns:

true when all nodes were free and have been locked

Throws:

NotConnectedException

PermissionRestException

unlockNodes
```
public boolean unlockNodes(Set<String> nodeUrls)
                    throws NotConnectedException,
                           PermissionRestException
```
allow other users to use a set of previously locked nodes

Parameters:

nodeUrls - set of node urls to unlock

Returns:

true when all nodes were locked and have been unlocked

Throws:

NotConnectedException

PermissionRestException

getNodeMBeanInfo

public Object getNodeMBeanInfo(String nodeJmxUrl,
                               String objectName,
                               List<String> attrs)
                        throws InstanceNotFoundException,
                               IntrospectionException,
                               ReflectionException,
                               IOException,
                               NotConnectedException,
                               MalformedObjectNameException,
                               NullPointerException,
                               PermissionRestException

Retrieves attributes of the specified mbean.

Parameters:: nodeJmxUrl - mbean server url; objectName - name of mbean; attrs - set of mbean attributes
Returns:: mbean attributes values
Throws:: InstanceNotFoundException; IntrospectionException; ReflectionException; IOException; NotConnectedException; MalformedObjectNameException; NullPointerException; PermissionRestException

getNodeMBeanHistory

public String getNodeMBeanHistory(String nodeJmxUrl,
                                  String objectName,
                                  List<String> attrs,
                                  String range)
                           throws InstanceNotFoundException,
                                  IntrospectionException,
                                  ReflectionException,
                                  IOException,
                                  NotConnectedException,
                                  MalformedObjectNameException,
                                  NullPointerException,
                                  MBeanException

Return the statistic history contained in the node RRD database, without redundancy, in a friendly JSON format.

Parameters:

nodeJmxUrl - mbean server url

objectName - name of mbean

attrs - set of mbean attributes

range - a String of 5 chars, one for each stat history source, indicating the time range to fetch for each source. Each char can be:

'a' 1 minute
'n' 5 minutes
'm' 10 minutes
't' 30 minutes
'h' 1 hour
'j' 2 hours
'k' 4 hours
'H' 8 hours
'd' 1 day
'w' 1 week
'M' 1 month
'y' 1 year

Returns:

a JSON object containing a key for each source

Throws:

InstanceNotFoundException

IntrospectionException

ReflectionException

IOException

NotConnectedException

MalformedObjectNameException

NullPointerException

MBeanException

getNodesMBeanHistory

public Map<String,Map<String,Object>> getNodesMBeanHistory(List<String> nodesJmxUrl,
                                                           String objectName,
                                                           List<String> attrs,
                                                           String range)
                                                    throws InstanceNotFoundException,
                                                           IntrospectionException,
                                                           ReflectionException,
                                                           IOException,
                                                           NotConnectedException,
                                                           MalformedObjectNameException,
                                                           NullPointerException,
                                                           MBeanException

Return the statistic history of a list of nodes contained in the node RRD database, without redundancy, in a friendly JSON format.

Parameters:

nodesJmxUrl - a set of mbean server urls

objectName - name of mbean

attrs - set of mbean attributes

range - a String of 5 chars, one for each stat history source, indicating the time range to fetch for each source. Each char can be:

'a' 1 minute
'n' 5 minutes
'm' 10 minutes
't' 30 minutes
'h' 1 hour
'j' 2 hours
'k' 4 hours
'H' 8 hours
'd' 1 day
'w' 1 week
'M' 1 month
'y' 1 year

Returns:

a Map where each entry containse mbean server url as key and a map of statistic values as value. Each entry has an mbean attribute as key and list of its mbean values as value.

Throws:

InstanceNotFoundException

IntrospectionException

ReflectionException

IOException

NotConnectedException

MalformedObjectNameException

NullPointerException

MBeanException

getNodeMBeansInfo

public Object getNodeMBeansInfo(String nodeJmxUrl,
                                String objectNames,
                                List<String> attrs)
                         throws InstanceNotFoundException,
                                IntrospectionException,
                                ReflectionException,
                                IOException,
                                NotConnectedException,
                                MalformedObjectNameException,
                                NullPointerException,
                                PermissionRestException

Retrieves attributes of the specified mbeans.

Parameters:: objectNames - mbean names (@see ObjectName format); nodeJmxUrl - mbean server url; attrs - set of mbean attributes
Returns:: mbean attributes values
Throws:: InstanceNotFoundException; IntrospectionException; ReflectionException; IOException; NotConnectedException; MalformedObjectNameException; NullPointerException; PermissionRestException

getNodeMBeansHistory

public Object getNodeMBeansHistory(String nodeJmxUrl,
                                   String objectNames,
                                   List<String> attrs,
                                   String range)
                            throws InstanceNotFoundException,
                                   IntrospectionException,
                                   ReflectionException,
                                   IOException,
                                   NotConnectedException,
                                   MalformedObjectNameException,
                                   NullPointerException,
                                   MBeanException,
                                   PermissionRestException

Throws:: InstanceNotFoundException; IntrospectionException; ReflectionException; IOException; NotConnectedException; MalformedObjectNameException; NullPointerException; MBeanException; PermissionRestException

shutdown
```
public boolean shutdown(boolean preempt)
                 throws NotConnectedException,
                        PermissionRestException
```
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.

Parameters:

preempt - if true shutdown immediatly whithout waiting for nodes to be freed, default value is false

Returns:

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

Throws:

NotConnectedException

PermissionRestException

getTopology

public TopologyData getTopology()
                         throws NotConnectedException,
                                PermissionRestException

Throws:: NotConnectedException; PermissionRestException

getSupportedNodeSourceInfrastructures

public Collection<PluginDescriptorData> getSupportedNodeSourceInfrastructures()
                                                                       throws NotConnectedException,
                                                                              PermissionRestException

Returns:: the list of supported node source infrastructures descriptors
Throws:: NotConnectedException; PermissionRestException

getInfrasToPoliciesMapping

public Map<String,List<String>> getInfrasToPoliciesMapping()
                                                    throws NotConnectedException,
                                                           PermissionRestException

Returns:: a mapping which for each infrastructure provides list of policies that can work together with given infrastructure
Throws:: NotConnectedException; PermissionRestException

getSupportedNodeSourcePolicies

public Collection<PluginDescriptorData> getSupportedNodeSourcePolicies()
                                                                throws NotConnectedException,
                                                                       PermissionRestException

Returns:: the list of supported node source policies descriptors
Throws:: NotConnectedException; PermissionRestException

getNodeSourceConfiguration

public NodeSourceConfiguration getNodeSourceConfiguration(String nodeSourceName)
                                                   throws NotConnectedException,
                                                          PermissionRestException

Throws:: NotConnectedException; PermissionRestException

getMBeanInfo

public Object getMBeanInfo(ObjectName name,
                           List<String> attrs)
                    throws InstanceNotFoundException,
                           IntrospectionException,
                           ReflectionException,
                           IOException,
                           NotConnectedException,
                           PermissionRestException

Returns the attributes attr of the mbean registered as name.

Parameters:: name - mbean's object name; attrs - attributes to enumerate
Returns:: returns the attributes of the mbean
Throws:: InstanceNotFoundException; IntrospectionException; ReflectionException; IOException; NotConnectedException; PermissionRestException

setMBeanInfo

public void setMBeanInfo(ObjectName name,
                         String type,
                         String attr,
                         String value)
                  throws InstanceNotFoundException,
                         IntrospectionException,
                         ReflectionException,
                         IOException,
                         NotConnectedException,
                         MBeanException,
                         InvalidAttributeValueException,
                         AttributeNotFoundException

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

Parameters:: name - the object name of the MBean; type - the type of the attribute to set ('integer' and 'string' are currently supported, see RMProxyUserInterface); attr - 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; NotConnectedException; MBeanException; InvalidAttributeValueException; AttributeNotFoundException

getStatHistory

public String getStatHistory(String range)
                      throws ReflectionException,
                             InterruptedException,
                             IntrospectionException,
                             NotConnectedException,
                             InstanceNotFoundException,
                             MalformedObjectNameException,
                             IOException

Return the statistic history contained in the RM's RRD database, without redundancy, in a friendly JSON format. The following sources will be queried from the RRD DB :

        { AvailableNodesCount",
        "FreeNodesCount",
        "NeededNodesCount",
        "BusyNodesCount",
        "DeployingNodesCount",
        "ConfigNodesCount",
        "DownNodesCount",
        "LostNodesCount",
        "AverageActivity" };

Parameters:

range - a String of 9 chars, one for each stat history source, indicating the time range to fetch for each source. Each char can be:

'a' 1 minute
'm' 10 minutes
'n' 5 minutes
't' 30 minutes
'h' 1 hour
'j' 2 hours
'k' 4 hours
'H' 8 hours
'd' 1 day
'w' 1 week
'M' 1 month
'y' 1 year

Returns:

a JSON object containing a key for each source

Throws:

ReflectionException

InterruptedException

IntrospectionException

NotConnectedException

InstanceNotFoundException

MalformedObjectNameException

IOException

getVersion
```
public String getVersion()
```
Returns:

returns the version of the rest api

executeNodeScript

public ScriptResult<Object> executeNodeScript(String nodeUrl,
                                              String script,
                                              String scriptEngine)
                                       throws Throwable

Throws:: Throwable

executeNodeSourceScript

public List<ScriptResult<Object>> executeNodeSourceScript(String nodeSource,
                                                          String script,
                                                          String scriptEngine)
                                                   throws Throwable

Throws:: Throwable

executeHostScript

public ScriptResult<Object> executeHostScript(String host,
                                              String script,
                                              String scriptEngine)
                                       throws Throwable

Throws:: Throwable

getRMThreadDump

public String getRMThreadDump()
                       throws NotConnectedException

Throws:: NotConnectedException

getNodeThreadDump

public String getNodeThreadDump(String nodeUrl)
                         throws NotConnectedException

Throws:: NotConnectedException

getNodesHistory

public Map<String,Map<String,Map<String,List<RMNodeHistory>>>> getNodesHistory(long windowStart,
                                                                               long windowEnd)
                                                                        throws NotConnectedException

Throws:: NotConnectedException

addNodeToken

public void addNodeToken(String nodeUrl,
                         String token)
                  throws NotConnectedException,
                         RestException

Add access token to given node

Parameters:: token - single token
Throws:: NotConnectedException; RestException

removeNodeToken

public void removeNodeToken(String nodeUrl,
                            String token)
                     throws NotConnectedException,
                            RestException

Remove access token from given node

Parameters:: token - single token
Throws:: NotConnectedException; RestException

setNodeTokens

public void setNodeTokens(String nodeUrl,
                          List<String> tokens)
                   throws NotConnectedException,
                          RestException

Set all node tokens to given node

Throws:: NotConnectedException; RestException

Class RMNodeClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RMNodeClient

Method Detail

connect

connect

init

getConnectionInfo

setSession

getSession

disconnect

getState

getRMStateDelta

getRMStateFull

isActive

addNode

acquireNodes

nodeIsAvailable

getExistingNodeSources

defineNodeSource

editNodeSource

updateDynamicParameters

createNodeSource

createNodeSource

deployNodeSource

undeployNodeSource

getNodeSourcePingFrequency

releaseNode

removeNode

removeNodeSource

lockNodes

unlockNodes

getNodeMBeanInfo

getNodeMBeanHistory

getNodesMBeanHistory

getNodeMBeansInfo

getNodeMBeansHistory

shutdown

getTopology

getSupportedNodeSourceInfrastructures

getInfrasToPoliciesMapping

getSupportedNodeSourcePolicies

getNodeSourceConfiguration

getMBeanInfo

setMBeanInfo

getStatHistory

getVersion

executeNodeScript

executeNodeSourceScript

executeHostScript

getRMThreadDump

getNodeThreadDump

getNodesHistory

addNodeToken

removeNodeToken

setNodeTokens