Package org.yamcs

Interface Plugin

All Known Implementing Classes:

TsePlugin, WebPlugin

public interface Plugin

Method Summary

Modifier and Type	Method	Description
default Spec	getInstanceSpec()	Returns the valid instance-level configuration options for this plugin.
default Spec	getSpec()	Returns the valid configuration options for this plugin.
default void	onLoad(YConfiguration config)	Callback executed when the plugin is loaded.

Method Details

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.

getInstanceSpec

default Spec getInstanceSpec()

Returns the valid instance-level configuration options for this plugin.

If null is returned, Yamcs will attempt to autodiscover plugin instance-level 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

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