X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=doc%2Fafm-system-daemon.html;h=4569bc2c0a8b84cfd6938d7e0c23fe3d58a47023;hb=1.0;hp=dac4315af3d2e3af04b6bdfec88157b62e54a719;hpb=f2bde701a9873c69897e599a7da08a0d113a86ab;p=src%2Fapp-framework-main.git diff --git a/doc/afm-system-daemon.html b/doc/afm-system-daemon.html index dac4315..4569bc2 100644 --- a/doc/afm-system-daemon.html +++ b/doc/afm-system-daemon.html @@ -8,37 +8,55 @@

The afm-system-daemon

version: 1
-Date:    15 March 2016
+Date:    30 mai 2016
 Author:  José Bollo
 
+

+

Foreword

-

This document describes what we intend to do. It may happen that our -current implementation and the content of this document differ.

- -

In case of differences, it is assumed that this document is right -and the implementation is wrong.

+

This document describes application framework system daemon fundamentals. +FCF (Fully Conform to Specification) implementation is still under development. +It may happen that current implementation somehow diverges with specifications.

Introduction

The daemon afm-system-daemon is in charge of installing -applications on the system. Its main tasks are:

+applications on AGL system. Its main tasks are:

-

The afm-system-daemon takes its orders from the system +

The afm-system-daemon takes its orders from system instance of D-Bus.

-

The figure below summarizes the situation of the -afm-system-daemon in the system.

+

The figure below summarizes the situation of afm-system-daemon in the system.

+------------------------------------------------------------+
 |                          User                              |
@@ -76,30 +94,30 @@ located at /lib/systemd/system/afm-system-daemon.service.

-r
 --root directory
 
-     Set the root application directory.
+ Set the root application directory.
 
-     Note that the default root directory is defined
-     to be /usr/share/afm/applications (may change).
+ Note that the default root directory is defined
+ to be /usr/share/afm/applications (may change).
 
 -d
 --daemon
 
-     Daemonizes the process. It is not needed by sytemd.
+ Daemonizes the process. It is not needed by sytemd.
 
 -q
 --quiet
 
-     Reduces the verbosity (can be repeated).
+ Reduces the verbosity (can be repeated).
 
 -v
 --verbose
 
-     Increases the verbosity (can be repeated).
+ Increases the verbosity (can be repeated).
 
 -h
 --help
 
-     Prints a short help.
+ Prints a short help.
 
@@ -121,7 +139,7 @@ members install and uninstall -

The client and the service are using JSON serialisation to +

The client and the service are using JSON serialization to exchange data.

The D-Bus interface is defined by:

@@ -136,16 +154,16 @@ exchange data.

The signature of any member of the interface is string -> string for JSON -> JSON.

-

This is the normal case. In case of error, the current implmentation +

This is the normal case. In case of error, the current implementation returns a dbus error that is a string.

-

Here is an example that use dbus-send to query data on +

Here is an example using dbus-send to query data on installed applications.

dbus-send --session --print-reply \
-    --dest=org.AGL.afm.system \
-    /org/AGL/afm/system \
-    org.AGL.afm.system.install 'string:"/tmp/appli.wgt"'
+--dest=org.AGL.afm.system \
+/org/AGL/afm/system \
+org.AGL.afm.system.install 'string:"/tmp/appli.wgt"'
 
@@ -156,24 +174,23 @@ installed applications.

Method org.AGL.afm.system.install

-

Description: Install an application from its widget file.

+

Description: Install an application from a widget file.

-

If an application of the same id and version exists, it is not -reinstalled except if force=true.

+

When an application with the same id and version already exists. Outside of +using force=true the application is not reinstalled.

-

Applications are installed in the subdirectories of the common directory -of applications. +

Applications are installed the subdirectories of applications common directory. If root is specified, the application is installed under the sub-directories of the root defined.

-

Note that this methods is a simple accessor to the method -org.AGL.afm.system.install of afm-system-daemon.

+

Note that this methods is a simple accessor method of +org.AGL.afm.system.install from afm-system-daemon.

After the installation and before returning to the sender, -afm-system-daemon sends the signal org.AGL.afm.system.changed.

+afm-system-daemon sends a signal org.AGL.afm.system.changed.

-

Input: The path of the widget file to install and, optionaly, -a flag to force reinstallation, and, optionaly, a root directory.

+

Input: The path of the widget file to install and, optionally, +a flag to force reinstallation, and, optionally, a root directory.

Either just a string being the absolute path of the widget file:

@@ -204,14 +221,13 @@ the id of the added application.

Description: Uninstall an application from its id.

-

Note that this methods is a simple accessor to the method -org.AGL.afm.system.uninstall of afm-system-daemon.

+

Note that this methods is a simple method accessor of +org.AGL.afm.system.uninstall from afm-system-daemon.

After the uninstallation and before returning to the sender, -afm-system-daemon sends the signal org.AGL.afm.system.changed.

+afm-system-daemon sends a signal org.AGL.afm.system.changed.

-

Input: the id of the application and, otpionaly, the path to -root of the application.

+

Input: the id of the application and optionally the application root path.

Either a string: