i-net Clear Reports

EngineFactory

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

Activate the included plugin

If you want to try this plugin then you need to copy the file enginefactory.zip of this sample in the plugins folder of your server installation and restart the server.

Server Plugin

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.

Build the plugin

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.

Collect the required jar files

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

  • inetcore.jar (included in the core directory)
  • ClearReports.jar (included in the core directory)

You can copy these to the current sample directory or link them into the project of your IDE.

Build the plugin

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.

Deploying

Copy the ZIP file of the plugin into the plugins directory of the server and restart it. 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.

 

© Copyright 1996 - 2019, i-net software; All Rights Reserved.