Changes between Version 17 and Version 18 of PluginDevelopmentGuide

Timestamp:

15.04.2013 15:46:04 (12 years ago)

Author:

jri

Comment:

Plugin main file example

PluginDevelopmentGuide

@@ -3 +3 @@
 = Plugin Development Guide =
 
-DeepaMehta is made to be extensible by 3rd-party developers. Developers extend DeepaMehta by developing plugins (resp. "modules" resp. "applications" which is all synonymous).
+DeepaMehta is made to be extensible by 3rd-party developers. Developers extend DeepaMehta by developing plugins (resp. "modules" resp. "applications" which is all synonymous). This guide teaches you how to develop DeepaMehta plugins.
 
 == Build DeepaMehta from source ==
@@ -586 +586 @@
 === The plugin main file ===
 
-You must write a //plugin main file// if your plugin needs to a) listen to DeepaMehta Core events and/or b) provide a service. The plugin main file contains the event handling code resp. the implementation of the service methods then. A plugin main file is a Java class that is derived from `de.deepamehta.core.osgi.PluginActivator`.
+You must write a //plugin main file// if your plugin needs to a) listen to DeepaMehta Core events and/or b) provide a service. The plugin main file contains the event handlers resp. the service implementation then.
 
 The plugin main file must be located directly in the plugin's `src/main/java/<your plugin package>/` directory. By convention the plugin main class ends with `Plugin`.
@@ -607 +607 @@
 Here the plugin package is `org.mydomain.deepamehta4.mycoolplugin` and the plugin main class is `MyCoolPlugin`.
 
-Furthermore you must add 2 entries in the plugin's **`pom.xml`**:
-    1. A <dependencies> element to include the `deepamehta-core` dependency. This is needed as your plugin main file requires the `PluginActivator` class.
-    2. a <build> element to configure the Maven Bundle Plugin. It needs to know what your plugin's main class is. You must specify its fully-qualified class name.
+A plugin main file is a Java class that is derived from `de.deepamehta.core.osgi.PluginActivator`. The smallest possible plugin main file looks like this:
+
+{{{
+#!java
+package org.mydomain.deepamehta4.mycoolplugin;
+
+import de.deepamehta.core.osgi.PluginActivator;
+
+public class MyCoolPlugin extends PluginActivator {
+}
+}}}
+
+3 things are illustrated here:
+    * The plugin should be packaged in an unique namespace.
+    * The `PluginActivator` class needs to be imported.
+    * The plugin main class must be derived from `PluginActivator` and must be public.
+
+Furthermore when writing a plugin main file you must add 2 entries in the plugin's **`pom.xml`**:
+    1. a <dependencies> element to include the `deepamehta-core` dependency. This brings you the `PluginActivator` class.
+    2. a <build> element to configure the Maven Bundle Plugin. It needs to know what your plugin main class is. You must specify the fully-qualified class name.
 
 {{{