doc/sphinx/_build/html/_modules/nepi/resources/omf/omf_api_factory.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>nepi.resources.omf.omf_api_factory &mdash; NEPI 3.2 documentation</title>
  10
  11     <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
  12     <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
  13
  14     <script type="text/javascript">
  15       var DOCUMENTATION_OPTIONS = {
  16         URL_ROOT:    '../../../../',
  17         VERSION:     '3.2',
  18         COLLAPSE_INDEX: false,
  19         FILE_SUFFIX: '.html',
  20         HAS_SOURCE:  true
  21       };
  22     </script>
  23     <script type="text/javascript" src="../../../../_static/jquery.js"></script>
  24     <script type="text/javascript" src="../../../../_static/underscore.js"></script>
  25     <script type="text/javascript" src="../../../../_static/doctools.js"></script>
  26     <link rel="top" title="NEPI 3.2 documentation" href="../../../../index.html" />
  27     <link rel="up" title="Module code" href="../../../index.html" />
  28   </head>
  29   <body>
  30     <div class="related">
  31       <h3>Navigation</h3>
  32       <ul>
  33         <li class="right" style="margin-right: 10px">
  34           <a href="../../../../genindex.html" title="General Index"
  35              accesskey="I">index</a></li>
  36         <li class="right" >
  37           <a href="../../../../py-modindex.html" title="Python Module Index"
  38              >modules</a> |</li>
  39         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
  40           <li><a href="../../../index.html" accesskey="U">Module code</a> &raquo;</li>
  41       </ul>
  42     </div>
  43       <div class="sphinxsidebar">
  44         <div class="sphinxsidebarwrapper">
  45 <div id="searchbox" style="display: none">
  46   <h3>Quick search</h3>
  47     <form class="search" action="../../../../search.html" method="get">
  48       <input type="text" name="q" />
  49       <input type="submit" value="Go" />
  50       <input type="hidden" name="check_keywords" value="yes" />
  51       <input type="hidden" name="area" value="default" />
  52     </form>
  53     <p class="searchtip" style="font-size: 90%">
  54     Enter search terms or a module, class or function name.
  55     </p>
  56 </div>
  57 <script type="text/javascript">$('#searchbox').show(0);</script>
  58         </div>
  59       </div>
  60
  61     <div class="document">
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <h1>Source code for nepi.resources.omf.omf_api_factory</h1><div class="highlight"><pre>
  67 <span class="c">#</span>
  68 <span class="c">#    NEPI, a framework to manage network experiments</span>
  69 <span class="c">#    Copyright (C) 2013 INRIA</span>
  70 <span class="c">#</span>
  71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
  72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
  73 <span class="c">#    published by the Free Software Foundation;</span>
  74 <span class="c">#</span>
  75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
  76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  78 <span class="c">#    GNU General Public License for more details.</span>
  79 <span class="c">#</span>
  80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
  81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  82 <span class="c">#</span>
  83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
  84 <span class="c">#         Julien Tribino &lt;julien.tribino@inria.fr&gt;</span>
  85
  86
  87 <span class="kn">import</span> <span class="nn">time</span>
  88 <span class="kn">import</span> <span class="nn">hashlib</span>
  89 <span class="kn">import</span> <span class="nn">threading</span>
  90
  91 <span class="kn">from</span> <span class="nn">nepi.resources.omf.omf5_api</span> <span class="kn">import</span> <span class="n">OMF5API</span>
  92 <span class="kn">from</span> <span class="nn">nepi.resources.omf.omf6_api</span> <span class="kn">import</span> <span class="n">OMF6API</span>
  93
  94 <div class="viewcode-block" id="OMFAPIFactory"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf_api_factory.OMFAPIFactory">[docs]</a><span class="k">class</span> <span class="nc">OMFAPIFactory</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  95     <span class="sd">&quot;&quot;&quot; </span>
  96 <span class="sd">    .. note::</span>
  97
  98 <span class="sd">        It allows the different RM to use the same xmpp client if they use </span>
  99 <span class="sd">        the same credentials.  For the moment, it is focused on XMPP.</span>
 100
 101 <span class="sd">    &quot;&quot;&quot;</span>
 102     <span class="c"># use lock to avoid concurrent access to the Api list at the same times by 2 </span>
 103     <span class="c"># different threads</span>
 104     <span class="n">lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
 105     <span class="n">_apis</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
 106
 107     <span class="nd">@classmethod</span>
 108 <div class="viewcode-block" id="OMFAPIFactory.get_api"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf_api_factory.OMFAPIFactory.get_api">[docs]</a>    <span class="k">def</span> <span class="nf">get_api</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">exp_id</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
 109         <span class="sd">&quot;&quot;&quot; Get an OMF Api</span>
 110
 111 <span class="sd">        :param version: OMF Version. Either 5 or 6</span>
 112 <span class="sd">        :type version: str</span>
 113 <span class="sd">        :param server: Xmpp Server Adress</span>
 114 <span class="sd">        :type server: str</span>
 115 <span class="sd">        :param user: Xmpp User</span>
 116 <span class="sd">        :type user: str</span>
 117 <span class="sd">        :param port: Xmpp Port (Default : 5222)</span>
 118 <span class="sd">        :type port: str</span>
 119 <span class="sd">        :param password: Xmpp Password</span>
 120 <span class="sd">        :type password: str</span>
 121 <span class="sd">        :param exp_id: Id of the experiment</span>
 122 <span class="sd">        :type exp_id: str</span>
 123
 124 <span class="sd">        &quot;&quot;&quot;</span>
 125         <span class="k">if</span> <span class="n">version</span> <span class="ow">and</span> <span class="n">user</span> <span class="ow">and</span> <span class="n">server</span> <span class="ow">and</span> <span class="n">port</span> <span class="ow">and</span> <span class="n">password</span><span class="p">:</span>
 126             <span class="n">key</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">_make_key</span><span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">exp_id</span><span class="p">)</span>
 127             <span class="n">cls</span><span class="o">.</span><span class="n">lock</span><span class="o">.</span><span class="n">acquire</span><span class="p">()</span>
 128             <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">:</span>
 129                 <span class="c">#print &quot;Api Counter : &quot; + str(cls._apis[key][&#39;cnt&#39;])</span>
 130                 <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s">&#39;cnt&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span>
 131                 <span class="n">cls</span><span class="o">.</span><span class="n">lock</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
 132                 <span class="k">return</span> <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s">&#39;api&#39;</span><span class="p">]</span>
 133             <span class="k">else</span> <span class="p">:</span>
 134                 <span class="n">omf_api</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">create_api</span><span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">exp_id</span><span class="p">)</span>
 135                 <span class="n">cls</span><span class="o">.</span><span class="n">lock</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
 136                 <span class="k">return</span> <span class="n">omf_api</span>
 137         <span class="k">return</span> <span class="bp">None</span>
 138 </div>
 139     <span class="nd">@classmethod</span>
 140 <div class="viewcode-block" id="OMFAPIFactory.create_api"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf_api_factory.OMFAPIFactory.create_api">[docs]</a>    <span class="k">def</span> <span class="nf">create_api</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">exp_id</span><span class="p">):</span>
 141         <span class="sd">&quot;&quot;&quot; Create an OMF API if this one doesn&#39;t exist yet with this credentials</span>
 142
 143 <span class="sd">        :param version: OMF Version. Either 5 or 6</span>
 144 <span class="sd">        :type version: str</span>
 145 <span class="sd">        :param server: Xmpp Server Adress</span>
 146 <span class="sd">        :type server: str</span>
 147 <span class="sd">        :param user: Xmpp User</span>
 148 <span class="sd">        :type user: str</span>
 149 <span class="sd">        :param port: Xmpp Port (Default : 5222)</span>
 150 <span class="sd">        :type port: str</span>
 151 <span class="sd">        :param password: Xmpp Password</span>
 152 <span class="sd">        :type password: str</span>
 153 <span class="sd">        :param exp_id: Id of the experiment</span>
 154 <span class="sd">        :type exp_id: str</span>
 155
 156 <span class="sd">        &quot;&quot;&quot;</span>
 157         <span class="n">key</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">_make_key</span><span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">exp_id</span><span class="p">)</span>
 158         <span class="k">if</span> <span class="n">version</span> <span class="o">==</span> <span class="s">&quot;5&quot;</span><span class="p">:</span>
 159             <span class="n">omf_api</span> <span class="o">=</span> <span class="n">OMF5API</span><span class="p">(</span><span class="n">server</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">exp_id</span> <span class="o">=</span> <span class="n">exp_id</span><span class="p">)</span>
 160         <span class="k">else</span> <span class="p">:</span>
 161             <span class="n">omf_api</span> <span class="o">=</span> <span class="n">OMF6API</span><span class="p">(</span><span class="n">server</span><span class="p">,</span> <span class="n">user</span> <span class="o">=</span> <span class="n">user</span><span class="p">,</span> <span class="n">port</span> <span class="o">=</span> <span class="n">port</span><span class="p">,</span> <span class="n">password</span> <span class="o">=</span> <span class="n">password</span><span class="p">,</span> <span class="n">exp_id</span> <span class="o">=</span> <span class="n">exp_id</span><span class="p">)</span>
 162         <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 163         <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s">&#39;api&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">omf_api</span>
 164         <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s">&#39;cnt&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
 165         <span class="k">return</span> <span class="n">omf_api</span>
 166 </div>
 167     <span class="nd">@classmethod</span>
 168 <div class="viewcode-block" id="OMFAPIFactory.release_api"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf_api_factory.OMFAPIFactory.release_api">[docs]</a>    <span class="k">def</span> <span class="nf">release_api</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">exp_id</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
 169         <span class="sd">&quot;&quot;&quot; Release an OMF API with this credentials</span>
 170
 171 <span class="sd">        :param version: OMF Version. Either 5 or 6</span>
 172 <span class="sd">        :type version: str</span>
 173 <span class="sd">        :param server: Xmpp Server Adress</span>
 174 <span class="sd">        :type server: str</span>
 175 <span class="sd">        :param user: Xmpp User</span>
 176 <span class="sd">        :type user: str</span>
 177 <span class="sd">        :param port: Xmpp Port (Default : 5222)</span>
 178 <span class="sd">        :type port: str</span>
 179 <span class="sd">        :param password: Xmpp Password</span>
 180 <span class="sd">        :type password: str</span>
 181 <span class="sd">        :param exp_id: Id of the experiment</span>
 182 <span class="sd">        :type exp_id: str</span>
 183
 184 <span class="sd">        &quot;&quot;&quot;</span>
 185         <span class="k">if</span> <span class="n">version</span> <span class="ow">and</span> <span class="n">user</span> <span class="ow">and</span> <span class="n">server</span> <span class="ow">and</span> <span class="n">port</span> <span class="ow">and</span> <span class="n">password</span><span class="p">:</span>
 186             <span class="n">key</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">_make_key</span><span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">exp_id</span><span class="p">)</span>
 187             <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">:</span>
 188                 <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s">&#39;cnt&#39;</span><span class="p">]</span> <span class="o">-=</span> <span class="mi">1</span>
 189                 <span class="c">#print &quot;Api Counter : &quot; + str(cls._apis[key][&#39;cnt&#39;])</span>
 190                 <span class="k">if</span> <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s">&#39;cnt&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
 191                     <span class="n">omf_api</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s">&#39;api&#39;</span><span class="p">]</span>
 192                     <span class="n">omf_api</span><span class="o">.</span><span class="n">disconnect</span><span class="p">()</span>
 193                     <span class="k">del</span> <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
 194 </div>
 195     <span class="nd">@classmethod</span>
 196     <span class="k">def</span> <span class="nf">_make_key</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
 197         <span class="sd">&quot;&quot;&quot; Hash the credentials in order to create a key</span>
 198
 199 <span class="sd">        :param args: list of arguments used to create the hash (server, user, port, ...)</span>
 200 <span class="sd">        :type args: list</span>
 201
 202 <span class="sd">        &quot;&quot;&quot;</span>
 203         <span class="n">skey</span> <span class="o">=</span> <span class="s">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">args</span><span class="p">))</span>
 204         <span class="k">return</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">md5</span><span class="p">(</span><span class="n">skey</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
 205 </pre></div></div>
 206
 207           </div>
 208         </div>
 209       </div>
 210       <div class="clearer"></div>
 211     </div>
 212     <div class="related">
 213       <h3>Navigation</h3>
 214       <ul>
 215         <li class="right" style="margin-right: 10px">
 216           <a href="../../../../genindex.html" title="General Index"
 217              >index</a></li>
 218         <li class="right" >
 219           <a href="../../../../py-modindex.html" title="Python Module Index"
 220              >modules</a> |</li>
 221         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 222           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 223       </ul>
 224     </div>
 225     <div class="footer">
 226         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 227       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 228     </div>
 229   </body>
 230 </html>