org.graylog2.web.PluginUISettingsProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation

Graylog

There is a newer version: 6.1.4

/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.web;

/**
 * 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".
 */
public interface PluginUISettingsProvider {

    /**
     * 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.
     *
     * @return The settings data to be included in config.js
     */
    T pluginSettings();
}