Package org.hansken.plugin.extraction.api

Class PluginInfo

java.lang.Object
org.hansken.plugin.extraction.api.PluginInfo
public final class PluginInfo extends Object
Information about an extraction plugin, such as the author or a human-readable description.

Example PluginInfo: 

     PluginInfo.builderFor(this)
         .id("nfi.nl", "digest", "sha111")
         .pluginVersion("0.2.1")
         .description("Calculates hashes from data streams.")
         .author(Author.builder()
             .name("name")
             .email("test@email.com")
             .organisation("organisation")
             .build())
         .maturityLevel(MaturityLevel.PROOF_OF_CONCEPT)
         .hqlMatcher("hql-lite query")
         .webpageUrl("https://github.com/myOrg/digestPlugin")
         .license("Apache License 2.0")
         .resources(Resources.builder()
             .maximumCpu(1)
             .maximumMemory(1000)
             .build())
         .build();

  • Method Details

    • builderFor

      public static PluginInfo.Builder builderFor(BaseExtractionPlugin plugin)
      Start creating new plugin information for the given plugin.
      Parameters:
      plugin - the plugin to create the plugin information for
      Returns:
      a builder for plugin metadata

    • builderFor

      public static PluginInfo.Builder builderFor(PluginType type)
      Start creating new plugin information for a plugin of given type.
      Parameters:
      type - the type of plugin to create the plugin information for
      Returns:
      a builder for plugin metadata

    • pluginType

      public PluginType pluginType()
      Get the type of this plugin.
      Returns:
      the type of this plugin

    • name

      @Deprecated public String name()
      Deprecated.
      Use id() instead.
      Get the name of this plugin.
      Returns:
      the name of this plugin

    • fullName

      public String fullName()
      Get the full name of this plugin, based on the id. This name will be shown in the Hansken GUI.
      Returns:
      the full name of this plugin, based on the id

    • pluginVersion

      public String pluginVersion()
      Get the version of this plugin.
      Returns:
      the version of this plugin

    • description

      public String description()
      Get a human readable description of this plugin.
      Returns:
      a description of this plugin

    • author

      public Author author()
      Get the author of this plugin.
      Returns:
      the author of this plugin.

    • maturityLevel

      public MaturityLevel maturityLevel()
      Get the maturity level of this plugin.
      Returns:
      the maturity level of this plugin

    • hqlMatcher

      public String hqlMatcher()
      Get the hqlMatcher of this plugin in string format.
      Returns:
      the matcher of this plugin

    • webpageUrl

      public String webpageUrl()
      Get the url of this plugin, could point to git repo or webpage that explains the plugin.
      Returns:
      the url of this plugin

    • deferredIterations

      public int deferredIterations()
      Get the number of extraction iterations before the deferred plugin can be applied on traces. Only relevant for deferred plugins; default value is 1.
      Returns:
      the number of iterations set of this plugin

    • id

      public PluginId id()
      Get the the unique id of this plugin, consisting of domain, category and name.
      Returns:
      the url of this plugin

    • license

      public String license()
      Get the name of the license of this plugin.
      Returns:
      the name of the license of this plugin

    • transformers

      public List<TransformerLabel> transformers()
      Get a list of possible transform methods this plugin provides.
      Returns:
      list of transform methods

    • resources

      public PluginResources resources()
      Get the resources of this plugin.
      Returns:
      the resources of this plugin