(no commit message)
[devwiki.git] / design / revisedclientarchitecture.mdwn
index 9bfc5d0..39327cc 100644 (file)
@@ -1,4 +1,5 @@
 ## Revised Client Architecture
+(Note that an alternative proposal is under discussion in the mailing list thread starting at <https://www.jiscmail.ac.uk/cgi-bin/webadmin?A2=MOONSHOT-COMMUNITY;bb2718c3.1112>)
 
 The architecture of the initial implementation needs to be re-factored to give better Model, View, Controller separation, allowing for:
 
@@ -35,22 +36,17 @@ The re-factored Moonshot Client software will have the following components:
 
 *_identity-storage-server_*  encapsulates the Identity Store in a library offering a CRUD API which _identity-manager-lib_ uses to access the store.
 
-- is accessed directly *only* by _identity-manager-lib_. 
-- protects the store from multiple concurrent write accesses.
-- re-implemented per platform and per storage strategy so:
-
-  * one version each for Linux, Mac OS and Windows, local storage. DBus provides an appropriate mechanism under Linux (and possibly Mac OS X) for protecting the store from multiple concurrent write access. DBus is not supported on Windows, so the Windows implementation will use a different mechanism. This version will re-use storage-related code from src/moonshot-window.vala etc. The Mac implementation will either use DBus, or it will use the Mac OS X Keychain to store identities (see mailing list thread beginning [here](https://www.jiscmail.ac.uk/cgi-bin/webadmin?A2=ind1112&L=MOONSHOT-COMMUNITY&F=&S=&X=2C162240A9A66326F2&P=3272)).
-  * one version for web storage, restful API. (Not in scope for this iteration).
-  * other versions as required for different storage solutions  (Not in scope for this iteration).
-
 *_identity-provisioning_* - not implemented in the initial implementation. Provides CRUD operations via files and via the command line. Implemented in portable code as far as possible. Uses _identity-manager-lib_ and *_identity-manager-ui-lib_*. Consists of:
 
-- *_identity-provisioning-file-handler_* - processes .msht (and, in future iterations, json, and maybe other format) files for file-based provisioning operations. .msht is an an XML-based file format. The MIME type os 'application/moonshot+xml'. An association is created on install so that these files are automatically opened by _identity-provisioning-file-handler_ when clicked. Currently implemented as *_moonshot-webp_*, allowing only install access. In future iterations it will also allow uninstall/revoke access. 
+- *_identity-provisioning-file-handler_* - processes .msht (and, in future iterations, json, and maybe other format) files for file-based provisioning operations. .msht is an an XML-based file format. The MIME type is 'application/moonshot+xml'. An association is created on install so that these files are automatically opened by _identity-provisioning-file-handler_ when clicked. Currently implemented as *_moonshot-webp_*, allowing only install access. In future iterations it will also allow uninstall/revoke access. 
 
 - *_identity-provisioning-cli-handler_* - provides a command line API to identity CRUD functions
 
 All of the components will be implemented in Vala. 
 
+### Detail _identity-manager-app_ component
+This app uses the APIS provided by _identity-manager-ui-lib_ to provide a UI allowing the User to manage their stored identities.
+
 ### Detail _identity-manager-ui-lib_ component
 
 Implemented as a shared library in Vala. Built with the -H option to enable access from C code, and introspection generated to allow use from other languages.
@@ -79,13 +75,17 @@ Uses the APIs provided by the *_identity-storage-server_* component (_-dbus-loca
 
 It has no UI, so that it can be used in circumstances where interaction with a user is not possible (e.g. in headless servers). Any needed interaction with the User is done by client software.
 
-### Implementation Note
+**Implementation Note:** In this architectural view, _identity-manager-ui-lib_ and _identity-manager-lib_ have distinct roles. They could therefore be implemented as separate libraries, but it is probably better to combine them in a single library. In my view this would have advantages both for those implementing and for those using the software.
+
+### Detail _identity-storage-server_ component
+- is accessed directly *only* by _identity-manager-lib_. 
+- protects the store from multiple concurrent write accesses.
+- re-implemented per platform and per storage strategy so:
 
-In this architectural view, _identity-manager-ui-lib_ and _identity-manager-lib_ have distinct roles. They could therefore be implemented as separate libraries, but it is probably better to combine them in a single library. In my view this would have advantages both for those implementing and for those using the software.
+  * one version each for Linux, Mac OS and Windows, local storage. DBus provides an appropriate mechanism under Linux (and possibly Mac OS X) for protecting the store from multiple concurrent write access. DBus is not supported on Windows, so the Windows implementation will use a different mechanism. This version will re-use storage-related code from src/moonshot-window.vala etc. The Mac implementation will either use DBus, or it will use the Mac OS X Keychain to store identities (see mailing list thread beginning [here](https://www.jiscmail.ac.uk/cgi-bin/webadmin?A2=ind1112&L=MOONSHOT-COMMUNITY&F=&S=&X=2C162240A9A66326F2&P=3272)).
+  * one version for web storage, restful API. (Not in scope for this iteration).
+  * other versions as required for different storage solutions  (Not in scope for this iteration).
 
-### Detail _identity_manager_app_ component
-This app provides a UI allowing the USer to manage their stored identities.
 
 ### Detail _identity-provisioning_ component