<!DOCTYPE html>
<html>
<head>
<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>Vocabulary for AFB-DAEMON</title>
<style type="text/css">code{white-space: pre;}</style>
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link rel="stylesheet" href="doc.css">
</head>
<body>
<header>
<h1 class="title">Vocabulary for AFB-DAEMON</h1>
<h2 class="author">José Bollo</h2>
<h3 class="date">27 mai 2016</h3>
</header>
<nav id="TOC">
<ul>
<li><a href="#vocabulary-for-afb-daemon">Vocabulary for AFB-DAEMON</a><ul>
<li><a href="#event">Event</a></li>
<li><a href="#level-of-assurance-loa">Level of assurance (LOA)</a></li>
<li><a href="#plugin">Plugin</a></li>
<li><a href="#request">Request</a></li>
<li><a href="#replyresponse">Reply/Response</a></li>
<li><a href="#service">Service</a></li>
<li><a href="#session">Session</a></li>
<li><a href="#token">Token</a></li>
<li><a href="#uuid">UUID</a></li>
<li><a href="#x-afb-reqid">x-afb-reqid</a></li>
<li><a href="#x-afb-token">x-afb-token</a></li>
<li><a href="#x-afb-uuid">x-afb-uuid</a></li>
</ul></li>
</ul>
</nav>
<h1 id="vocabulary-for-afb-daemon">Vocabulary for AFB-DAEMON</h1>
<pre><code>version: 1
Date: 27 mai 2016
Author: José Bollo</code></pre>
<h2 id="event">Event</h2>
<p>Message with data propagated from the services to the client and not expecting any reply.</p>
<p>The current implementation allows to widely broadcast events to all clients.</p>
<h2 id="level-of-assurance-loa">Level of assurance (LOA)</h2>
<p>This level that can be from 0 to 3 represent the level of assurance that the services can expect from the session.</p>
<p>The exact definition of the meaning of this levels and of how to use it remains to be achived.</p>
<h2 id="plugin">Plugin</h2>
<p>A shared library object intended to be plug to an afb-daemon instance to implement an API.</p>
<h2 id="request">Request</h2>
<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>
<h2 id="replyresponse">Reply/Response</h2>
<p>This is a message sent to client as the result of the request.</p>
<h2 id="service">Service</h2>
<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>
<p>The framework establishes the connection between the services and the clients. Using DBus currently.</p>
<h2 id="session">Session</h2>
<p>A session is meant to be the unic context of an instance of client, identifying that instance across requests.</p>
<p>Each session has an identifier. Session identifier generated by afb-daemon are UUIDs.</p>
<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>
<h2 id="token">Token</h2>
<p>The token is an identifier that the the client must give to be authentificated.</p>
<p>At start, afb-daemon get an initial token. This initial token must be presented incoming client to be authentificated.</p>
<p>A token is valid only for a period.</p>
<p>The token must be renewed periodically. When the token is renewed, afb-daemon sends the new token to the client.</p>
<p>Tokens generated by afb-daemon are UUIDs.</p>
<h2 id="uuid">UUID</h2>
<p>It stand for Universal Unic IDentifier.</p>
<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>
<h2 id="x-afb-reqid">x-afb-reqid</h2>
<p>Argument name that can be used with HTTP request. When this argument is given, it is automatically added to the "request" object of the answer.</p>
<h2 id="x-afb-token">x-afb-token</h2>
<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>
<h2 id="x-afb-uuid">x-afb-uuid</h2>
<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>
</body>
</html>