diff options
Diffstat (limited to 'docs/2.2-config.xml.md')
| -rw-r--r-- | docs/2.2-config.xml.md | 276 |
1 files changed, 127 insertions, 149 deletions
diff --git a/docs/2.2-config.xml.md b/docs/2.2-config.xml.md index c50567d..f6c88ab 100644 --- a/docs/2.2-config.xml.md +++ b/docs/2.2-config.xml.md @@ -1,12 +1,10 @@ -Configuration file - config.xml -=============================== +# Configuration file - config.xml The widgets are described by the W3C's technical recommendations [Packaged Web Apps (Widgets)][widgets] and [XML Digital Signatures for Widgets][widgets-digsig] that specifies the configuration file **config.xml**. -Overview --------- +## Overview The file **config.xml** describes important data of the application to the framework: @@ -50,8 +48,7 @@ The most important items are: - **<content src="..." type="..."\>**: this indicates the entry point and its type. -Standard elements of "config.xml" ---------------------------------- +## Standard elements of "config.xml" ### The element widget @@ -74,7 +71,7 @@ Values for *version* are any non empty string containing only latin letters, arabic digits, and the three characters '.' (dot), '-' (dash) and '\_' (underscore). -Version values are dot separated fields MAJOR.MINOR.REVISION. +Version values are dot separated fields MAJOR.MINOR.REVISION. Such version would preferably follow guidelines of [semantic versioning][semantic-version]. @@ -90,8 +87,7 @@ The content designed depends on its type. See below for the known types. The element *icon* is mandatory (for version 2.x, blowfish) and must be unique. It must designate an image file with its attribute *src*. -AGL features ------------- +## AGL features The AGL framework uses the feature tag for specifying security and binding requirement of the widget. @@ -99,31 +95,34 @@ requirement of the widget. Since the migration of the framework to leverage systemd power, the features are of important use to: - - declare more than just an application - - declare the expected dependencies - - declare the expected permissions - - declare the exported apis +- declare more than just an application +- declare the expected dependencies +- declare the expected permissions +- declare the exported apis The specification of [widgets][widgets] is intended to describe -only one application. In the present case, we expect to describe -more than just an application. For example, a publisher could -provide a widget containing a service, an application for tuning -that service, an application that leverage the service. +only one application. +In the present case, we expect to describe more than just an application. +For example, a publisher could provide a widget containing a service, +an application for tuning that service, an application that +leverage the service. Here, the term of service means a background application that runs without IHM and whose public api can be accessed by other applications. So the features are used to describe each of the possible -units of widgets. The "standard" unit in the -meaning of [widgets][widgets] is called the "main" unit. +units of widgets. +The "standard" unit in the meaning of [widgets][widgets] +is called the "main" unit. -### feature name="urn:AGL:widget:required-api" +### required-api: feature name="urn:AGL:widget:required-api" List of the api required by the widget. -Each required api must be explicited using a <param> entry. +Each required api must be explicited using a `<param>` entry. Example: + ```xml <feature name="urn:AGL:widget:required-api"> <param name="#target" value="main" />> @@ -133,6 +132,7 @@ Example: ``` This will be *virtually* translated for mustaches to the JSON + ```json "required-api": [ { "name": "gps", "value": "auto" }, @@ -140,56 +140,50 @@ This will be *virtually* translated for mustaches to the JSON ] ``` -#### param name="#target" +#### required-api: param name="#target" OPTIONAL Declares the name of the unit requiring the listed apis. -Only one instance of the param "#target" is allowed. +Only one instance of the param "#target" is allowed. When there is not instance of this param, it behave as if the target main was specified. -#### param name=[required api name] +#### required-api: param name=[required api name] The name is the name of the required API. -The value describes how to connect to the required api. +The value describes how to connect to the required api. It is either: - - local: - - The binding is a local shared object. - In that case, the name is the relative path of the - shared object to be loaded. - - - auto: - - The framework set automatically the kind of - the connection to the API +- local: + The binding is a local shared object. + In that case, the name is the relative path of the + shared object to be loaded. - - ws: +- auto: + The framework set automatically the kind of + the connection to the API - The framework connect using internal websockets +- ws: + The framework connect using internal websockets - - dbus: +- dbus: + The framework connect using internal dbus - The framework connect using internal dbus +- link: + The framework connect in memory by dynamically linking - - link: +- cloud: [PROPOSAL - NOT IMPLEMENTED] + The framework connect externally using websock. + In that case, the name includes data to access the service. + Example: `<param name="log:https://oic@agl.iot.bzh/cloud/log" value="cloud" />` - The framework connect in memory by dynamically linking - - - cloud: [PROPOSAL - NOT IMPLEMENTED] - - The framework connect externally using websock. - In that case, the name includes data to access the service. - Example: `<param name="log:https://oic@agl.iot.bzh/cloud/log" value="cloud" />` - -### feature name="urn:AGL:widget:required-permission" +### required-permission: feature name="urn:AGL:widget:required-permission" List of the permissions required by the unit. -Each required permission must be explicited using a <param> entry. +Each required permission must be explicited using a `<param>` entry. Example: @@ -216,31 +210,32 @@ This will be *virtually* translated for mustaches to the JSON } ``` -#### param name="#target" +#### required-permission: param name="#target" OPTIONAL -Declares the name of the unit requiring the listed permissions. -Only one instance of the param "#target" is allowed. +Declares the name of the unit requiring the listed permissions. +Only one instance of the param "#target" is allowed. When there is not instance of this param, it behave as if the target main was specified. -#### param name=[required permission name] +#### required-permission: param name=[required permission name] The value is either: - required: the permission is mandatorily needed except if the feature -isn't required (required="false") and in that case it is optional. + isn't required (required="false") and in that case it is optional. - optional: the permission is optional - -### feature name="urn:AGL:widget:provided-unit" +### provided-unit: feature name="urn:AGL:widget:provided-unit" This feature is made for declaring new units -for the widget. Using this feature, a software publisher +for the widget. +Using this feature, a software publisher can provide more than one application in the same widget. Example: + ```xml <feature name="urn:AGL:widget:provided-unit"> <param name="#target" value="geoloc" /> @@ -251,6 +246,7 @@ Example: ``` This will be *virtually* translated for mustaches to the JSON + ```json { "#target":"geoloc", @@ -263,41 +259,40 @@ This will be *virtually* translated for mustaches to the JSON } ``` -#### param name="#target" +#### provided-unit: param name="#target" REQUIRED Declares the name of the unit. The default unit, the unit -of the main of the widget, has the name "main". The value -given here must be unique within the widget file. It will -be used in other places of the widget config.xml file to +of the main of the widget, has the name "main". +The value given here must be unique within the widget file. +It will be used in other places of the widget config.xml file to designate the unit. -Only one instance of the param "#target" is allowed. +Only one instance of the param "#target" is allowed. The value can't be "main". -#### param name="content.type" +#### provided-unit: param name="content.type" REQUIRED The mimetype of the provided unit. -#### param name="content.src" +#### provided-unit: param name="content.src" -A path to the +A path to the source #### other parameters The items that can be set for the main unit can also be set using the params if needed. - - description - - name.content - - name.short - - ... +- description +- name.content +- name.short +- ... - -### feature name="urn:AGL:widget:provided-api" +### provided-api: feature name="urn:AGL:widget:provided-api" Use this feature for exporting one or more API of a unit to other widgets of the platform. @@ -329,78 +324,70 @@ This will be *virtually* translated for mustaches to the JSON ], ``` -#### param name="#target" - +#### provided-api: param name="#target" OPTIONAL -Declares the name of the unit exporting the listed apis. -Only one instance of the param "#target" is allowed. +Declares the name of the unit exporting the listed apis. +Only one instance of the param "#target" is allowed. When there is not instance of this param, it behave as if the target main was specified. - -#### param name=[name of exported api] +#### provided-api: param name=[name of exported api] The name give the name of the api that is exported. The value is one of the following values: - - ws: - - export the api using UNIX websocket - - - dbus: - - export the API using dbus +- ws: + export the api using UNIX websocket - - auto: +- dbus: + export the API using dbus - export the api using the default method(s). +- auto: + export the api using the default method(s). - -Known content types -------------------- +## Known content types The configuration file ***/etc/afm/afm-unit.conf*** defines how to create systemd units for widgets. Known types for the type of content are: -- ***text/html***: - HTML application, - content.src designates the home page of the application +- ***text/html***: + HTML application, + content.src designates the home page of the application -- ***application/vnd.agl.native*** - AGL compatible native, - content.src designates the relative path of the binary. +- ***application/vnd.agl.native*** + AGL compatible native, + content.src designates the relative path of the binary. -- ***application/vnd.agl.service***: - AGL service, content.src is not used. +- ***application/vnd.agl.service***: + AGL service, content.src is not used. -- ***application/x-executable***: - Native application, - content.src designates the relative path of the binary. - For such application, only security setup is made. +- ***application/x-executable***: + Native application, + content.src designates the relative path of the binary. + For such application, only security setup is made. Adding more types is easy, it just need to edit the configuration file ***afm-unit.conf***. -### Older content type currently not supported at the moment. +### Older content type currently not supported at the moment This types were defined previously when the framework was not -leveraging systemd. The transition to systemd let these types -out at the moment. +leveraging systemd. +The transition to systemd let these types out at the moment. - ***application/vnd.agl.url*** - ***text/vnd.qt.qml***, ***application/vnd.agl.qml*** - ***application/vnd.agl.qml.hybrid*** - ***application/vnd.agl.html.hybrid*** - <!-- pagebreak --> -The configuration file afm-unit.conf -==================================== + +## The configuration file afm-unit.conf The integration of the framework with systemd mainly consists of creating the systemd unit @@ -410,9 +397,9 @@ of the installed widgets. This configuration file named `afm-unit.conf` installed on the system with the path `/etc/afm/afm-unit.conf` describes how to generate all units from the *config.xml* -configuration files of widgets. The description uses an extended -version of the templating formalism of [mustache][] -to describes all the units. +configuration files of widgets. +The description uses an extended version of the templating +formalism of [mustache][] to describes all the units. Let present how it works using the following diagram that describes graphically the workflow of creating the unit @@ -423,8 +410,8 @@ file of the widget `config.xml`: In a first step, and because [mustache][] is intended to work on JSON representations, the configuration file is -translated to an internal JSON representation. This -representation is shown along the examples of the documentation +translated to an internal JSON representation. +This representation is shown along the examples of the documentation of the config files of widgets. In a second step, the mustache template `afm-unit.conf` @@ -432,49 +419,43 @@ is instantiated using the C library [mustach][] that follows the rules of [mustache][mustache] and with all its available extensions: - - use of colon (:) for explicit substitution - - test of values with = or =! +- use of colon (:) for explicit substitution +- test of values with = or =! In a third step, the result of instantiating `afm-unit.conf` -for the widget is split in units. To achieve that goal, -the lines containing specific directives are searched. -Any directive occupy one full line. The directives are: - - - %nl - - Produce an empty line at the end - - - %begin systemd-unit - - %end systemd-unit - - Delimit the produced unit, its begin and its end - - - %systemd-unit user - - %systemd-unit system - - Tells the kind of unit (user/system) - - - %systemd-unit service NAME - - %systemd-unit socket NAME - - Gives the name and type (service or socket) of the unit. - The extension is automatically computed from the type - and must not be set in the name. - - - %systemd-unit wanted-by NAME - - Tells to install a link to the unit in the wants of NAME +for the widget is split in units. +To achieve that goal, the lines containing specific directives are searched. +Any directive occupy one full line. +The directives are: + +- %nl + Produce an empty line at the end +- %begin systemd-unit +- %end systemd-unit + Delimit the produced unit, its begin and its end +- %systemd-unit user +- %systemd-unit system + Tells the kind of unit (user/system) +- %systemd-unit service NAME +- %systemd-unit socket NAME + Gives the name and type (service or socket) of the unit. + The extension is automatically computed from the type + and must not be set in the name. +- %systemd-unit wanted-by NAME + Tells to install a link to the unit in the wants of NAME Then the computed units are then written to the filesystem and inserted in systemd. The generated unit files will contain variables for internal -use of the framework. These variables are starting with `X-AFM-`. +use of the framework. +These variables are starting with `X-AFM-`. The variables starting with `X-AFM-` but not with `X-AFM--` are -the public variables. These variables will be returned by the +the public variables. +These variables will be returned by the framework as the details of an application (see **afm-util detail ...**). -Variables starting with `X-AFM--` are private to the framework. +Variables starting with `X-AFM--` are private to the framework. By example, the variable `X-AFM--http-port` is used to record the allocated port for applications. @@ -495,6 +476,3 @@ record the allocated port for applications. [tizen-security]: https://wiki.tizen.org/wiki/Security "Tizen security home page" [tizen-secu-3]: https://wiki.tizen.org/wiki/Security/Tizen_3.X_Overview "Tizen 3 security overview" [semantic-version]: http://semver.org/ "Semantic versioning" - - - |