Package org.graylog2.web
Interface PluginUISettingsProvider<T>
public interface PluginUISettingsProvider<T>
Some plugins may have dynamic data that needs to be made available to the UI at server startup. This interface
provides a mechanism for providing that data via the generated config.js file's pluginUISettings map. When an
instance of this interface is registered via the PluginModule.addPluginUISettingsProvider() method, an entry will
be added to the pluginUISettings map using the key and JSON data the instance provides.
When registering a new PluginUISettingsProvider via addPluginUISettingsProvider(), you must register with a unique
providerKey value. To help guarantee uniqueness, we recommend following Java package naming standards. As an
example, a new Graylog plugin might use the key: "org.graylog.newuiplugin".
-
Method Summary
Modifier and TypeMethodDescriptionThis method returns the UI settings data for your plugin as a Map which will be converted to JSON and surfaced via the generated config.js file at server startup.
-
Method Details
-
pluginSettings
T pluginSettings()This method returns the UI settings data for your plugin as a Map which will be converted to JSON and surfaced via the generated config.js file at server startup.- Returns:
- The settings data to be included in config.js
-