Package org.jppf.management

Interface JPPFNodeAdminMBean

All Superinterfaces:
JPPFAdminMBean, Serializable
All Known Implementing Classes:
JMXNodeConnectionWrapper
public interface JPPFNodeAdminMBean extends JPPFAdminMBean
Exposed interface of the JPPF node management bean.
Author:
Laurent Cohen

  • Field Details

  • Method Details

    • state

      JPPFNodeState state() throws Exception
      Get the latest state information from the node.
      Returns:
      a JPPFNodeState information.
      Throws:
      Exception - if any error occurs.

    • updateThreadPoolSize

      void updateThreadPoolSize(Integer size) throws Exception
      Set the size of the node's thread pool.
      Parameters:
      size - the size as an int.
      Throws:
      Exception - if any error occurs.

    • updateThreadsPriority

      void updateThreadsPriority(Integer newPriority) throws Exception
      Update the priority of all execution threads.
      Parameters:
      newPriority - the new priority to set.
      Throws:
      Exception - if an error is raised when invoking the node mbean.

    • restart

      void restart() throws Exception
      Restart the node. This is equivalent to calling restart(true).
      Throws:
      Exception - if any error occurs.

    • restart

      void restart(Boolean interruptIfRunning) throws Exception
      Restart the node.
      Parameters:
      interruptIfRunning - when true, then restart the node even if it is executing tasks, when false, then only restart the node when it is no longer executing.
      Throws:
      Exception - if any error occurs.
      Since:
      5.0

    • shutdown

      void shutdown() throws Exception
      Shutdown the node.
      Throws:
      Exception - if any error occurs.

    • shutdown

      void shutdown(Boolean interruptIfRunning) throws Exception
      Shutdown the node.
      Parameters:
      interruptIfRunning - when true, then shutdown the node even if it is executing tasks, when false, then only shutdown the node when it is no longer executing.
      Throws:
      Exception - if any error occurs.
      Since:
      5.0

    • reconnect

      void reconnect(Boolean interruptIfRunning) throws Exception
      Force the node to reconnect without restarting.
      Parameters:
      interruptIfRunning - when true, then reconnect the node even if it is executing tasks, when false, then only restart the node when it is no longer executing.
      Throws:
      Exception - if any error occurs.
      Since:
      6.3

    • resetTaskCounter

      void resetTaskCounter() throws Exception
      Reset the node's executed tasks counter to zero.
      Throws:
      Exception - if any error occurs.

    • setTaskCounter

      void setTaskCounter(Integer n) throws Exception
      Reset the node's executed tasks counter to the specified value.
      Parameters:
      n - the number to set the task counter to.
      Throws:
      Exception - if any error occurs.

    • updateConfiguration

      void updateConfiguration(Map<Object,Object> configUpdates, Boolean restart, Boolean interruptIfRunning) throws Exception
      Update the configuration properties of the node.
      Parameters:
      configUpdates - 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.
      Throws:
      Exception - if any error occurs.
      Since:
      5.2

    • updateConfiguration

      void updateConfiguration(Map<Object,Object> configOverrides, Boolean restart) throws Exception
      Update the configuration properties of the node. This method is equivalent to calling updateConfiguration(configOverrides, restart, true).
      Parameters:
      configOverrides - the set of properties to update.
      restart - specifies whether the node should be restarted after updating the properties.
      Throws:
      Exception - if any error occurs.

    • cancelJob

      void cancelJob(String jobUuid, Boolean requeue) throws Exception
      Cancel the job with the specified uuid.
      Parameters:
      jobUuid - the id of the job to cancel.
      requeue - true if the job should be requeued on the server side, false otherwise.
      Throws:
      Exception - if any error occurs.

    • getDelegationModel

      DelegationModel getDelegationModel() throws Exception
      Get the current class loader delegation model for the node.
      Returns:
      either PARENT_FIRST or LOCAL_FIRST.
      Throws:
      Exception - if any error occurs.

    • setDelegationModel

      void setDelegationModel(DelegationModel model) throws Exception
      Set the current class loader delegation model for the node.
      Parameters:
      model - either either PARENT_FIRST or LOCAL_FIRST. If any other value is specified then this method has no effect.
      Throws:
      Exception - if any error occurs.

    • pendingAction

      NodePendingAction pendingAction()
      Determine wether a deffered shutdwon or restartd was requested and not yet performed for the node.
      Returns:
      one of the possible pending actions specified in the enum NodePendingAction.

    • cancelPendingAction

      boolean cancelPendingAction()
      Cancel a previous deferred shutdown or restart request, if any.
      Returns:
      true if the node has a pending action and it was cancelled, false otherwise.