Package com.jbstrap.core.plugin

Interface JBStrapPlugin

public interface JBStrapPlugin

The JBStrap framework plugin interface

With this interface, custom framework plugins can be made. The custom plugins must have a class, that implement this interface.

Since:
4.0
Author:
JBStrap

  • Method Details

    • getPluginName

      String getPluginName()
      Gets the name of the plugin. The method's return value must be the plugin's name. The name must be unique within the framework.
      Returns:
      The plugin's unique name

    • getPluginVersion

      String getPluginVersion()
      Gets the plugin's version number.
      Returns:
      The string representing the plugin version. (There are no limitations for the format or content of the version number.)

    • getPluginBuildNumber

      String getPluginBuildNumber()
      Gets the plugin's build number.
      Returns:
      The string representing the plugin build number. (There are no limitations for the format or content of the build number.)

    • getPluginFullName

      String getPluginFullName()
      Gets the plugin's full name
      Returns:
      The plugin's full name

    • getPluginAuthor

      String getPluginAuthor()
      Gets the name of the plugin author
      Returns:
      The name of the plugin author

    • getPluginAuthorURL

      String getPluginAuthorURL()
      Gets the URL (web address) of the plugin author
      Returns:
      The URL of the plugin author

    • getDescription

      String getDescription()
      Gets the plugin description
      Returns:
      The plugin description

    • init

      void init() throws Exception

      Initializes the plugin. This method will be called automatically by the framework after loading the plugin. The method will run on every system start once, thus the initialization required for the plugin to function can be done here.

      If an error was encountered during the plugin initialization, that must be thrown towards the framework. If the framework receives an error during initialization, the initialization and startup process will be halted, and the error will be written to the server log.

      Throws:
      Exception - Must be triggered, if an error, that must halt the application startup, was encountered during the plugin initialization.