<meta charset="utf-8">
<meta name="generator" content="pandoc">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
+ <meta name="author" content="José Bollo">
<title>Writing the configuration file "config.xml"</title>
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css">
<body>
<header>
<h1 class="title">Writing the configuration file "config.xml"</h1>
-<h3 class="date">02 septembre 2016</h3>
+<h2 class="author">José Bollo</h2>
+<h3 class="date">12 septembre 2016</h3>
</header>
<nav id="TOC">
<ul>
</ul></li>
<li><a href="#known-widget-types-and-content">Known widget types and content</a></li>
<li><a href="#agl-features">AGL features</a><ul>
+<li><a href="#feature-nameurnaglrequired-binding">feature name="urn:AGL:required-binding"</a></li>
+<li><a href="#feature-nameurnaglrequired-permissions">feature name="urn:AGL:required-permissions"</a></li>
<li><a href="#feature-nameurnaglprovides-binding">feature name="urn:AGL:provides-binding"</a></li>
-<li><a href="#feature-nameurnaglrequired-permission">feature name="urn:AGL:required-permission"</a></li>
-<li><a href="#feature-nameurnagl-permission">feature name="urn:AGL:-permission"</a></li>
+<li><a href="#feature-nameurnagldefined-permissions">feature name="urn:AGL:defined-permissions"</a></li>
</ul></li>
</ul></li>
</ul>
<p>The AGL framework uses the feature tag for specifying security and binding requirement of the widget.</p>
<p>The current version of AGL (up to 2.0.1, blowfish) has no fully implemented features.</p>
<p>The features planned to be implemented are described below.</p>
+<h3 id="feature-nameurnaglrequired-binding">feature name="urn:AGL:required-binding"</h3>
+<p>List of the bindings required by the widget.</p>
+<p>Each required binding must be explicited using a <param> entry.</p>
+<h4 id="param-namerequired-binding-name">param name=[required binding name]</h4>
+<p>The value is either:</p>
+<ul>
+<li>required: the binding is mandatorily needed except if the feature isn't required (required="false") and in that case it is optional.</li>
+<li>optional: the binding is optional</li>
+</ul>
+<h3 id="feature-nameurnaglrequired-permissions">feature name="urn:AGL:required-permissions"</h3>
+<p>List of the permissions required by the widget.</p>
+<p>Each required permission must be explicited using a <param> entry.</p>
+<h4 id="param-namerequired-permission-name">param name=[required permission name]</h4>
+<p>The value is either:</p>
+<ul>
+<li>required: the permission is mandatorily needed except if the feature isn't required (required="false") and in that case it is optional.</li>
+<li>optional: the permission is optional</li>
+</ul>
<h3 id="feature-nameurnaglprovides-binding">feature name="urn:AGL:provides-binding"</h3>
<p>Use this feature for each provided binding of the widget. The parameters are:</p>
-<h5 id="param-namename">param name="name"</h5>
+<h4 id="param-namename">param name="name"</h4>
<p>REQUIRED</p>
<p>The value is the string that must match the binding prefix. It must be unique.</p>
-<h5 id="param-namesrc">param name="src"</h5>
+<h4 id="param-namesrc">param name="src"</h4>
<p>REQUIRED</p>
<p>The value is the path of the shared library for the binding.</p>
-<h5 id="param-nametype">param name="type"</h5>
+<h4 id="param-nametype">param name="type"</h4>
<p>REQUIRED</p>
<p>Currently it must be <strong><em>application/vnd.agl.binding.v1</em></strong>.</p>
-<h5 id="param-namescope">param name="scope"</h5>
+<h4 id="param-namescope">param name="scope"</h4>
<p>REQUIRED</p>
<p>The value indicate the availability of the binidng:</p>
<ul>
<li>public: available to allowed clients as a remote service (requires permission+)</li>
<li>inline: available to allowed clients inside their binding (unsafe, requires permission+++)</li>
</ul>
-<h5 id="param-nameneeded-binding">param name="needed-binding"</h5>
+<h4 id="param-nameneeded-binding">param name="needed-binding"</h4>
<p>OPTIONAL</p>
<p>The value is a space separated list of binding's names that the binding needs.</p>
-<h3 id="feature-nameurnaglrequired-permission">feature name="urn:AGL:required-permission"</h3>
-<p>Several permission can be listed or none whether no permission is requested for the widget.</p>
+<h3 id="feature-nameurnagldefined-permissions">feature name="urn:AGL:defined-permissions"</h3>
<p>Each required permission must be explicited using a <param> entry.</p>
-<h5 id="param-namerequired-permission-name">param name=[required permission name]</h5>
-<p>The value is either:</p>
+<h4 id="param-namedefined-permission-name">param name=[defined permission name]</h4>
+<p>The value is the level of the defined permission. Standard levels are:</p>
<ul>
-<li>required: the permission is really needed.</li>
-<li>optional: the permission isn't mandatory</li>
+<li>system</li>
+<li>platform</li>
+<li>partner</li>
+<li>public</li>
</ul>
-<h3 id="feature-nameurnagl-permission">feature name="urn:AGL:-permission"</h3>
+<p>This level defines the level of accreditation required to get the given permission. The accreditions are given by signatures of widgets.</p>
</body>
</html>
The features planned to be implemented are described below.
+### feature name="urn:AGL:required-binding"
+
+List of the bindings required by the widget.
+
+Each required binding must be explicited using a <param> entry.
+
+#### param name=[required binding name]
+
+The value is either:
+
+- required: the binding is mandatorily needed except if the feature
+isn't required (required="false") and in that case it is optional.
+- optional: the binding is optional
+
+### feature name="urn:AGL:required-permissions"
+
+List of the permissions required by the widget.
+
+Each required permission must be explicited using a <param> entry.
+
+#### 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.
+- optional: the permission is optional
+
### feature name="urn:AGL:provides-binding"
Use this feature for each provided binding of the widget.
The value is a space separated list of binding's names that the binding needs.
-### feature name="urn:AGL:required-permissions"
-
-List of the permissions required by the widget.
-
-Each required permission must be explicited using a <param> entry.
-
-#### 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.
-- optional: the permission is optional
-
### feature name="urn:AGL:defined-permissions"
Each required permission must be explicited using a <param> entry.
#### param name=[defined permission name]
-The value is the level of the defined permission:
+The value is the level of the defined permission.
+Standard levels are:
-- system:
-- platform:
+- system
+- platform
- partner
-- public:
-
+- public
+This level defines the level of accreditation required to get the given
+permission. The accreditions are given by signatures of widgets.
Code Review / src / app-framework-main.git / commitdiff