Changes between Version 16 and Version 17 of PluginDevelopmentGuide

Timestamp:

15.04.2013 00:17:34 (12 years ago)

Author:

jri

Comment:

The plugin main file

PluginDevelopmentGuide

@@ -583 +583 @@
 
 Weather a DeepaMehta plugin has a server side part at all depends on the nature of the plugin. Plugins without a server side part include those which e.g. just define a data model or just provide a custom (JavaScript) renderer.
+
+=== 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`.
+
+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`.
+
+Example:
+
+{{{
+#!txt
+dm4-mycoolplugin/
+    src/
+        main/
+            java/
+                org/
+                    mydomain/
+                        deepamehta4/
+                            mycoolplugin/
+                                MyCoolPlugin.java
+}}}
+
+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.
+
+{{{
+#!xml
+<project>
+    <modelVersion>4.0.0</modelVersion>
+
+    <name>My Cool Plugin</name>
+    <groupId>org.mydomain.dm4</groupId>
+    <artifactId>my-cool-plugin</artifactId>
+    <version>0.1-SNAPSHOT</version>
+    <packaging>bundle</packaging>
+
+    <parent>
+        <groupId>de.deepamehta</groupId>
+        <artifactId>deepamehta-plugin-parent</artifactId>
+        <version>4.1.1-SNAPSHOT</version>
+    </parent>
+
+    <dependencies>
+        <dependency>
+            <groupId>de.deepamehta</groupId>
+            <artifactId>deepamehta-core</artifactId>
+            <version>4.1.1-SNAPSHOT</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+                <configuration>
+                    <instructions>
+                        <Bundle-Activator>
+                            org.mydomain.deepamehta4.mycoolplugin.MyCoolPlugin
+                        </Bundle-Activator>
+                    </instructions>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>
+}}}