Changes between Version 6 and Version 7 of AnotherPluginDevelopmentGuide

Timestamp:

09.07.2012 17:01:53 (12 years ago)

Author:

dgf

Comment:

adapt API changes and link javadoc

AnotherPluginDevelopmentGuide

@@ -8 +8 @@
 DeepaMehta provides a framework for the plugin developer which has:
 
- * Access to the DeepaMehta Core service.
+ * Access to the [http://www.deepamehta.de/apidocs/deepamehta/4.0.12/de/deepamehta/core/service/DeepaMehtaService.html DeepaMehtaService].
  * OSGi handling.
  * Migration management.
@@ -266 +266 @@
 
 Real migrations of existing data can be written in Java, you have fully access
-to the DeepaMehtaService.
+to the [http://www.deepamehta.de/apidocs/deepamehta/4.0.12/de/deepamehta/core/service/DeepaMehtaService.html DeepaMehtaService].
 
 Programmatic plugin migration example:
@@ -342 +342 @@
         var name = prompt('Example name', 'Another Example')
             topic = dm4c.restc.request('POST', '/example/create', { name: name })
-        dm4c.canvas.add_topic(topic, true)
-        dm4c.do_select_topic(topic.id)
+        dm4c.show_topic(topic, 'show', null, true)
     }
 
@@ -350 +349 @@
         var url = '/example/increase/' + dm4c.selected_object.id,
             topic = dm4c.restc.request('GET', url)
-        dm4c.canvas.update_topic(topic, true)
-        dm4c.do_select_topic(topic.id)
+        dm4c.show_topic(topic, 'show', null, true)
     }
 
     // define type specific commands and register them 
-    dm4c.register_listener('topic_commands', function (topic) {
+    dm4c.add_listener('topic_commands', function (topic) {
         return topic.type_uri !== 'dm4.example.type' ? [] : [{
             context: ['context-menu', 'detail-panel-show'],
@@ -362 +360 @@
     })
 
-    // register a additional create command
-    dm4c.register_listener("post_refresh_create_menu", function(type_menu) {
+    // register an additional create command
+    dm4c.add_listener("post_refresh_create_menu", function(type_menu) {
         type_menu.add_separator()
         type_menu.add_item({ label: "New Example", handler: createAnotherExample })
@@ -575 +573 @@
 == Plugin == #plugin
 
-A Java plugin can interact with predefined hook overwrites and export  a OSGi service
-with optional REST exposure.
-
-All public methods of the plugin must be described in a service interface:
+A Java plugin can interact by implementing of listener and export a OSGi service
+with optional REST exposure. The listener contain topic CRUD (create, retype, update, delete) 
+interaction and plugin lifecycle management, see package
+[http://www.deepamehta.de/apidocs/deepamehta/4.0.12/de/deepamehta/core/service/listener/package-summary.html de.deepamehta.core.service.listener].
+
+All public methods of your plugin service must be described in a service interface that extends
+[http://www.deepamehta.de/apidocs/deepamehta/4.0.12/de/deepamehta/core/service/PluginService.html PluginService]:
 {{{#!java
 package de.deepamehta.plugins.example.service;
@@ -596 +597 @@
 }}}
 
-'''TBD''' rewrite hook calls in favour of listener interface per event
-
-The plugin itself can expose methods with 
-[http://jersey.java.net/nonav/documentation/latest/jax-rs.html JAX-RS] annotations:
+
+Implementing a plugin requires a derivation of
+[http://www.deepamehta.de/apidocs/deepamehta/4.0.12/de/deepamehta/core/osgi/PluginActivator.html PluginActivator],
+the plugin itself can expose methods with [http://jersey.java.net/nonav/documentation/latest/jax-rs.html JAX-RS] annotations:
 {{{#!java
 package de.deepamehta.plugins.example;
 
 import java.util.logging.Logger;
-import javax.ws.rs.*;
+
+import javax.ws.rs.GET;
+import javax.ws.rs.HeaderParam;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.WebApplicationException;
 
 import de.deepamehta.core.model.TopicModel;
+import de.deepamehta.core.osgi.PluginActivator;
 import de.deepamehta.core.service.ClientState;
-import de.deepamehta.core.service.Plugin;
+import de.deepamehta.core.service.listener.PreCreateTopicListener;
 import de.deepamehta.plugins.example.model.Example;
 import de.deepamehta.plugins.example.model.ExampleTopic;
@@ -615 +624 @@
 @Path("/example")
 @Produces("application/json")
-public class ExamplePlugin extends Plugin implements ExampleService {
+public class ExamplePlugin extends PluginActivator implements ExampleService,
+        PreCreateTopicListener {
 
     private Logger log = Logger.getLogger(getClass().getName());
@@ -624 +634 @@
      */
     @Override
-    public void preCreateHook(TopicModel model, ClientState clientState) {
-        if (model.getTypeUri().equals(ExampleTopic.TYPE)) {
-            log.info("init Example count of "
-                    + model.getCompositeValue().getString(ExampleTopic.NAME));
-            model.getCompositeValue().put(ExampleTopic.COUNT, 0);
+    public void preCreateTopic(TopicModel model, ClientState clientState) {
+        if (model.getTypeUri().equals(ExampleTopic.COUNT)) {
+            log.info("init Example count");
+            model.setSimpleValue(0);
         }
     }
 
     /**
-     * Creates a new <code>Example</code> instance based on
-     * <code>ExampleTopic</code> model.
+     * Creates a new <code>Example</code> instance based on the domain specific
+     * REST call with a alternate JSON topic representation.
      */
     @POST
@@ -649 +658 @@
 
     /**
-     * Increase the count of a attached <code>Example</code> topic.
+     * Increase the count of an attached <code>Example</code> topic.
      */
     @GET