Plugin Descriptor

Iotellect Server Plugin Descriptor is an XML file describing a single Iotellect Server plugin and its place in the server plugin hierarchy.

Creating a Plugin Descriptor

To create a plugin descriptor for your plugin, make a copy of demo plugin's plugin.properties file and edit the following in it:

  • Change the last word in id attribute of the <plugin> tag to the ID of new plugin. The ID should contain only lowercase letters, digits and underscores. For example, if your desired plugin ID is xyz, set ID attribute to com.example.linkserver.plugin.context.xyz.

  • Change class attribute of <plugin> tag to full name of plugin's java class.

  • Enter plugin description in the body <doc-text> tag.

  • Change id attribute of the <extension> tag to the new plugin ID.

Plugin Dependencies

If your plugin requires some other plugins to work, specify them as dependencies in <requires> tag. See example below.

Example

Here is an example of a plugin descriptor:

<?xml version="1.0" ?>
<!DOCTYPE plugin PUBLIC "-//JPF//Java Plug-in Manifest 0.4" "http://jpf.sourceforge.net/plugin_0_4.dtd">
<plugin id="com.example.linkserver.plugin.context.access-control" version="0.0.1" class="com.example.linkserver.plugin.context.accesscontrol.AccessControlContextPlugin">
  <doc>
    <doc-text>Access Control</doc-text>
  </doc>
  <requires>
    <import plugin-id="com.example.another.common.plugin.extensions"/>
    <import plugin-id="com.example.linkserver.plugin.context.cardholders"/>
  </requires>
  <runtime>
    <library id="example" path="/" type="code">
      <export prefix="*"/>
    </library>
  </runtime>
  <extension plugin-id="com.example.another.common.plugin.extensions" point-id="context" id="access-control"/>
</plugin>

Was this page helpful?