Package org.jppf.management.forwarding

Interface JPPFNodeForwardingMBean

All Superinterfaces:
ForwardingNotficationEmitter, NotificationBroadcaster, NotificationEmitter, Serializable
@MBeanNotif(description="notifications emitted by this MBean wrap actual notifications received from the nodes, then are forwarded to the JMX notification listeners whose node selector matches the emitting nodes", notifClass=JPPFNodeForwardingNotification.class) public interface JPPFNodeForwardingMBean extends Serializable, NotificationEmitter, ForwardingNotficationEmitter
Deprecated.
use NodeForwardingMBean insead.
MBean interface for forwarding node management requests and monitoring notfications via the driver.
Author:
Laurent Cohen

  • Field Details

  • Method Details

    • forwardInvoke

      Map<String,Object> forwardInvoke(NodeSelector selector, String name, String methodName, Object[] params, String[] signature) throws Exception
      Deprecated.
      Invoke a method on the specified MBean of the selected nodes attached to the driver.
      Parameters:
      selector - a filter on the nodes attached tot he driver, determines the nodes to which this method applies.
      name - the name of the MBean.
      methodName - the name of the method to invoke.
      params - the method parameter values.
      signature - the types of the method parameters.
      Returns:
      a mapping of node uuids to the result of invoking the MBean method on the corresponding node. Each result may be an exception.
      Additionally, each result may be null, in particular if the invoked method has a void return type.
      Throws:
      Exception - if the invocation failed.

    • forwardInvoke

      Map<String,Object> forwardInvoke(NodeSelector selector, String name, String methodName) throws Exception
      Deprecated.
      Convenience method to invoke an MBean method that has no parameter.
      This is equivalent to calling forwardInvoke(selector, name, methodName, (Object[]) null, (String[]) null).
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      name - the name of the node MBean to invoke.
      methodName - the name of the method to invoke.
      Returns:
      a mapping of node uuids to the result of invoking the MBean method on the corresponding node. Each result may be an exception.
      Additionally, each result may be null, in particular if the invoked method has a void return type.
      Throws:
      Exception - if the invocation failed.

    • forwardGetAttribute

      Map<String,Object> forwardGetAttribute(NodeSelector selector, String name, String attribute) throws Exception
      Deprecated.
      Get the value of an attribute of the specified MBean for each specified node.
      Parameters:
      selector - a filter on the nodes attached tot he driver, determines the nodes to which this method applies.
      name - the name of the MBean to invoke for each node.
      attribute - the name of the MBean attribute to read.
      Returns:
      a mapping of node uuids to the result of getting the MBean attribute on the corresponding node. Each result may be an exception.
      Throws:
      Exception - if the invocation failed.

    • forwardSetAttribute

      Map<String,Object> forwardSetAttribute(NodeSelector selector, String name, String attribute, Object value) throws Exception
      Deprecated.
      Set the value of an attribute of the specified MBean on the specified nodes attached to the driver.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      name - the name of the MBean to invoke for each node.
      attribute - the name of the MBean attribute to set.
      value - the value to set on the attribute.
      Returns:
      a mapping of node uuids to an eventual exception resulting from setting the MBean attribute on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if the invocation failed.

    • state

      Map<String,Object> state(NodeSelector selector) throws Exception
      Deprecated.
      Get the latest state information from the node.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to the result of invoking the MBean method on the corresponding node. Each result may be either a JPPFNodeState object, or an exception if the invocation failed for the corresponding node.
      Throws:
      Exception - if any error occurs.

    • updateThreadPoolSize

      Map<String,Object> updateThreadPoolSize(NodeSelector selector, Integer size) throws Exception
      Deprecated.
      Set the size of the specified nodes' thread pool.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      size - the size as an int.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • updateThreadsPriority

      Map<String,Object> updateThreadsPriority(NodeSelector selector, Integer newPriority) throws Exception
      Deprecated.
      Update the priority of all execution threads for the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      newPriority - the new priority to set.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if an error is raised when invoking the node mbean.

    • restart

      Map<String,Object> restart(NodeSelector selector) throws Exception
      Deprecated.
      Restart the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • restart

      Map<String,Object> restart(NodeSelector selector, Boolean interruptIfRunning) throws Exception
      Deprecated.
      Restart the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      interruptIfRunning - whether to restart immediately or wait until each node is idle.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • shutdown

      Map<String,Object> shutdown(NodeSelector selector) throws Exception
      Deprecated.
      Shutdown the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • shutdown

      Map<String,Object> shutdown(NodeSelector selector, Boolean interruptIfRunning) throws Exception
      Deprecated.
      Shutdown the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      interruptIfRunning - whether to shutdown immediately or wait until each node is idle.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • resetTaskCounter

      Map<String,Object> resetTaskCounter(NodeSelector selector) throws Exception
      Deprecated.
      Reset the specified nodes' executed tasks counter to zero.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • setTaskCounter

      Map<String,Object> setTaskCounter(NodeSelector selector, Integer n) throws Exception
      Deprecated.
      Reset the specified nodes' executed tasks counter to the specified value.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      n - the number to set the task counter to.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • updateConfiguration

      Map<String,Object> updateConfiguration(NodeSelector selector, Map<Object,Object> configOverrides, Boolean restart, Boolean interruptIfRunning) throws Exception
      Deprecated.
      Update the configuration properties of the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      configOverrides - the set of properties to update.
      restart - specifies whether the node should be restarted after updating the properties.
      interruptIfRunning - when true, then restart the node even if it is executing tasks, when false, then only shutdown the node when it is no longer executing. This parameter only applies when the restart parameter is true.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.
      Since:
      5.2

    • updateConfiguration

      Map<String,Object> updateConfiguration(NodeSelector selector, Map<Object,Object> configOverrides, Boolean restart) throws Exception
      Deprecated.
      Update the configuration properties of the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      configOverrides - the set of properties to update.
      restart - specifies whether the node should be restarted after updating the properties.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • cancelJob

      Map<String,Object> cancelJob(NodeSelector selector, String jobId, Boolean requeue) throws Exception
      Deprecated.
      Cancel the job with the specified id in the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      jobId - the id of the job to cancel.
      requeue - true if the job should be requeued on the server side, false otherwise.
      Returns:
      a mapping of node uuids to an eventual exception resulting invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • getDelegationModel

      Map<String,Object> getDelegationModel(NodeSelector selector) throws Exception
      Deprecated.
      Get the current class loader delegation model for the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to the result of invoking the MBean method on the corresponding node. Each result may be either a DelegationModel enum value, or an exception if the invocation failed for the corresponding node.
      Throws:
      Exception - if any error occurs.
      See Also:
      • AbstractJPPFClassLoader.getDelegationModel()

    • setDelegationModel

      Map<String,Object> setDelegationModel(NodeSelector selector, DelegationModel model) throws Exception
      Deprecated.
      Set the current class loader delegation model for the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      model - either either PARENT_FIRST or URL_FIRST. If any other value is specified then this method has no effect.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.
      See Also:
      • AbstractJPPFClassLoader.setDelegationModel(org.jppf.classloader.DelegationModel)

    • systemInformation

      Map<String,Object> systemInformation(NodeSelector selector) throws Exception
      Deprecated.
      Get the system information for the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • healthSnapshot

      Map<String,Object> healthSnapshot(NodeSelector selector) throws Exception
      Deprecated.
      Get the JVM health snapshot for the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • gc

      Map<String,Object> gc(NodeSelector selector) throws Exception
      Deprecated.
      Invoke System.gc() on the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • heapDump

      Map<String,Object> heapDump(NodeSelector selector) throws Exception
      Deprecated.
      Trigger a heap dump on the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • threadDump

      Map<String,Object> threadDump(NodeSelector selector) throws Exception
      Deprecated.
      Get a JVM thread dump for the specified nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • getNbSlaves

      Map<String,Object> getNbSlaves(NodeSelector selector) throws Exception
      Deprecated.
      Get the number of provisioned slave nodes for the selected nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      Returns:
      a mapping of node uuids to either an int corresponding tot he number of slaves provisioned by the node, or an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • provisionSlaveNodes

      Map<String,Object> provisionSlaveNodes(NodeSelector selector, int nbNodes) throws Exception
      Deprecated.
      Start or stop the required number of slaves to reach the specified number on the selected nodes. This is equivalent to calling provisionSlaveNodes(nbNodes, null).
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      nbNodes - the number of slave nodes to reach.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • provisionSlaveNodes

      Map<String,Object> provisionSlaveNodes(NodeSelector selector, int nbNodes, boolean interruptIfRunning) throws Exception
      Deprecated.
      Start or stop the required number of slaves to reach the specified number on the selected nodes.
      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      nbNodes - the number of slave nodes to reach.
      interruptIfRunning - if true then nodes can only be stopped once they are idle.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • provisionSlaveNodes

      Map<String,Object> provisionSlaveNodes(NodeSelector selector, int nbNodes, TypedProperties configOverrides) throws Exception
      Deprecated.
      Start or stop the required number of slaves to reach the specified number, using the specified config overrides, on the selected nodes.

      If configOverrides is null, then previous overrides are applied, and already running slave nodes do not need to be stopped.

      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      nbNodes - the number of slave nodes to reach.
      configOverrides - the configuration overrides to apply.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.

    • provisionSlaveNodes

      Map<String,Object> provisionSlaveNodes(NodeSelector selector, int nbNodes, boolean interruptIfRunning, TypedProperties configOverrides) throws Exception
      Deprecated.
      Start or stop the required number of slaves to reach the specified number, using the specified config overrides, on the selected nodes.

      If configOverrides is null, then previous overrides are applied, and already running slave nodes do not need to be stopped.

      Parameters:
      selector - a filter on the nodes attached to the driver, determines the nodes to which this method applies.
      nbNodes - the number of slave nodes to reach.
      interruptIfRunning - if true then nodes can only be stopped once they are idle.
      configOverrides - the configuration overrides to apply.
      Returns:
      a mapping of node uuids to an eventual exception resulting from invoking this method on the corresponding node. This map may be empty if no exception was raised.
      Throws:
      Exception - if any error occurs.