Interface JPPFNodeProvisioningMBean

All Superinterfaces:
NotificationBroadcaster, NotificationEmitter, Serializable

@MBeanNotif(description="notification that a slave node has started or stopped", userDataType=JPPFProvisioningInfo.class) public interface JPPFNodeProvisioningMBean extends Serializable, NotificationEmitter
Provides an interface for "master" nodes, giving them the ability to start, stop and monitor "slave" nodes on the same machine.
Since:
4.1
Author:
Laurent Cohen
  • Field Details

    • MBEAN_NAME

      static final String MBEAN_NAME
      The object name of this MBean.
      See Also:
    • SLAVE_STARTED_NOTIFICATION_TYPE

      static final String SLAVE_STARTED_NOTIFICATION_TYPE
      The type constant for notifications that a slave node has started.
      Since:
      6.1
      See Also:
    • SLAVE_STOPPED_NOTIFICATION_TYPE

      static final String SLAVE_STOPPED_NOTIFICATION_TYPE
      The type constant for notifications that a slave node has stopped.
      Since:
      6.1
      See Also:
  • Method Details

    • getNbSlaves

      int getNbSlaves()
      Get the number of slave nodes started by this MBean.
      Returns:
      the number of slave nodes as an integer value.
    • provisionSlaveNodes

      void provisionSlaveNodes(int nbNodes)
      Start or stop the required number of slaves to reach the specified number. This is equivalent to calling provisionSlaveNodes(nbNodes, null).
      Parameters:
      nbNodes - the number of slave nodes to reach.
    • provisionSlaveNodes

      void provisionSlaveNodes(int nbNodes, boolean interruptIfRunning)
      Start or stop the required number of slaves to reach the specified number. This is equivalent to calling provisionSlaveNodes(nbNodes, null).
      Parameters:
      nbNodes - the number of slave nodes to reach.
      interruptIfRunning - if true then nodes can only be stopped once they are idle.
    • provisionSlaveNodes

      void provisionSlaveNodes(int nbNodes, TypedProperties configOverrides)
      Start or stop the required number of slaves to reach the specified number, using the specified config overrides.

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

      Parameters:
      nbNodes - the number of slave nodes to reach.
      configOverrides - the configuration overrides to apply.
    • provisionSlaveNodes

      void provisionSlaveNodes(int nbNodes, boolean interruptIfRunning, TypedProperties configOverrides)
      Start or stop the required number of slaves to reach the specified number, using the specified config overrides.

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

      Parameters:
      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.