Package org.apache.ignite.mxbean

## Interface IgnitionMXBean

-     @MXBeanDescription("MBean that provides access to grid life-cycle operations.")
      public interface IgnitionMXBean

  This interface defines JMX view on `Ignition`.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `String` | `getState()` | Gets state of default grid instance.
    `String` | `getState​(String name)` | Gets state for a given grid instance.
    `void` | `restart​(boolean cancel)` | Restart JVM.
    `boolean` | `stop​(boolean cancel)` | Stops default grid instance.
    `boolean` | `stop​(String name, boolean cancel)` | Stops named Ignite instance.
    `void` | `stopAll​(boolean cancel)` | Stops all started grids.

- - ### Method Detail

    - #### getState

          @MXBeanDescription("State of default grid instance.")
          String getState()

      Gets state of default grid instance.
      Returns:
        State of default grid instance.
      See Also:
        `Ignition.state()`

    - #### getState

          @MXBeanDescription("Gets state for a given grid instance. Returns state of grid instance with given name.")
          String getState​(@MXBeanParameter(name="name",description="Name of grid instance.")
                          String name)

      Gets state for a given grid instance.
      Parameters:
        `name` - Name of grid instance.
      Returns:
        State of grid instance with given name.
      See Also:
        `Ignition.state(String)`

    - #### stop

          @MXBeanDescription("Stops default grid instance. Return true if default grid instance was indeed stopped, false otherwise (if it was not started).")
          boolean stop​(@MXBeanParameter(name="cancel",description="If true then all jobs currently executing on default grid will be cancelled.")
                       boolean cancel)

      Stops default grid instance.
      Parameters:
        `cancel` - If `true` then all jobs currently executing on default grid will be cancelled by calling `ComputeJob.cancel()` method. Note that just like with `Thread.interrupt()`, it is up to the actual job to exit from execution.
      Returns:
        `true` if default grid instance was indeed stopped, `false` otherwise (if it was not started).
      See Also:
        `Ignition.stop(boolean)`

    - #### stop

          @MXBeanDescription("Stops Ignite instance by name. Cancels running jobs if cancel is true. Returns true if named Ignite instance was indeed found and stopped, false otherwise.")
          boolean stop​(@MXBeanParameter(name="name",description="Grid instance name to stop.")
                       String name,
                       @MXBeanParameter(name="cancel",description="Whether or not running jobs should be cancelled.")
                       boolean cancel)

      Stops named Ignite instance. If `cancel` flag is set to `true` then all jobs currently executing on local node will be interrupted. If Ignite instance name is `null`, then default no-name Ignite instance will be stopped. It does not wait for the tasks to finish their execution.
      Parameters:
        `name` - Ignite instance name. If `null`, then default no-name Ignite instance will be stopped.
        `cancel` - If `true` then all jobs currently will be cancelled by calling `ComputeJob.cancel()` method. Note that just like with `Thread.interrupt()`, it is up to the actual job to exit from execution. If `false`, then jobs currently running will not be canceled. In either case, grid node will wait for completion of all jobs running on it before stopping.
      Returns:
        `true` if named Ignite instance instance was indeed found and stopped, `false` otherwise (the instance with given `name` was not found).
      See Also:
        `Ignition.stop(String, boolean)`

    - #### stopAll

          @MXBeanDescription("Stops all started grids.")
          void stopAll​(@MXBeanParameter(name="cancel",description="If true then all jobs currently executing on all grids will be cancelled.")
                       boolean cancel)

      Stops all started grids. If `cancel` flag is set to `true` then all jobs currently executing on local node will be interrupted. It does not wait for the tasks to finish their execution.

      Note: it is usually safer and more appropriate to stop grid instances individually instead of blanket operation. In most cases, the party that started the grid instance should be responsible for stopping it.

      Parameters:
        `cancel` - If `true` then all jobs currently executing on all grids will be cancelled by calling `ComputeJob.cancel()` method. Note that just like with `Thread.interrupt()`, it is up to the actual job to exit from execution
      See Also:
        `Ignition.stopAll(boolean)`

    - #### restart

          @MXBeanDescription("Restart JVM.")
          void restart​(@MXBeanParameter(name="cancel",description="If true then all jobs currently executing on default grid will be cancelled.")
                       boolean cancel)

      Restart JVM.
      Parameters:
        `cancel` - If `true` then all jobs currently executing on all grids will be cancelled by calling `ComputeJob.cancel()` method. Note that just like with `Thread.interrupt()`, it is up to the actual job to exit from execution
      See Also:
        `Ignition.stopAll(boolean)`