Changes between Version 2 and Version 3 of ArchitectureOverview

Timestamp:

07.05.2013 02:17:45 (11 years ago)

Author:

jri

Comment:

DeepaMehta Core, DeepaMehta Plugins

ArchitectureOverview

@@ -7 +7 @@
 [[Image(Architecture.png)]]
 
-DeepaMehta Core
+A central part of DeepaMehta is its plugin development framework. A DeepaMehta plugin is an OSGi bundle. However the DeepaMehta plugin developer must not know about OSGi intrinsics. Instead the developer can rely on facilities provided by the DeepaMehta Core.
 
-* Provides the DeepaMehta Core Service.
+== DeepaMehta Core ==
+
+The DeepaMehta Core is a dedicated OSGi bundle. Its responsibilities comprise:
+
+* Mediating between the DeepaMehta plugins and the underlying OSGi environment. The plugin developer must not know about OSGi intrinsics.
+
+* Providing the //DeepaMehta Core Service//.
     * Offers transactional database access to handle DeepaMehta's basic entities: topics, associations, topic types, association types.
     * Supports creating/retrieving/updating/deleting composite topic structures by levereging the type definitions.
 
-* Mediates between the DeepaMehta plugins and the underlying OSGi environment. The plugin developer must not know about the OSGi intrinsics.
+* Firing //DeepaMehta Core Events//.
 
-* Defines a DB-agnostic service provider interface for the storage layer. By implementing this interface developers can adapt DeepaMehta to any database system. The DeepaMehta Standard Distribution comes with an Neo4j-based implementation.
+* The //Migration Manager// ensures the database model and content is compatible with the installed plugins. It does so by running database migrations when a plugin is installed or updated.
+
+* Defining a DB-agnostic low-level service provider interface for the storage layer. By implementing this interface developers can deploy any database system as the DeepaMehta storage.
+
+== DeepaMehta Plugins ==
+
+A DeepaMehta plugin can have several parts:
+
+* **A data model**. The data model is a collection of domain-specific topic types and/or association types.
+
+* **Server-side logic**. Server-side logic comes in form of a) event handlers, and/or b) service methods. Server-side logic is written in Java.
+
+* **Client-side logic**. Client-side logic runs inside the DeepaMehta Webclient. Client-side logic comes in form of a) event handlers, b) custom renderers, and/or c) public API methods. Client-side logic is written in JavaScript?.
+
+Each of these parts is optional. Which parts a plugin provides depends on its purpose.
+
+== DeepaMehta Webclient ==
+
+== Storage Implementation ==
+
+The default storage implementation embeds Neo4j. Neo4j is accessed via its native Java API.