Package net.solarnetwork.node.setup

Interface PluginProvisionStatus

public interface PluginProvisionStatus
API for status information and feedback during plugin provisioning operations, that is, installing or removing plugins.
Version:
1.1
Author:
matt

  • Method Details

    • getProvisionID

      String getProvisionID()
      Get a unique provisioning operation ID for this status, so clients of the PluginService API can track progress.
      Returns:
      a unique provisioning operation ID

    • getStatusMessage

      String getStatusMessage()
      Get a status message on the provision progress. This might include information on which plugin was being downloaded, installed, removed, etc.
      Returns:
      a status message

    • getOverallProgress

      float getOverallProgress()
      Get an overall progress amount, as a percentage between 0 and 1.
      Returns:
      percent complete

    • getOverallDownloadSize

      Long getOverallDownloadSize()
      Get an overall number of bytes that must be downloaded to complete the provisioning operation.
      Returns:
      number of bytes, or null if not known

    • getOverallDownloadedSize

      Long getOverallDownloadedSize()
      Get the number of bytes that have been downloaded so far while executing this provisioning operation.
      Returns:
      number of bytes, or null if not known

    • getPluginsToInstall

      List<Plugin> getPluginsToInstall()
      Get a list of plugins to be installed as part of this provisioning operation.
      Returns:
      a list of plugins to intall, or an empty list if none

    • getPluginsToRemove

      List<Plugin> getPluginsToRemove()
      Get a list of plugins to be removed as part of this provisioning operation.
      Returns:
      a list of plugins to remove, or an empty list if none

    • isRestartRequired

      boolean isRestartRequired()
      Flag indicating a restart will be required after the provision task completes.
      Returns:
      true if a restart is required after the provision task completes
      Since:
      1.1