Skip to main content

Calling Plugins

You can call server-side plugins from JDito using the run method of the plugin module.

Object[] run(String jarURL, String className, Object[] arguments);

  • jarURL: URL of the plugin JAR file. Can be null if the JAR is already on the classpath.
    Using the classpath is the preferred method.
    Direct JAR referencing (e.g., using a file URL) does not work reliably on all platforms (e.g., Linux).

  • className: Fully qualified class name of the plugin.

  • arguments: An array of parameters passed to the plugin as arguments.

  • return: The result returned by the plugin.

  • throws: PluginException if an error occurs.

Example​

// run the plugin contained in testplugin.jar
var ret = plugin.run("file:///c:/plugin/testplugin.jar",
                     "de.adito.aditoweb.plugin.test.TestPlugin",
                     new Array("arg1", "arg2", "arg3") );

// display the number of array elements returned
question.showMessage(ret.length);

Using Plugins via Alias​

To call a plugin via the plugin service, you must define an alias. The alias should specify the path where the plugin is hosted.
Currently, plugins are deployed to a Nexus repository.

Background​

The plugin service is an external service and must be integrated into the ADITO system via an alias.
In SSP operations, plugins are provisioned automatically by the operator through this external service.
The alias definition signals that the plugin service should be started.

How to Set It Up​

  1. Open the Projects module.
  2. Go to alias.
  3. Right-click → New.
  4. Enter a name.
  5. Choose type: plugin.
  6. Deploy the configuration.

After deployment, the alias appears under system → default.

  1. Right-click the alias → Create.
  2. Go back to the alias definition.
  3. In the bottom left Properties panel, enter the following fields:
  • pluginGroupID
  • pluginArtifactId
  • pluginVersion

If you use the following example:

pluginCoordinates=de.adito.plugin:ewsplugin:1.1.4
pluginServiceUrl=https://127.0.0.1:8443/ews/
note

The pluginServiceUrl is inserted by the operator when the service starts.

plugins properties
Figure: Required plugin alias properties