doc/afb-daemon-vocabulary.html

   1 <html>
   2 <head>
   3   <link rel="stylesheet" type="text/css" href="doc.css">
   4   <meta charset="UTF-8">
   5 </head>
   6 <body>
   7 <a name="Vocabulary.for.AFB-DAEMON"></a>
   8 <h1>Vocabulary for AFB-DAEMON</h1>
   9
  10 <pre><code>version: 1
  11 Date:    27 mai 2016
  12 Author:  José Bollo
  13 </code></pre>
  14
  15 <p><ul>
  16  <li><a href="#Vocabulary.for.AFB-DAEMON">Vocabulary for AFB-DAEMON</a>
  17  <ul>
  18   <li><a href="#Event">Event</a></li>
  19   <li><a href="#Level.of.assurance..LOA.">Level of assurance (LOA)</a></li>
  20   <li><a href="#Plugin">Plugin</a></li>
  21   <li><a href="#Request">Request</a></li>
  22   <li><a href="#Reply.Response">Reply/Response</a></li>
  23   <li><a href="#Service">Service</a></li>
  24   <li><a href="#Session">Session</a></li>
  25   <li><a href="#Token">Token</a></li>
  26   <li><a href="#UUID">UUID</a></li>
  27   <li><a href="#x-afb-reqid">x-afb-reqid</a></li>
  28   <li><a href="#x-afb-token">x-afb-token</a></li>
  29   <li><a href="#x-afb-uuid">x-afb-uuid</a></li>
  30  </ul>
  31  </li>
  32 </ul></p>
  33
  34 <a name="Event"></a>
  35 <h2>Event</h2>
  36
  37 <p>Message with data propagated from the services to the client and not expecting
  38 any reply.</p>
  39
  40 <p>The current implementation allows to widely broadcast events to all clients.</p>
  41
  42 <a name="Level.of.assurance..LOA."></a>
  43 <h2>Level of assurance (LOA)</h2>
  44
  45 <p>This level that can be from 0 to 3 represent the level of
  46 assurance that the services can expect from the session.</p>
  47
  48 <p>The exact definition of the meaning of this levels and of
  49 how to use it remains to be achived.</p>
  50
  51 <a name="Plugin"></a>
  52 <h2>Plugin</h2>
  53
  54 <p>A shared library object intended to be plug to an afb-daemon instance
  55 to implement an API.</p>
  56
  57 <a name="Request"></a>
  58 <h2>Request</h2>
  59
  60 <p>A request is an invocation by a client to a method of a plugin using a message
  61 transfered through some protocol: HTTP, WebSocket, DBUS&hellip; served by afb-daemon</p>
  62
  63 <a name="Reply.Response"></a>
  64 <h2>Reply/Response</h2>
  65
  66 <p>This is a message sent to client as the result of the request.</p>
  67
  68 <a name="Service"></a>
  69 <h2>Service</h2>
  70
  71 <p>Service are made of plugins runnning by their side on their binder.
  72 It can serve many client. Each one being attached to one session.</p>
  73
  74 <p>The framework establishes the connection between the services and
  75 the clients. Using DBus currently.</p>
  76
  77 <a name="Session"></a>
  78 <h2>Session</h2>
  79
  80 <p>A session is meant to be the unic context of an instance of client,
  81 identifying that instance across requests.</p>
  82
  83 <p>Each session has an identifier. Session identifier generated by afb-daemon are UUIDs.</p>
  84
  85 <p>Internally, afb-daemon offers a mechanism to attach data to sessions.
  86 When the session is closed or disappears, the data attached to that session
  87 are freed.</p>
  88
  89 <a name="Token"></a>
  90 <h2>Token</h2>
  91
  92 <p>The token is an identifier that the the client must give to be authentificated.</p>
  93
  94 <p>At start, afb-daemon get an initial token. This initial token must be presented
  95 incoming client to be authentificated.</p>
  96
  97 <p>A token is valid only for a period.</p>
  98
  99 <p>The token must be renewed periodically. When the token is renewed, afb-daemon
 100 sends the new token to the client.</p>
 101
 102 <p>Tokens generated by afb-daemon are UUIDs.</p>
 103
 104 <a name="UUID"></a>
 105 <h2>UUID</h2>
 106
 107 <p>It stand for Universal Unic IDentifier.</p>
 108
 109 <p>Its is designed to create identifier in a way that avoid has much as possible conflicts.
 110 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>
 111
 112 <a name="x-afb-reqid"></a>
 113 <h2>x-afb-reqid</h2>
 114
 115 <p>Argument name that can be used with HTTP request.
 116 When this argument is given, it is automatically added to the &ldquo;request&rdquo; object of the
 117 answer.</p>
 118
 119 <a name="x-afb-token"></a>
 120 <h2>x-afb-token</h2>
 121
 122 <p>Argument name for giving the token without ambiguity.
 123 You can also use the name <strong>token</strong> but it may conflicts with other arguments.</p>
 124
 125 <a name="x-afb-uuid"></a>
 126 <h2>x-afb-uuid</h2>
 127
 128 <p>Argument name for giving explicitely the session identifier without ambiguity.
 129 You can also use the name <strong>uuid</strong> but it may conflicts with other arguments.</p>
 130 </body>
 131 </html>