doc/afb-daemon-vocabulary.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta charset="utf-8">
   5   <meta name="generator" content="pandoc">
   6   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
   7   <meta name="author" content="José Bollo">
   8   <title>Vocabulary for AFB-DAEMON</title>
   9   <style type="text/css">code{white-space: pre;}</style>
  10   <!--[if lt IE 9]>
  11     <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
  12   <![endif]-->
  13   <link rel="stylesheet" href="doc.css">
  14 </head>
  15 <body>
  16 <header>
  17 <h1 class="title">Vocabulary for AFB-DAEMON</h1>
  18 <h2 class="author">José Bollo</h2>
  19 <h3 class="date">27 mai 2016</h3>
  20 </header>
  21 <nav id="TOC">
  22 <ul>
  23 <li><a href="#vocabulary-for-afb-daemon">Vocabulary for AFB-DAEMON</a><ul>
  24 <li><a href="#event">Event</a></li>
  25 <li><a href="#level-of-assurance-loa">Level of assurance (LOA)</a></li>
  26 <li><a href="#plugin">Plugin</a></li>
  27 <li><a href="#request">Request</a></li>
  28 <li><a href="#replyresponse">Reply/Response</a></li>
  29 <li><a href="#service">Service</a></li>
  30 <li><a href="#session">Session</a></li>
  31 <li><a href="#token">Token</a></li>
  32 <li><a href="#uuid">UUID</a></li>
  33 <li><a href="#x-afb-reqid">x-afb-reqid</a></li>
  34 <li><a href="#x-afb-token">x-afb-token</a></li>
  35 <li><a href="#x-afb-uuid">x-afb-uuid</a></li>
  36 </ul></li>
  37 </ul>
  38 </nav>
  39 <h1 id="vocabulary-for-afb-daemon">Vocabulary for AFB-DAEMON</h1>
  40 <pre><code>version: 1
  41 Date:    27 mai 2016
  42 Author:  José Bollo</code></pre>
  43 <h2 id="event">Event</h2>
  44 <p>Message with data propagated from the services to the client and not expecting any reply.</p>
  45 <p>The current implementation allows to widely broadcast events to all clients.</p>
  46 <h2 id="level-of-assurance-loa">Level of assurance (LOA)</h2>
  47 <p>This level that can be from 0 to 3 represent the level of assurance that the services can expect from the session.</p>
  48 <p>The exact definition of the meaning of this levels and of how to use it remains to be achived.</p>
  49 <h2 id="plugin">Plugin</h2>
  50 <p>A shared library object intended to be plug to an afb-daemon instance to implement an API.</p>
  51 <h2 id="request">Request</h2>
  52 <p>A request is an invocation by a client to a method of a plugin using a message transfered through some protocol: HTTP, WebSocket, DBUS... served by afb-daemon</p>
  53 <h2 id="replyresponse">Reply/Response</h2>
  54 <p>This is a message sent to client as the result of the request.</p>
  55 <h2 id="service">Service</h2>
  56 <p>Service are made of plugins runnning by their side on their binder. It can serve many client. Each one being attached to one session.</p>
  57 <p>The framework establishes the connection between the services and the clients. Using DBus currently.</p>
  58 <h2 id="session">Session</h2>
  59 <p>A session is meant to be the unic context of an instance of client, identifying that instance across requests.</p>
  60 <p>Each session has an identifier. Session identifier generated by afb-daemon are UUIDs.</p>
  61 <p>Internally, afb-daemon offers a mechanism to attach data to sessions. When the session is closed or disappears, the data attached to that session are freed.</p>
  62 <h2 id="token">Token</h2>
  63 <p>The token is an identifier that the the client must give to be authentificated.</p>
  64 <p>At start, afb-daemon get an initial token. This initial token must be presented incoming client to be authentificated.</p>
  65 <p>A token is valid only for a period.</p>
  66 <p>The token must be renewed periodically. When the token is renewed, afb-daemon sends the new token to the client.</p>
  67 <p>Tokens generated by afb-daemon are UUIDs.</p>
  68 <h2 id="uuid">UUID</h2>
  69 <p>It stand for Universal Unic IDentifier.</p>
  70 <p>Its is designed to create identifier in a way that avoid has much as possible conflicts. It means that if two differents instance create a UUID, the probability that they create the same UUID is very low, near to zero.</p>
  71 <h2 id="x-afb-reqid">x-afb-reqid</h2>
  72 <p>Argument name that can be used with HTTP request. When this argument is given, it is automatically added to the &quot;request&quot; object of the answer.</p>
  73 <h2 id="x-afb-token">x-afb-token</h2>
  74 <p>Argument name for giving the token without ambiguity. You can also use the name <strong>token</strong> but it may conflicts with other arguments.</p>
  75 <h2 id="x-afb-uuid">x-afb-uuid</h2>
  76 <p>Argument name for giving explicitely the session identifier without ambiguity. You can also use the name <strong>uuid</strong> but it may conflicts with other arguments.</p>
  77 </body>
  78 </html>