--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>nepi.util.manifoldapi — NEPI 3.0 documentation</title>
+
+ <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
+ <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '3.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <link rel="top" title="NEPI 3.0 documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../index.html" accesskey="U">Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for nepi.util.manifoldapi</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c"># NEPI, a framework to manage network experiments</span>
+<span class="c"># Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c"># This program is free software: you can redistribute it and/or modify</span>
+<span class="c"># it under the terms of the GNU General Public License version 2 as</span>
+<span class="c"># published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c"># This program is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
+<span class="c"># GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU General Public License</span>
+<span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
+<span class="c">#</span>
+<span class="c"># Author: Lucia Guevgeozian Odizzio <lucia.guevgeozian_odizzio@inria.fr></span>
+
+<span class="kn">import</span> <span class="nn">xmlrpclib</span>
+<span class="kn">import</span> <span class="nn">hashlib</span>
+<span class="kn">import</span> <span class="nn">threading</span>
+
+
+<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>
+ <span class="sd">"""</span>
+<span class="sd"> API to query different data platforms as SFA, TopHat, OML Central Server,</span>
+<span class="sd"> using Manifold Framework, the backend of MySlice.</span>
+<span class="sd"> """</span>
+ <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>
+
+ <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">'password'</span><span class="p">,</span> <span class="n">Username</span><span class="o">=</span><span class="n">username</span><span class="p">,</span>
+ <span class="n">AuthString</span><span class="o">=</span><span class="n">password</span><span class="p">)</span>
+ <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">'hostname'</span><span class="p">:</span><span class="n">hostname</span><span class="p">}</span>
+ <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>
+ <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>
+
+ <span class="nd">@property</span>
+<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>
+ <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>
+</div>
+<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>
+ <span class="sd">"""</span>
+<span class="sd"> Retrieves the session key, in order to use the same session for </span>
+<span class="sd"> queries.</span>
+<span class="sd"> """</span>
+ <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">'timestamp'</span> <span class="p">:</span> <span class="s">'now'</span><span class="p">,</span> <span class="s">'object'</span><span class="p">:</span> <span class="s">'local:session'</span><span class="p">,</span>
+ <span class="s">'filters'</span> <span class="p">:</span> <span class="p">[],</span> <span class="s">'fields'</span> <span class="p">:</span> <span class="p">[],</span> <span class="s">'action'</span> <span class="p">:</span> <span class="s">'create'</span><span class="p">}</span>
+
+ <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>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">session</span><span class="p">[</span><span class="s">'value'</span><span class="p">]:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Can not authenticate in Manifold API"</span>
+ <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
+
+ <span class="n">session_key</span> <span class="o">=</span> <span class="n">session</span><span class="p">[</span><span class="s">'value'</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="s">'session'</span><span class="p">]</span>
+ <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">'session'</span><span class="p">,</span> <span class="n">session</span><span class="o">=</span><span class="n">session_key</span><span class="p">)</span>
+</div>
+<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>
+ <span class="sd">"""</span>
+<span class="sd"> Create and execute the Manifold API Query to get the resources </span>
+<span class="sd"> according fields and filters.</span>
+<span class="sd"> :param filters: resource's constraints for the experiment</span>
+<span class="sd"> :type filters: dict</span>
+<span class="sd"> :param fields: desire fields in the result of the query</span>
+<span class="sd"> :type fields: list</span>
+<span class="sd"> """</span>
+ <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">'action'</span> <span class="p">:</span> <span class="s">'get'</span><span class="p">,</span> <span class="s">'object'</span> <span class="p">:</span> <span class="s">'resource'</span><span class="p">}</span>
+
+ <span class="k">if</span> <span class="n">filters</span><span class="p">:</span>
+ <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>
+
+ <span class="n">qfilters</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+ <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>
+ <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">"=="</span><span class="p">,</span> <span class="n">filtervalue</span><span class="p">]</span>
+ <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>
+
+ <span class="n">query</span><span class="p">[</span><span class="s">'filters'</span><span class="p">]</span> <span class="o">=</span> <span class="n">qfilters</span>
+
+ <span class="k">if</span> <span class="n">fields</span><span class="p">:</span>
+ <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>
+
+ <span class="k">if</span> <span class="n">fields</span><span class="p">:</span>
+ <span class="n">query</span><span class="p">[</span><span class="s">'fields'</span><span class="p">]</span> <span class="o">=</span> <span class="n">fields</span>
+
+ <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">'value'</span><span class="p">]</span>
+ </div>
+<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>
+ <span class="sd">"""</span>
+<span class="sd"> Retrieves the resources urn of the resources matching filters.</span>
+<span class="sd"> """</span>
+ <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">'urn'</span><span class="p">)</span>
+</div>
+<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>
+ <span class="sd">"""</span>
+<span class="sd"> Retrieves resources attached to user's slice.</span>
+<span class="sd"> return value: list of resources' urn</span>
+<span class="sd"> """</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">'action'</span> <span class="p">:</span> <span class="s">'get'</span><span class="p">,</span> <span class="s">'object'</span> <span class="p">:</span> <span class="s">'resource'</span><span class="p">,</span>
+ <span class="s">'filters'</span> <span class="p">:</span> <span class="p">[[</span><span class="s">'slice'</span><span class="p">,</span><span class="s">'=='</span><span class="p">,</span> <span class="n">slicename</span><span class="p">]],</span>
+ <span class="s">'fields'</span> <span class="p">:</span> <span class="p">[</span><span class="s">'urn'</span><span class="p">]}</span>
+
+ <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">:</span>
+ <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">'value'</span><span class="p">]</span>
+
+ <span class="k">for</span> <span class="n">resource</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
+ <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">'urn'</span><span class="p">])</span>
+
+ <span class="k">return</span> <span class="n">result</span>
+</div>
+<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>
+ <span class="sd">"""</span>
+<span class="sd"> Add resource to user's slice. The query needs to specify the new</span>
+<span class="sd"> resource plus the previous resources already in the slice.</span>
+<span class="sd"> """</span>
+ <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>
+ <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>
+
+ <span class="n">urn_list</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+ <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">resources</span><span class="p">:</span>
+ <span class="n">urn_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+ <span class="n">urn_dict</span><span class="p">[</span><span class="s">'urn'</span><span class="p">]</span> <span class="o">=</span> <span class="n">r</span>
+ <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>
+
+ <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">'action'</span> <span class="p">:</span> <span class="s">'update'</span><span class="p">,</span> <span class="s">'object'</span> <span class="p">:</span> <span class="s">'slice'</span><span class="p">,</span>
+ <span class="s">'filters'</span> <span class="p">:</span> <span class="p">[[</span><span class="s">'slice_hrn'</span><span class="p">,</span><span class="s">'=='</span><span class="p">,</span> <span class="n">slicename</span><span class="p">]],</span>
+ <span class="s">'params'</span> <span class="p">:</span> <span class="p">{</span><span class="s">'resource'</span> <span class="p">:</span> <span class="n">urn_list</span><span class="p">}}</span>
+
+ <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">:</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="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>
+ <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>
+ <span class="k">return</span> <span class="bp">True</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Failed while trying to add </span><span class="si">%s</span><span class="s"> to slice"</span> <span class="o">%</span> <span class="n">resource_urn</span>
+ <span class="k">print</span> <span class="n">msg</span>
+ <span class="c"># check how to do warning</span>
+ <span class="k">return</span> <span class="bp">False</span>
+</div>
+<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>
+ <span class="sd">"""</span>
+<span class="sd"> Remove resource from user's slice. The query needs to specify the list</span>
+<span class="sd"> of previous resources in the slice without the one to be remove.</span>
+<span class="sd"> """</span>
+ <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>
+ <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>
+
+ <span class="n">urn_list</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+ <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">resources</span><span class="p">:</span>
+ <span class="n">urn_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+ <span class="n">urn_dict</span><span class="p">[</span><span class="s">'urn'</span><span class="p">]</span> <span class="o">=</span> <span class="n">r</span>
+ <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>
+
+ <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">'action'</span> <span class="p">:</span> <span class="s">'update'</span><span class="p">,</span> <span class="s">'object'</span> <span class="p">:</span> <span class="s">'slice'</span><span class="p">,</span>
+ <span class="s">'filters'</span> <span class="p">:</span> <span class="p">[[</span><span class="s">'slice_hrn'</span><span class="p">,</span><span class="s">'=='</span><span class="p">,</span> <span class="n">slicename</span><span class="p">]],</span>
+ <span class="s">'params'</span> <span class="p">:</span> <span class="p">{</span><span class="s">'resource'</span> <span class="p">:</span> <span class="n">urn_list</span><span class="p">}}</span>
+
+ <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">:</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="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>
+ <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>
+ <span class="k">return</span> <span class="bp">True</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Failed while trying to remove </span><span class="si">%s</span><span class="s"> to slice"</span> <span class="o">%</span> <span class="n">resource_urn</span>
+ <span class="c"># check how to do warning</span>
+ <span class="k">return</span> <span class="bp">False</span>
+</div>
+ <span class="k">def</span> <span class="nf">_get_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> This method is useful to retrive metadata from different platforms</span>
+<span class="sd"> in order to update fields and possible filters.</span>
+<span class="sd"> """</span>
+ <span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s">'action'</span> <span class="p">:</span> <span class="s">'get'</span><span class="p">,</span> <span class="s">'object'</span> <span class="p">:</span> <span class="s">'local:object'</span><span class="p">,</span>
+ <span class="s">'filters'</span> <span class="p">:</span> <span class="p">[[</span><span class="s">'table'</span><span class="p">,</span><span class="s">'='</span><span class="p">,</span><span class="s">'resource'</span><span class="p">]]}</span>
+
+ <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>
+
+ <span class="n">valid_fields</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+ <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">'value'</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="s">'column'</span><span class="p">]:</span>
+ <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">'name'</span><span class="p">])</span>
+
+ <span class="k">return</span> <span class="n">valid_fields</span>
+
+ <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>
+ <span class="sd">"""</span>
+<span class="sd"> Depending on the object used for the Manifold query, the filters and </span>
+<span class="sd"> fields can change its sintaxis. A resource field in a slice object</span>
+<span class="sd"> query adds 'resource.' to the field. Other changes don't follow any </span>
+<span class="sd"> particular convention.</span>
+<span class="sd"> """</span>
+ <span class="c">#TODO: find out useful filters</span>
+ <span class="n">attr_to_filter</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s">'hostname'</span> <span class="p">:</span> <span class="s">'hostname'</span><span class="p">,</span>
+ <span class="s">'longitude'</span> <span class="p">:</span> <span class="s">'longitude'</span><span class="p">,</span>
+ <span class="s">'latitude'</span> <span class="p">:</span> <span class="s">'latitude'</span><span class="p">,</span>
+ <span class="s">'network'</span> <span class="p">:</span> <span class="s">'network'</span><span class="p">,</span>
+ <span class="s">'component_id'</span> <span class="p">:</span> <span class="s">'component_id'</span>
+ <span class="p">}</span>
+
+ <span class="n">mapped_filters</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+ <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>
+ <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>
+ <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>
+ <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>
+
+ <span class="k">return</span> <span class="n">mapped_filters</span>
+
+ <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>
+ <span class="sd">"""</span>
+<span class="sd"> The fields can be a predefine set, define in the Manifold metadata.</span>
+<span class="sd"> """</span>
+ <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>
+
+ <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>
+ <span class="n">fields</span> <span class="o">=</span> <span class="p">[</span><span class="n">fields</span><span class="p">]</span>
+
+ <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">fields</span><span class="p">:</span>
+ <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>
+ <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>
+ <span class="c">#self.warning(" Invalid Manifold field or filter ")</span>
+
+ <span class="k">return</span> <span class="n">fields</span>
+
+</div>
+<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>
+ <span class="sd">"""</span>
+<span class="sd"> API Factory to manage a map of MANIFOLDAPI instances as key-value pairs, it</span>
+<span class="sd"> instanciate a single instance per key. The key represents the same SFA, </span>
+<span class="sd"> MF (ManiFold) credentials.</span>
+<span class="sd"> """</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>
+ <span class="n">_apis</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+
+ <span class="nd">@classmethod</span>
+<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>
+ <span class="c">#hostname = "manifold.pl.sophia.inria.fr",</span>
+ <span class="n">hostname</span> <span class="o">=</span><span class="s">"test.myslice.info"</span><span class="p">,</span>
+ <span class="n">urlpattern</span> <span class="o">=</span> <span class="s">"http://</span><span class="si">%(hostname)s</span><span class="s">:7080"</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> :param username: Manifold user (also used for MySlice web login)</span>
+<span class="sd"> :type username: str</span>
+<span class="sd"> :param password: Manifold password (also used for MySlice web login)</span>
+<span class="sd"> :type password: str</span>
+<span class="sd"> :param hostname: Hostname of the Manifold API to query SFA, TopHat, etc</span>
+<span class="sd"> :type hostname: str</span>
+<span class="sd"> :param urlpattern: Url of the Manifold API to query SFA, TopHat, etc</span>
+<span class="sd"> :type urlpattern: str</span>
+<span class="sd"> """</span>
+
+ <span class="k">if</span> <span class="n">username</span> <span class="ow">and</span> <span class="n">password</span><span class="p">:</span>
+ <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>
+ <span class="k">with</span> <span class="n">cls</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
+ <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>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">api</span><span class="p">:</span>
+ <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>
+ <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>
+
+ <span class="k">return</span> <span class="n">api</span>
+
+ <span class="k">return</span> <span class="bp">None</span>
+</div>
+ <span class="nd">@classmethod</span>
+<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>
+ <span class="n">skey</span> <span class="o">=</span> <span class="s">""</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>
+ <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>
+</pre></div></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
git://git.onelab.eu / nepi.git / blobdiff