Package org.lowcoder.plugin.api

Interface LowcoderPlugin

public interface LowcoderPlugin
Interface to be implemented by all Lowcoder plugins.
Author:
ludomikula

  • Method Details

    • load

      boolean load(Map<String,Object> environment, LowcoderServices lowcoderServices)
      Load the plugin.
      Parameters:
      environment - Environment properties propagated from Lowcoder
      lowcoderServices - services shared from Lowcoder main application
      Returns:
      true if we successfully loaded the plugin, false otherwise

    • unload

      void unload()
      Unload the plugin - this method is called on API server shutdown. Free all resources, close all files etc in this method.

    • pluginId

      String pluginId()
      Plugin Id must match following regex: ^[a-zA-Z0-9-_]{5+}$ .
      Returns:
      Unique plugin ID

    • pluginInfo

      Object pluginInfo()
      Returns:
      Plugin information serialized as part of /plugins listing.

    • description

      String description()
      Returns:
      Plugin description

    • loadOrder

      int loadOrder()
      Returns:
      Order in which to load the plugin. Lower number gets loaded first.

    • endpoints

      List<PluginEndpoint> endpoints()
      Returns:
      All endpoints defined by this plugin.