doc/sphinx/_build/html/_modules/nepi/resources/omf/omf_resource.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_resource &mdash; NEPI 3.0 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.0',
  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.0 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.0 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_resource</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: Julien Tribino &lt;julien.tribino@inria.fr&gt;</span>
  84 <span class="c">#         Lucia Guevgeozian &lt;lucia.guevgeozian_odizzio@inria.fr&gt;</span>
  85
  86 <span class="kn">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Attribute</span><span class="p">,</span> <span class="n">Flags</span><span class="p">,</span> <span class="n">Types</span>
  87 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">ResourceManager</span><span class="p">,</span> <span class="n">clsinit_copy</span><span class="p">,</span> \
  88         <span class="n">ResourceState</span>
  89
  90
  91 <div class="viewcode-block" id="ResourceGateway"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf_resource.ResourceGateway">[docs]</a><span class="k">class</span> <span class="nc">ResourceGateway</span><span class="p">:</span>
  92     <span class="sd">&quot;&quot;&quot;</span>
  93 <span class="sd">    Dictionary used to set OMF gateway depending on Testbed information.</span>
  94 <span class="sd">    &quot;&quot;&quot;</span>
  95     <span class="c">#XXX: A.Q. COMMENT: This looks a bit hardcoded</span>
  96     <span class="c">#       SHOULDN&#39;T THIS BE IN A SEPARATED FILE RATHER THAN IN THE </span>
  97     <span class="c">#       BASE CLASS FOR ALL OMF RESOURCES?</span>
  98     <span class="n">TestbedtoGateway</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">({</span>
  99         <span class="s">&quot;wilabt&quot;</span> <span class="p">:</span> <span class="s">&quot;ops.wilab2.ilabt.iminds.be&quot;</span><span class="p">,</span>
 100         <span class="s">&quot;nitos&quot;</span> <span class="p">:</span> <span class="s">&quot;nitlab.inf.uth.gr&quot;</span><span class="p">,</span>
 101         <span class="s">&quot;nicta&quot;</span> <span class="p">:</span> <span class="s">&quot;??.??.??&quot;</span><span class="p">,</span>
 102     <span class="p">})</span>
 103
 104     <span class="n">AMtoGateway</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">({</span>
 105         <span class="s">&quot;am.wilab2.ilabt.iminds.be&quot;</span> <span class="p">:</span> <span class="s">&quot;ops.wilab2.ilabt.iminds.be&quot;</span><span class="p">,</span>
 106         <span class="s">&quot;nitlab.inf.uth.gr&quot;</span> <span class="p">:</span> <span class="s">&quot;nitlab.inf.uth.gr&quot;</span><span class="p">,</span>
 107         <span class="s">&quot;nicta&quot;</span> <span class="p">:</span> <span class="s">&quot;??.??.??&quot;</span><span class="p">,</span>
 108     <span class="p">})</span>
 109 </div>
 110 <span class="nd">@clsinit_copy</span>
 111 <div class="viewcode-block" id="OMFResource"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf_resource.OMFResource">[docs]</a><span class="k">class</span> <span class="nc">OMFResource</span><span class="p">(</span><span class="n">ResourceManager</span><span class="p">):</span>
 112     <span class="sd">&quot;&quot;&quot;</span>
 113 <span class="sd">    Generic resource gathering XMPP credential information and common methods</span>
 114 <span class="sd">    for OMF nodes, channels, applications, etc.</span>
 115 <span class="sd">    &quot;&quot;&quot;</span>
 116     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;abstract::omf::Resource&quot;</span>
 117     <span class="n">_platform</span> <span class="o">=</span> <span class="s">&quot;omf&quot;</span>
 118
 119     <span class="nd">@classmethod</span>
 120     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
 121
 122         <span class="n">xmppServer</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;xmppServer&quot;</span><span class="p">,</span> <span class="s">&quot;Xmpp Server&quot;</span><span class="p">,</span>
 123             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Credential</span><span class="p">)</span>
 124         <span class="n">xmppUser</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;xmppUser&quot;</span><span class="p">,</span><span class="s">&quot;Name of the Xmpp User/Slice&quot;</span><span class="p">,</span>
 125             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Credential</span><span class="p">)</span>
 126         <span class="n">xmppPort</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;xmppPort&quot;</span><span class="p">,</span> <span class="s">&quot;Xmpp Port&quot;</span><span class="p">,</span>
 127             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Credential</span><span class="p">)</span>
 128         <span class="n">xmppPassword</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;xmppPassword&quot;</span><span class="p">,</span> <span class="s">&quot;Xmpp Password&quot;</span><span class="p">,</span>
 129                 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Credential</span><span class="p">)</span>
 130         <span class="n">version</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;version&quot;</span><span class="p">,</span> <span class="s">&quot;Version of OMF : Either 5 or 6&quot;</span><span class="p">,</span>
 131                 <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;6&quot;</span><span class="p">,</span> <span class="p">)</span>
 132
 133         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">xmppUser</span><span class="p">)</span>
 134         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">xmppServer</span><span class="p">)</span>
 135         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">xmppPort</span><span class="p">)</span>
 136         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">xmppPassword</span><span class="p">)</span>
 137         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">version</span><span class="p">)</span>
 138
 139     <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">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
 140         <span class="nb">super</span><span class="p">(</span><span class="n">OMFResource</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span>
 141         <span class="k">pass</span>
 142 </pre></div></div>
 143
 144           </div>
 145         </div>
 146       </div>
 147       <div class="clearer"></div>
 148     </div>
 149     <div class="related">
 150       <h3>Navigation</h3>
 151       <ul>
 152         <li class="right" style="margin-right: 10px">
 153           <a href="../../../../genindex.html" title="General Index"
 154              >index</a></li>
 155         <li class="right" >
 156           <a href="../../../../py-modindex.html" title="Python Module Index"
 157              >modules</a> |</li>
 158         <li><a href="../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 159           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 160       </ul>
 161     </div>
 162     <div class="footer">
 163         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 164       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 165     </div>
 166   </body>
 167 </html>