Package sonia.scm.plugin

Interface PluginManager

public interface PluginManager
The plugin manager is responsible for plugin related tasks, such as install, uninstall or updating.

  • Method Details

    • getAvailable

      Optional<AvailablePlugin> getAvailable(String name)
      Returns the available plugin with the given name.

    • getInstalled

      Optional<InstalledPlugin> getInstalled(String name)
      Returns the installed plugin with the given name.

    • getInstalled

      List<InstalledPlugin> getInstalled()
      Returns all installed plugins.

    • getPlugins

      default PluginManager.PluginResult getPlugins()
      Since:
      2.40.0

    • getAvailable

      List<AvailablePlugin> getAvailable()
      Returns all available plugins. The list contains the plugins which are loaded from the plugin center, but without the installed plugins.

    • getPluginSets

      Set<PluginSet> getPluginSets()
      Returns all available plugin sets from the plugin center.
      Since:
      2.35.0

    • installPluginSets

      void installPluginSets(Set<String> pluginSets, boolean restartAfterInstallation)
      Collects and installs all plugins and their dependencies for the given plugin sets.
      Parameters:
      pluginSets - Ids of plugin sets to install
      restartAfterInstallation - restart context after all plugins have been installed
      Since:
      2.35.0

    • getUpdatable

      List<InstalledPlugin> getUpdatable()
      Returns all updatable plugins.

    • getPending

      PendingPlugins getPending()
      Returns all pending plugins.
      Since:
      2.38.0

    • install

      void install(String name, boolean restartAfterInstallation)
      Installs the plugin with the given name from the list of available plugins.
      Parameters:
      name - plugin name
      restartAfterInstallation - restart context after plugin installation

    • uninstall

      void uninstall(String name, boolean restartAfterInstallation)
      Marks the plugin with the given name for uninstall.
      Parameters:
      name - plugin name
      restartAfterInstallation - restart context after plugin has been marked to really uninstall the plugin

    • executePendingAndRestart

      void executePendingAndRestart()
      Install all pending plugins and restart the scm context.

    • cancelPending

      void cancelPending()
      Cancel all pending plugins.

    • updateAll

      void updateAll()
      Update all installed plugins.