Package org.yamcs

Interface Plugin


  • public interface Plugin
    • Method Detail

      • getSpec

        default Spec getSpec()
        Returns the valid configuration options for this plugin.

        If null is returned, Yamcs will attempt to autodiscover plugin options in a resource file named after the reverse qualified name of this plugin with yaml extension. For example: for a plugin com.example.MyPlugin, Yamcs will search for a classpath resource /com/example/MyPlugin.yaml.

        Returns:
        the argument specification. Or null if there are no options or Yamcs should autodiscover them.
      • onLoad

        @Deprecated
        default void onLoad()
                     throws PluginException
        Deprecated.
        Callback executed when the plugin is loaded.

        This is executed after Yamcs has created all configured services, but before actually starting them.

        Throws:
        PluginException
      • onLoad

        default void onLoad​(YConfiguration config)
                     throws PluginException
        Callback executed when the plugin is loaded.

        This is executed after Yamcs has created all configured services, but before actually starting them.

        Throws:
        PluginException