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/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19 # Julien Tribino <julien.tribino@inria.fr>
22 from nepi.execution.resource import ResourceManager, clsinit_copy, ResourceState, \
24 from nepi.execution.attribute import Attribute, Flags
25 from nepi.resources.omf.omf_resource import ResourceGateway, OMFResource
26 from nepi.resources.omf.omf_api import OMFAPIFactory
32 class OMFNode(OMFResource):
34 .. class:: Class Args :
36 :param ec: The Experiment controller
37 :type ec: ExperimentController
38 :param guid: guid of the RM
40 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
45 This class is used only by the Experiment Controller through the Resource Factory
49 _authorized_connections = ["OMFApplication" , "OMFWifiInterface"]
52 def _register_attributes(cls):
53 """Register the attributes of an OMF Node
56 hostname = Attribute("hostname", "Hostname of the machine")
58 cls._register_attribute(hostname)
60 # XXX: We don't necessary need to have the credentials at the
61 # moment we create the RM
62 def __init__(self, ec, guid):
64 :param ec: The Experiment controller
65 :type ec: ExperimentController
66 :param guid: guid of the RM
70 super(OMFNode, self).__init__(ec, guid)
78 def valid_connection(self, guid):
79 """ Check if the connection with the guid in parameter is possible.
80 Only meaningful connections are allowed.
82 :param guid: Guid of the current RM
87 rm = self.ec.get_resource(guid)
88 if rm.rtype() in self._authorized_connections:
89 msg = "Connection between %s %s and %s %s accepted" % (
90 self.rtype(), self._guid, rm.rtype(), guid)
95 msg = "Connection between %s %s and %s %s refused" % (
96 self.rtype(), self._guid, rm.rtype(), guid)
102 """ Deploy the RM. It means : Send Xmpp Message Using OMF protocol
103 to enroll the node into the experiment.
104 It becomes DEPLOYED after sending messages to enroll the node
107 if not self._omf_api :
108 self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'),
109 self.get('xmppHost'), self.get('xmppPort'),
110 self.get('xmppPassword'), exp_id = self.exp_id)
112 if not self._omf_api :
113 msg = "Credentials are not initialzed. XMPP Connections impossible"
118 if not self.get('hostname') :
119 msg = "Hostname's value is not initialized"
125 self._omf_api.enroll_host(self.get('hostname'))
126 except AttributeError:
127 msg = "Credentials are not initialzed. XMPP Connections impossible"
130 #raise AttributeError, msg
132 super(OMFNode, self).deploy()
135 """ Discover the availables nodes
141 """ Provision some availables nodes
147 """Start the RM. It means nothing special for an interface for now
148 It becomes STARTED as soon as this method starts.
152 super(OMFNode, self).start()
155 """Stop the RM. It means nothing special for an interface for now
156 It becomes STOPPED as soon as this method stops
159 super(OMFNode, self).stop()
163 """Clean the RM at the end of the experiment
167 self._omf_api.release(self.get('hostname'))
169 OMFAPIFactory.release_api(self.get('xmppSlice'),
170 self.get('xmppHost'), self.get('xmppPort'),
171 self.get('xmppPassword'), exp_id = self.exp_id)
173 super(OMFNode, self).release()