EngineFactory

This plugin demonstrate how you can write a plugin that implements the EngineFactory interface. Details can you find in the server programming guide.

In order to test this plugin, you need to copy the plugin ZIP file enginefactory.zip into the plugins folder of your installation or upload the plugin using Drag & Drop in the Store application. Afterwards the server needs to be restarted. You can check if the plugin was loaded in the dialog Store application. If there are problems, then check the log file of the server for more details.

In the next step you write your own server plugin. It must implement the interface com.inet.plugin.ServerPlugin and have an empty public constructor for loading. In the method init you must set your class. This can look like:

public void init( ServerPluginManager spm ) {
    Cache.setEngineFactory( new CustomEngineFactory() );
}

Please refer to the sample com.inet.samples.factory.CustomEngineFactory to see how this is done there.

The following steps need to be taken if changes are made to the plugin code.

The plugin.properties and server plugin class are preconfigured to be used without modifications. If the sample is the basis for a custom plugin or just needs some adaptions, please refer to the platform programming guide for detailed instructions.

In order to build this plugin the following jar files are required at minimum:

• inetcore.jar (included in the core directory)
• reporting.jar (included in the plugins/reporting.zip file)

These files are part of the SDK but will also be loaded from our public maven server when using the packaged build.gradle.

The plugin must be compiled into a jar file that is named like the id of the plugin. In this example it is enginefactory.jar. It also must contain the compiled sources as well as required language resources and images.

The target plugin is a zip file, named enginefactory.zip in this example. It contains the compiled jar file and the plugin.properties which configures the custom plugin.

The provided build.gradle in the sample can be used to build the plugin as well as any other build system.

Copy the ZIP file of the plugin into the plugins directory of the server or Drag & Drop the plugin into the Store application of the server for sideloading. Then restart the server. If there are problems, then check the log file of the server for more details. The "Config" logger is used to log plugin registration issues.