Package net.solarnetwork.node.service

Interface SystemService

public interface SystemService
API for node system services, such as restarting, rebooting, or making system configuration changes.
Since:
1.47
Version:
1.2
Author:
matt

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TOPIC_REBOOT
    The instruction topic for a request to reboot the SolarNode device.
    static final String
    TOPIC_RESET
    The instruction topic for a request to perform a factory reset of the SolarNode device.
    static final String
    TOPIC_RESTART
    The instruction topic for a request to restart the SolarNode application.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    exit(boolean syncState)
    Exit the node application, stopping the active process.
    void
    reboot()
    Reboot the device the application is running on.
    void
    reset(boolean applicationOnly)
    Perform a factory reset.

  • Field Details

    • TOPIC_RESTART

      static final String TOPIC_RESTART
      The instruction topic for a request to restart the SolarNode application.

      In practice this could mean invoking the exit(boolean) method, assuming the node OS automatically restarts the application when it exits.

      Since:
      1.1
      See Also:

    • TOPIC_REBOOT

      static final String TOPIC_REBOOT
      The instruction topic for a request to reboot the SolarNode device.

      In practice this could mean invoking the reboot() method.

      Since:
      1.1
      See Also:

    • TOPIC_RESET

      static final String TOPIC_RESET
      The instruction topic for a request to perform a factory reset of the SolarNode device.

      In practice this could mean invoking the reset(boolean) method.

      Since:
      1.2
      See Also:

  • Method Details

    • exit

      void exit(boolean syncState)
      Exit the node application, stopping the active process.
      Parameters:
      syncState - A flag to indicate (when true) that any transient data should be persisted to permanent storage.

    • reboot

      void reboot()
      Reboot the device the application is running on.

    • reset

      void reset(boolean applicationOnly)
      Perform a factory reset.
      Parameters:
      applicationOnly - if true then only reset SolarNode application settings; if false then also reset OS-level settings (such as network passwords).
      Since:
      1.2