Changes between Version 20 and Version 21 of PluginDevelopmentGuide

Timestamp:

20.04.2013 18:17:53 (12 years ago)

Author:

jri

Comment:

Implementing the service

PluginDevelopmentGuide

@@ -733 +733 @@
 ==== The service interface ====
 
-For a plugin to provide a service you must define a //service interface//. The service interface contains all the method signatures that make up the service. When other plugins consume your plugin's service they do so via its service interface.
+For a plugin to provide a service you must define a //service interface//. The service interface contains all the method signatures that make up the service. When other plugins consume your plugin's service they do so via the service interface.
 
 The service interface //must// be located in the plugin's `src/main/java/<your plugin package>/service/` directory. By convention the name of the service interface ends with `...Service`. The service interface must be declared `public`.
@@ -739 +739 @@
 The service interface is a regular Java interface that extends `de.deepamehta.core.service.PluginService`. PluginService is a common base interface for all plugin services. It's just a marker interface.
 
-As an example look at the //Topicmaps// plugin (part of the DeepaMehta Standard Distribution):
+A DeepaMehta plugin can define //one// service interface at most. More than one service interface is not supported.
+
+As an example see the //Topicmaps// plugin (part of the DeepaMehta Standard Distribution):
 
 {{{
@@ -805 +807 @@
 
 You see the Topicmaps service consist of methods to create topicmaps, retrieve topicmaps, and manipulate topicmaps. As any plugin service the Topicmaps service must be derived from `PluginService`.
+
+==== Implementing the service ====
+
+After defining the plugin's service interface you must implement the actual service methods. Implementation takes place in the plugin main file.
+
+The plugin main class must declare that it implements the plugin's service interface. (So you need to import the service interface.) Each service method implementation must be `public`. Annotate each service method implementation with `@Override`.
+
+As an example see the implementation of the //Topicmaps// service:
+
+{{{
+#!java
+package de.deepamehta.plugins.topicmaps;
+
+import de.deepamehta.plugins.topicmaps.model.Topicmap;
+import de.deepamehta.plugins.topicmaps.service.TopicmapsService;
+
+import de.deepamehta.core.Topic;
+import de.deepamehta.core.osgi.PluginActivator;
+import de.deepamehta.core.service.ClientState;
+
+
+
+public class TopicmapsPlugin extends PluginActivator implements TopicmapsService {
+
+    // *** TopicmapsService Implementation ***
+
+    @Override
+    public Topic createTopicmap(String name, String topicmapRendererUri, ClientState clientState) {
+        ...
+    }
+
+    @Override
+    public Topic createTopicmap(String name, String uri, String topicmapRendererUri, ClientState clientState) {
+        ...
+    }
+
+    // ---
+
+    @Override
+    public Topicmap getTopicmap(long topicmapId, ClientState clientState) {
+        ...
+    }
+
+    // ---
+
+    @Override
+    public void addTopicToTopicmap(long topicmapId, long topicId, int x, int y) {
+        ...
+    }
+
+    ...
+}}}
+
+You see, the plugin main class `TopicmapsPlugin` implements the plugin's service interface `TopicmapsService`.