doc/sphinx/_build/html/_modules/nepi/util/manifoldapi.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.util.manifoldapi &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.util.manifoldapi</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: Lucia Guevgeozian Odizzio &lt;lucia.guevgeozian_odizzio@inria.fr&gt;</span>
  84
  85 <span class="kn">import</span> <span class="nn">xmlrpclib</span>
  86 <span class="kn">import</span> <span class="nn">hashlib</span>
  87 <span class="kn">import</span> <span class="nn">threading</span>
  88
  89
  90 <div class="viewcode-block" id="MANIFOLDAPI"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPI">[docs]</a><span class="k">class</span> <span class="nc">MANIFOLDAPI</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  91     <span class="sd">&quot;&quot;&quot;</span>
  92 <span class="sd">    API to query different data platforms as SFA, TopHat, OML Central Server,</span>
  93 <span class="sd">    using Manifold Framework, the backend of MySlice.</span>
  94 <span class="sd">    &quot;&quot;&quot;</span>
  95     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">hostname</span><span class="p">,</span> <span class="n">urlpattern</span><span class="p">):</span>
  96
  97         <span class="bp">self</span><span class="o">.</span><span class="n">auth_pwd</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">AuthMethod</span><span class="o">=</span><span class="s">&#39;password&#39;</span><span class="p">,</span> <span class="n">Username</span><span class="o">=</span><span class="n">username</span><span class="p">,</span>
  98             <span class="n">AuthString</span><span class="o">=</span><span class="n">password</span><span class="p">)</span>
  99         <span class="bp">self</span><span class="o">.</span><span class="n">_url</span> <span class="o">=</span> <span class="n">urlpattern</span> <span class="o">%</span> <span class="p">{</span><span class="s">&#39;hostname&#39;</span><span class="p">:</span><span class="n">hostname</span><span class="p">}</span>
 100         <span class="bp">self</span><span class="o">.</span><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>
 101         <span class="bp">self</span><span class="o">.</span><span class="n">auth</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_session_key</span><span class="p">()</span>
 102
 103     <span class="nd">@property</span>
 104 <div class="viewcode-block" id="MANIFOLDAPI.api"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPI.api">[docs]</a>    <span class="k">def</span> <span class="nf">api</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 105         <span class="k">return</span> <span class="n">xmlrpclib</span><span class="o">.</span><span class="n">Server</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_url</span><span class="p">,</span> <span class="n">allow_none</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
 106 </div>
 107 <div class="viewcode-block" id="MANIFOLDAPI.get_session_key"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPI.get_session_key">[docs]</a>    <span class="k">def</span> <span class="nf">get_session_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 108         <span class="sd">&quot;&quot;&quot;</span>
 109 <span class="sd">        Retrieves the session key, in order to use the same session for </span>
 110 <span class="sd">        queries.</span>
 111 <span class="sd">        &quot;&quot;&quot;</span>
 112         <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;timestamp&#39;</span> <span class="p">:</span> <span class="s">&#39;now&#39;</span><span class="p">,</span> <span class="s">&#39;object&#39;</span><span class="p">:</span> <span class="s">&#39;local:session&#39;</span><span class="p">,</span>
 113             <span class="s">&#39;filters&#39;</span> <span class="p">:</span> <span class="p">[],</span> <span class="s">&#39;fields&#39;</span> <span class="p">:</span> <span class="p">[],</span> <span class="s">&#39;action&#39;</span> <span class="p">:</span> <span class="s">&#39;create&#39;</span><span class="p">}</span>
 114
 115         <span class="n">session</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">auth_pwd</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
 116
 117         <span class="k">if</span> <span class="ow">not</span> <span class="n">session</span><span class="p">[</span><span class="s">&#39;value&#39;</span><span class="p">]:</span>
 118             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Can not authenticate in Manifold API&quot;</span>
 119             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 120
 121         <span class="n">session_key</span> <span class="o">=</span> <span class="n">session</span><span class="p">[</span><span class="s">&#39;value&#39;</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="s">&#39;session&#39;</span><span class="p">]</span>
 122         <span class="k">return</span> <span class="nb">dict</span><span class="p">(</span><span class="n">AuthMethod</span><span class="o">=</span><span class="s">&#39;session&#39;</span><span class="p">,</span> <span class="n">session</span><span class="o">=</span><span class="n">session_key</span><span class="p">)</span>
 123 </div>
 124 <div class="viewcode-block" id="MANIFOLDAPI.get_resource_info"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPI.get_resource_info">[docs]</a>    <span class="k">def</span> <span class="nf">get_resource_info</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
 125         <span class="sd">&quot;&quot;&quot;</span>
 126 <span class="sd">        Create and execute the Manifold API Query to get the resources </span>
 127 <span class="sd">        according fields and filters.</span>
 128 <span class="sd">        :param filters: resource&#39;s constraints for the experiment</span>
 129 <span class="sd">        :type filters: dict</span>
 130 <span class="sd">        :param fields: desire fields in the result of the query</span>
 131 <span class="sd">        :type fields: list</span>
 132 <span class="sd">        &quot;&quot;&quot;</span>
 133         <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;action&#39;</span> <span class="p">:</span> <span class="s">&#39;get&#39;</span><span class="p">,</span> <span class="s">&#39;object&#39;</span> <span class="p">:</span> <span class="s">&#39;resource&#39;</span><span class="p">}</span>
 134
 135         <span class="k">if</span> <span class="n">filters</span><span class="p">:</span>
 136             <span class="n">filters</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_map_attr_to_resource_filters</span><span class="p">(</span><span class="n">filters</span><span class="p">)</span>
 137
 138             <span class="n">qfilters</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
 139             <span class="k">for</span> <span class="n">filtername</span><span class="p">,</span> <span class="n">filtervalue</span> <span class="ow">in</span> <span class="n">filters</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
 140                 <span class="n">newfilter</span> <span class="o">=</span> <span class="p">[</span><span class="n">filtername</span><span class="p">,</span> <span class="s">&quot;==&quot;</span><span class="p">,</span> <span class="n">filtervalue</span><span class="p">]</span>
 141                 <span class="n">qfilters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">newfilter</span><span class="p">)</span>
 142
 143             <span class="n">query</span><span class="p">[</span><span class="s">&#39;filters&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">qfilters</span>
 144
 145         <span class="k">if</span> <span class="n">fields</span><span class="p">:</span>
 146             <span class="n">fields</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_valid_fields</span><span class="p">(</span><span class="n">fields</span><span class="p">)</span>
 147
 148             <span class="k">if</span> <span class="n">fields</span><span class="p">:</span>
 149                 <span class="n">query</span><span class="p">[</span><span class="s">&#39;fields&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">fields</span>
 150
 151         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="p">,</span> <span class="n">query</span><span class="p">)[</span><span class="s">&#39;value&#39;</span><span class="p">]</span>
 152         </div>
 153 <div class="viewcode-block" id="MANIFOLDAPI.get_resource_urn"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPI.get_resource_urn">[docs]</a>    <span class="k">def</span> <span class="nf">get_resource_urn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
 154         <span class="sd">&quot;&quot;&quot;</span>
 155 <span class="sd">        Retrieves the resources urn of the resources matching filters.</span>
 156 <span class="sd">        &quot;&quot;&quot;</span>
 157         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_resource_info</span><span class="p">(</span><span class="n">filters</span><span class="p">,</span> <span class="s">&#39;urn&#39;</span><span class="p">)</span>
 158 </div>
 159 <div class="viewcode-block" id="MANIFOLDAPI.get_slice_resources"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPI.get_slice_resources">[docs]</a>    <span class="k">def</span> <span class="nf">get_slice_resources</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">slicename</span><span class="p">):</span>
 160         <span class="sd">&quot;&quot;&quot;</span>
 161 <span class="sd">        Retrieves resources attached to user&#39;s slice.</span>
 162 <span class="sd">        return value: list of resources&#39; urn</span>
 163 <span class="sd">        &quot;&quot;&quot;</span>
 164         <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
 165         <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;action&#39;</span> <span class="p">:</span> <span class="s">&#39;get&#39;</span><span class="p">,</span> <span class="s">&#39;object&#39;</span> <span class="p">:</span> <span class="s">&#39;resource&#39;</span><span class="p">,</span>
 166             <span class="s">&#39;filters&#39;</span> <span class="p">:</span> <span class="p">[[</span><span class="s">&#39;slice&#39;</span><span class="p">,</span><span class="s">&#39;==&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">]],</span>
 167             <span class="s">&#39;fields&#39;</span> <span class="p">:</span> <span class="p">[</span><span class="s">&#39;urn&#39;</span><span class="p">]}</span>
 168
 169         <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">:</span>
 170             <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="p">,</span> <span class="n">query</span><span class="p">)[</span><span class="s">&#39;value&#39;</span><span class="p">]</span>
 171
 172         <span class="k">for</span> <span class="n">resource</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
 173             <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">resource</span><span class="p">[</span><span class="s">&#39;urn&#39;</span><span class="p">])</span>
 174
 175         <span class="k">return</span> <span class="n">result</span>
 176 </div>
 177 <div class="viewcode-block" id="MANIFOLDAPI.add_resource_to_slice"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPI.add_resource_to_slice">[docs]</a>    <span class="k">def</span> <span class="nf">add_resource_to_slice</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">slicename</span><span class="p">,</span> <span class="n">resource_urn</span><span class="p">):</span>
 178         <span class="sd">&quot;&quot;&quot;</span>
 179 <span class="sd">        Add resource to user&#39;s slice. The query needs to specify the new</span>
 180 <span class="sd">        resource plus the previous resources already in the slice.</span>
 181 <span class="sd">        &quot;&quot;&quot;</span>
 182         <span class="n">resources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_slice_resources</span><span class="p">(</span><span class="n">slicename</span><span class="p">)</span>
 183         <span class="n">resources</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">resource_urn</span><span class="p">)</span>
 184
 185         <span class="n">urn_list</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
 186         <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">resources</span><span class="p">:</span>
 187             <span class="n">urn_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
 188             <span class="n">urn_dict</span><span class="p">[</span><span class="s">&#39;urn&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">r</span>
 189             <span class="n">urn_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">urn_dict</span><span class="p">)</span>
 190
 191         <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;action&#39;</span> <span class="p">:</span> <span class="s">&#39;update&#39;</span><span class="p">,</span> <span class="s">&#39;object&#39;</span> <span class="p">:</span> <span class="s">&#39;slice&#39;</span><span class="p">,</span>
 192             <span class="s">&#39;filters&#39;</span> <span class="p">:</span> <span class="p">[[</span><span class="s">&#39;slice_hrn&#39;</span><span class="p">,</span><span class="s">&#39;==&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">]],</span>
 193             <span class="s">&#39;params&#39;</span> <span class="p">:</span> <span class="p">{</span><span class="s">&#39;resource&#39;</span> <span class="p">:</span> <span class="n">urn_list</span><span class="p">}}</span>
 194
 195         <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">:</span>
 196             <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
 197
 198         <span class="n">resources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_slice_resources</span><span class="p">(</span><span class="n">slicename</span><span class="p">)</span>
 199         <span class="k">if</span> <span class="n">resource_urn</span> <span class="ow">in</span> <span class="n">resources</span><span class="p">:</span>
 200             <span class="k">return</span> <span class="bp">True</span>
 201         <span class="k">else</span><span class="p">:</span>
 202             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Failed while trying to add </span><span class="si">%s</span><span class="s"> to slice&quot;</span> <span class="o">%</span> <span class="n">resource_urn</span>
 203             <span class="k">print</span> <span class="n">msg</span>
 204             <span class="c"># check how to do warning</span>
 205             <span class="k">return</span> <span class="bp">False</span>
 206 </div>
 207 <div class="viewcode-block" id="MANIFOLDAPI.remove_resource_from_slice"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPI.remove_resource_from_slice">[docs]</a>    <span class="k">def</span> <span class="nf">remove_resource_from_slice</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">slicename</span><span class="p">,</span> <span class="n">resource_urn</span><span class="p">):</span>
 208         <span class="sd">&quot;&quot;&quot;</span>
 209 <span class="sd">        Remove resource from user&#39;s slice. The query needs to specify the list</span>
 210 <span class="sd">        of previous resources in the slice without the one to be remove.</span>
 211 <span class="sd">        &quot;&quot;&quot;</span>
 212         <span class="n">resources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_slice_resources</span><span class="p">(</span><span class="n">slicename</span><span class="p">)</span>
 213         <span class="n">resources</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">resource_urn</span><span class="p">)</span>
 214
 215         <span class="n">urn_list</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
 216         <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">resources</span><span class="p">:</span>
 217             <span class="n">urn_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
 218             <span class="n">urn_dict</span><span class="p">[</span><span class="s">&#39;urn&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">r</span>
 219             <span class="n">urn_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">urn_dict</span><span class="p">)</span>
 220
 221         <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;action&#39;</span> <span class="p">:</span> <span class="s">&#39;update&#39;</span><span class="p">,</span> <span class="s">&#39;object&#39;</span> <span class="p">:</span> <span class="s">&#39;slice&#39;</span><span class="p">,</span>
 222             <span class="s">&#39;filters&#39;</span> <span class="p">:</span> <span class="p">[[</span><span class="s">&#39;slice_hrn&#39;</span><span class="p">,</span><span class="s">&#39;==&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">]],</span>
 223             <span class="s">&#39;params&#39;</span> <span class="p">:</span> <span class="p">{</span><span class="s">&#39;resource&#39;</span> <span class="p">:</span> <span class="n">urn_list</span><span class="p">}}</span>
 224
 225         <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">:</span>
 226             <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
 227
 228         <span class="n">resources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_slice_resources</span><span class="p">(</span><span class="n">slicename</span><span class="p">)</span>
 229         <span class="k">if</span> <span class="n">resource_urn</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">resources</span><span class="p">:</span>
 230             <span class="k">return</span> <span class="bp">True</span>
 231         <span class="k">else</span><span class="p">:</span>
 232             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Failed while trying to remove </span><span class="si">%s</span><span class="s"> to slice&quot;</span> <span class="o">%</span> <span class="n">resource_urn</span>
 233             <span class="c"># check how to do warning</span>
 234             <span class="k">return</span> <span class="bp">False</span>
 235 </div>
 236     <span class="k">def</span> <span class="nf">_get_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 237         <span class="sd">&quot;&quot;&quot;</span>
 238 <span class="sd">        This method is useful to retrive metadata from different platforms</span>
 239 <span class="sd">        in order to update fields and possible filters.</span>
 240 <span class="sd">        &quot;&quot;&quot;</span>
 241         <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;action&#39;</span> <span class="p">:</span> <span class="s">&#39;get&#39;</span><span class="p">,</span> <span class="s">&#39;object&#39;</span> <span class="p">:</span> <span class="s">&#39;local:object&#39;</span><span class="p">,</span>
 242             <span class="s">&#39;filters&#39;</span> <span class="p">:</span> <span class="p">[[</span><span class="s">&#39;table&#39;</span><span class="p">,</span><span class="s">&#39;=&#39;</span><span class="p">,</span><span class="s">&#39;resource&#39;</span><span class="p">]]}</span>
 243
 244         <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">forward</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
 245
 246         <span class="n">valid_fields</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
 247         <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">res</span><span class="p">[</span><span class="s">&#39;value&#39;</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="s">&#39;column&#39;</span><span class="p">]:</span>
 248             <span class="n">valid_fields</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">i</span><span class="p">[</span><span class="s">&#39;name&#39;</span><span class="p">])</span>
 249
 250         <span class="k">return</span> <span class="n">valid_fields</span>
 251
 252     <span class="k">def</span> <span class="nf">_map_attr_to_resource_filters</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filters</span><span class="p">):</span>
 253         <span class="sd">&quot;&quot;&quot;</span>
 254 <span class="sd">        Depending on the object used for the Manifold query, the filters and </span>
 255 <span class="sd">        fields can change its sintaxis. A resource field in a slice object</span>
 256 <span class="sd">        query adds &#39;resource.&#39; to the field. Other changes don&#39;t follow any </span>
 257 <span class="sd">        particular convention.</span>
 258 <span class="sd">        &quot;&quot;&quot;</span>
 259         <span class="c">#TODO: find out useful filters</span>
 260         <span class="n">attr_to_filter</span> <span class="o">=</span> <span class="p">{</span>
 261             <span class="s">&#39;hostname&#39;</span> <span class="p">:</span> <span class="s">&#39;hostname&#39;</span><span class="p">,</span>
 262             <span class="s">&#39;longitude&#39;</span> <span class="p">:</span> <span class="s">&#39;longitude&#39;</span><span class="p">,</span>
 263             <span class="s">&#39;latitude&#39;</span> <span class="p">:</span> <span class="s">&#39;latitude&#39;</span><span class="p">,</span>
 264             <span class="s">&#39;network&#39;</span> <span class="p">:</span> <span class="s">&#39;network&#39;</span><span class="p">,</span>
 265             <span class="s">&#39;component_id&#39;</span> <span class="p">:</span> <span class="s">&#39;component_id&#39;</span>
 266         <span class="p">}</span>
 267
 268         <span class="n">mapped_filters</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
 269         <span class="k">for</span> <span class="n">filtername</span><span class="p">,</span> <span class="n">filtervalue</span> <span class="ow">in</span> <span class="n">filters</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
 270             <span class="k">if</span> <span class="n">attr_to_filter</span><span class="p">[</span><span class="n">filtername</span><span class="p">]:</span>
 271                 <span class="n">new_filtername</span> <span class="o">=</span> <span class="n">attr_to_filter</span><span class="p">[</span><span class="n">filtername</span><span class="p">]</span>
 272                 <span class="n">mapped_filters</span><span class="p">[</span><span class="n">new_filtername</span><span class="p">]</span> <span class="o">=</span> <span class="n">filtervalue</span>
 273
 274         <span class="k">return</span> <span class="n">mapped_filters</span>
 275
 276     <span class="k">def</span> <span class="nf">_check_valid_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fields</span><span class="p">):</span>
 277         <span class="sd">&quot;&quot;&quot;</span>
 278 <span class="sd">        The fields can be a predefine set, define in the Manifold metadata.</span>
 279 <span class="sd">        &quot;&quot;&quot;</span>
 280         <span class="n">valid_fields</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_metadata</span><span class="p">()</span>
 281
 282         <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fields</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
 283             <span class="n">fields</span> <span class="o">=</span> <span class="p">[</span><span class="n">fields</span><span class="p">]</span>
 284
 285         <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">fields</span><span class="p">:</span>
 286             <span class="k">if</span> <span class="n">field</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">valid_fields</span><span class="p">:</span>
 287                 <span class="n">fields</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">field</span><span class="p">)</span>
 288                 <span class="c">#self.warning(&quot; Invalid Manifold field or filter &quot;)</span>
 289
 290         <span class="k">return</span> <span class="n">fields</span>
 291
 292 </div>
 293 <div class="viewcode-block" id="MANIFOLDAPIFactory"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPIFactory">[docs]</a><span class="k">class</span> <span class="nc">MANIFOLDAPIFactory</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
 294     <span class="sd">&quot;&quot;&quot;</span>
 295 <span class="sd">    API Factory to manage a map of MANIFOLDAPI instances as key-value pairs, it</span>
 296 <span class="sd">    instanciate a single instance per key. The key represents the same SFA, </span>
 297 <span class="sd">    MF (ManiFold) credentials.</span>
 298 <span class="sd">    &quot;&quot;&quot;</span>
 299
 300     <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>
 301     <span class="n">_apis</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
 302
 303     <span class="nd">@classmethod</span>
 304 <div class="viewcode-block" id="MANIFOLDAPIFactory.get_api"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPIFactory.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">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span>
 305             <span class="c">#hostname = &quot;manifold.pl.sophia.inria.fr&quot;,</span>
 306             <span class="n">hostname</span> <span class="o">=</span><span class="s">&quot;test.myslice.info&quot;</span><span class="p">,</span>
 307             <span class="n">urlpattern</span> <span class="o">=</span> <span class="s">&quot;http://</span><span class="si">%(hostname)s</span><span class="s">:7080&quot;</span><span class="p">):</span>
 308         <span class="sd">&quot;&quot;&quot;</span>
 309 <span class="sd">        :param username: Manifold user (also used for MySlice web login)</span>
 310 <span class="sd">        :type username: str</span>
 311 <span class="sd">        :param password: Manifold password (also used for MySlice web login)</span>
 312 <span class="sd">        :type password: str</span>
 313 <span class="sd">        :param hostname: Hostname of the Manifold API to query SFA, TopHat, etc</span>
 314 <span class="sd">        :type hostname: str</span>
 315 <span class="sd">        :param urlpattern: Url of the Manifold API to query SFA, TopHat, etc</span>
 316 <span class="sd">        :type urlpattern: str</span>
 317 <span class="sd">        &quot;&quot;&quot;</span>
 318
 319         <span class="k">if</span> <span class="n">username</span> <span class="ow">and</span> <span class="n">password</span><span class="p">:</span>
 320             <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">username</span><span class="p">,</span> <span class="n">password</span><span class="p">)</span>
 321             <span class="k">with</span> <span class="n">cls</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
 322                 <span class="n">api</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
 323
 324                 <span class="k">if</span> <span class="ow">not</span> <span class="n">api</span><span class="p">:</span>
 325                     <span class="n">api</span> <span class="o">=</span> <span class="n">MANIFOLDAPI</span><span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">hostname</span><span class="p">,</span> <span class="n">urlpattern</span><span class="p">)</span>
 326                     <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="n">api</span>
 327
 328                 <span class="k">return</span> <span class="n">api</span>
 329
 330         <span class="k">return</span> <span class="bp">None</span>
 331 </div>
 332     <span class="nd">@classmethod</span>
 333 <div class="viewcode-block" id="MANIFOLDAPIFactory.make_key"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.manifoldapi.MANIFOLDAPIFactory.make_key">[docs]</a>    <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>
 334         <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>
 335         <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>
 336 </pre></div></div></div>
 337
 338           </div>
 339         </div>
 340       </div>
 341       <div class="clearer"></div>
 342     </div>
 343     <div class="related">
 344       <h3>Navigation</h3>
 345       <ul>
 346         <li class="right" style="margin-right: 10px">
 347           <a href="../../../genindex.html" title="General Index"
 348              >index</a></li>
 349         <li class="right" >
 350           <a href="../../../py-modindex.html" title="Python Module Index"
 351              >modules</a> |</li>
 352         <li><a href="../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 353           <li><a href="../../index.html" >Module code</a> &raquo;</li>
 354       </ul>
 355     </div>
 356     <div class="footer">
 357         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 358       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 359     </div>
 360   </body>
 361 </html>