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
29 class OMFWifiInterface(ResourceManager):
31 .. class:: Class Args :
33 :param ec: The Experiment controller
34 :type ec: ExperimentController
35 :param guid: guid of the RM
37 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
42 This class is used only by the Experiment Controller through the Resource Factory
45 _rtype = "OMFWifiInterface"
46 _authorized_connections = ["OMFNode" , "OMFChannel"]
47 _waiters = ["OMFNode"]
49 #alias2name = dict({'w0':'wlan0', 'w1':'wlan1'})
52 def _register_attributes(cls):
53 """Register the attributes of an OMF interface
56 alias = Attribute("alias","Alias of the interface", default = "w0")
57 mode = Attribute("mode","Mode of the interface")
58 type = Attribute("type","Type of the interface")
59 essid = Attribute("essid","Essid of the interface")
60 ip = Attribute("ip","IP of the interface")
61 xmppSlice = Attribute("xmppSlice","Name of the slice", flags = Flags.Credential)
62 xmppHost = Attribute("xmppHost", "Xmpp Server",flags = Flags.Credential)
63 xmppPort = Attribute("xmppPort", "Xmpp Port",flags = Flags.Credential)
64 xmppPassword = Attribute("xmppPassword", "Xmpp Port",flags = Flags.Credential)
65 cls._register_attribute(alias)
66 cls._register_attribute(xmppSlice)
67 cls._register_attribute(xmppHost)
68 cls._register_attribute(xmppPort)
69 cls._register_attribute(xmppPassword)
70 cls._register_attribute(mode)
71 cls._register_attribute(type)
72 cls._register_attribute(essid)
73 cls._register_attribute(ip)
75 def __init__(self, ec, guid):
77 :param ec: The Experiment controller
78 :type ec: ExperimentController
79 :param guid: guid of the RM
81 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
85 super(OMFWifiInterface, self).__init__(ec, guid)
88 self._alias = self.get('alias')
90 self._logger = logging.getLogger("nepi.omf.omfIface ")
91 self._logger.setLevel(nepi.LOGLEVEL)
93 def _validate_connection(self, guid):
94 """ Check if the connection is available.
96 :param guid: Guid of the current RM
101 rm = self.ec.get_resource(guid)
102 if rm.rtype() in self._authorized_connections:
103 self._logger.debug("Connection between %s %s and %s %s accepted" %
104 (self.rtype(), self._guid, rm.rtype(), guid))
106 self._logger.debug("Connection between %s %s and %s %s refused" %
107 (self.rtype(), self._guid, rm.rtype(), guid))
110 def _get_nodes(self, conn_set):
111 """ Get the RM of the node to which the application is connected
113 :param conn_set: Connections of the current Guid
115 :rtype: ResourceManager
119 rm = self.ec.get_resource(elt)
120 if rm.rtype() == "OMFNode":
124 def deploy_action(self):
128 self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'),
129 self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))
131 self._logger.debug(" " + self.rtype() + " ( Guid : " + str(self._guid) +") : " +
132 self.get('mode') + " : " + self.get('type') + " : " +
133 self.get('essid') + " : " + self.get('ip'))
135 if self.get('mode') and self.get('type') and self.get('essid') and self.get('ip'):
136 rm_node = self._get_nodes(self._connections)
137 for attrname in ["mode", "type", "essid", "ip"]:
138 attrval = self.get(attrname)
139 attrname = "net/%s/%s" % (self._alias, attrname)
140 #print "Send the configure message"
141 self._omf_api.configure(rm_node.get('hostname'), attrname, attrval)
143 super(OMFWifiInterface, self).deploy_action()
147 """Send Xmpp Messages Using OMF protocol to configure Interface
151 super(OMFWifiInterface, self).start()
154 """Send Xmpp Message Using OMF protocol to put down the interface
157 super(OMFWifiInterface, self).stop()
160 """Clean the RM at the end of the experiment
163 OMFAPIFactory.release_api(self.get('xmppSlice'),
164 self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))