2 NEPI, a framework to manage network experiments
3 Copyright (C) 2013 INRIA
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 from nepi.execution.resource import ResourceManager, clsinit
21 from nepi.execution.attribute import Attribute, Flags
23 from nepi.resources.omf.omf_api import OMFAPIFactory
27 class OMFWifiInterface(ResourceManager):
29 .. class:: Class Args :
31 :param ec: The Experiment controller
32 :type ec: ExperimentController
33 :param guid: guid of the RM
35 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
40 This class is used only by the Experiment Controller through the Resource Factory
43 _rtype = "OMFWifiInterface"
44 _authorized_connections = ["OMFNode" , "OMFChannel"]
45 _waiters = ["OMFNode"]
47 #alias2name = dict({'w0':'wlan0', 'w1':'wlan1'})
50 def _register_attributes(cls):
51 """Register the attributes of an OMF interface
54 alias = Attribute("alias","Alias of the interface", default = "w0")
55 mode = Attribute("mode","Mode of the interface")
56 type = Attribute("type","Type of the interface")
57 essid = Attribute("essid","Essid of the interface")
58 ip = Attribute("ip","IP of the interface")
59 xmppSlice = Attribute("xmppSlice","Name of the slice", flags = Flags.Credential)
60 xmppHost = Attribute("xmppHost", "Xmpp Server",flags = Flags.Credential)
61 xmppPort = Attribute("xmppPort", "Xmpp Port",flags = Flags.Credential)
62 xmppPassword = Attribute("xmppPassword", "Xmpp Port",flags = Flags.Credential)
63 cls._register_attribute(alias)
64 cls._register_attribute(xmppSlice)
65 cls._register_attribute(xmppHost)
66 cls._register_attribute(xmppPort)
67 cls._register_attribute(xmppPassword)
68 cls._register_attribute(mode)
69 cls._register_attribute(type)
70 cls._register_attribute(essid)
71 cls._register_attribute(ip)
73 def __init__(self, ec, guid):
75 :param ec: The Experiment controller
76 :type ec: ExperimentController
77 :param guid: guid of the RM
79 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
83 super(OMFWifiInterface, self).__init__(ec, guid)
86 self._alias = self.get('alias')
88 def _validate_connection(self, guid):
89 """ Check if the connection is available.
91 :param guid: Guid of the current RM
96 rm = self.ec.get_resource(guid)
97 if rm.rtype() in self._authorized_connections:
98 msg = "Connection between %s %s and %s %s accepted" % (self.rtype(), self._guid, rm.rtype(), guid)
101 msg = "Connection between %s %s and %s %s refused" % (self.rtype(), self._guid, rm.rtype(), guid)
105 def _get_nodes(self, conn_set):
106 """ Get the RM of the node to which the application is connected
108 :param conn_set: Connections of the current Guid
110 :rtype: ResourceManager
114 rm = self.ec.get_resource(elt)
115 if rm.rtype() == "OMFNode":
123 self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'),
124 self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))
126 self._logger.debug(" " + self.rtype() + " ( Guid : " + str(self._guid) +") : " +
127 self.get('mode') + " : " + self.get('type') + " : " +
128 self.get('essid') + " : " + self.get('ip'))
130 if self.get('mode') and self.get('type') and self.get('essid') and self.get('ip'):
131 rm_node = self._get_nodes(self._connections)
132 for attrname in ["mode", "type", "essid", "ip"]:
133 attrval = self.get(attrname)
134 attrname = "net/%s/%s" % (self._alias, attrname)
135 #print "Send the configure message"
136 self._omf_api.configure(rm_node.get('hostname'), attrname, attrval)
138 super(OMFWifiInterface, self).deploy()
142 """Send Xmpp Messages Using OMF protocol to configure Interface
146 super(OMFWifiInterface, self).start()
149 """Send Xmpp Message Using OMF protocol to put down the interface
152 super(OMFWifiInterface, self).stop()
155 """Clean the RM at the end of the experiment
158 OMFAPIFactory.release_api(self.get('xmppSlice'),
159 self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))