Class PluginConfigFile


  • public class PluginConfigFile
    extends Object
    Defines plugin configuration file properties For example, to define JSON file
    
     new PluginConfigFile("rules.json", "Plugin rules", "Define a list of rules to extract data", "json", true)
     
    or using a builder
    
     PluginConfigFile.builder()
          .name("rules.json")
          .label("Plugin rules")
          .description("Define a list of rules to extract data")
          .format("json")
          .required(true)
          .build()
     
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private @NonNull String description
      Description of plugin configuration file to display in plugin configuration admin UI and in auto-generated documentation
      private @NonNull String format
      Expected format of plugin configuration file For example: json, xml, txt
      private @NonNull String label
      Label for plugin configuration file to display in plugin configuration admin UI
      private @NonNull String name
      Plugin configuration file name For example: rules.json, properties.cfg
      private boolean required
      Mark plugin configuration file as required or optional in plugin configuration admin UI and in auto-generated documentation
    • Field Detail

      • name

        @NonNull
        private final @NonNull String name
        Plugin configuration file name For example: rules.json, properties.cfg
      • label

        @NonNull
        private final @NonNull String label
        Label for plugin configuration file to display in plugin configuration admin UI
      • description

        @NonNull
        private final @NonNull String description
        Description of plugin configuration file to display in plugin configuration admin UI and in auto-generated documentation
      • format

        @NonNull
        private final @NonNull String format
        Expected format of plugin configuration file For example: json, xml, txt
      • required

        private final boolean required
        Mark plugin configuration file as required or optional in plugin configuration admin UI and in auto-generated documentation
    • Constructor Detail

      • PluginConfigFile

        public PluginConfigFile()