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>
21 from nepi.execution.resource import ResourceManager, clsinit_copy, \
22 ResourceState, reschedule_delay
23 from nepi.execution.attribute import Attribute, Flags
24 from nepi.resources.omf.omf6_resource import OMF6Resource
25 from nepi.resources.omf.omf6_api import OMF6APIFactory
30 class OMF6Node(OMF6Resource):
32 .. class:: Class Args :
34 :param ec: The Experiment controller
35 :type ec: ExperimentController
36 :param guid: guid of the RM
38 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
43 _authorized_connections = ["OMF6Application" , "OMFWifiInterface"]
46 def _register_attributes(cls):
47 """Register the attributes of an OMF Node
50 hostname = Attribute("hostname", "Hostname of the machine")
52 cls._register_attribute(hostname)
54 # XXX: We don't necessary need to have the credentials at the
55 # moment we create the RM
56 def __init__(self, ec, guid):
58 :param ec: The Experiment controller
59 :type ec: ExperimentController
60 :param guid: guid of the RM
64 super(OMF6Node, self).__init__(ec, guid)
72 def valid_connection(self, guid):
73 """ Check if the connection with the guid in parameter is possible.
74 Only meaningful connections are allowed.
76 :param guid: Guid of the current RM
81 rm = self.ec.get_resource(guid)
82 if rm.get_rtype() in self._authorized_connections:
83 msg = "Connection between %s %s and %s %s accepted" % (
84 self.get_rtype(), self._guid, rm.get_rtype(), guid)
89 msg = "Connection between %s %s and %s %s refused" % (
90 self.get_rtype(), self._guid, rm.get_rtype(), guid)
96 """ Deploy the RM. It means : Send Xmpp Message Using OMF protocol
97 to enroll the node into the experiment.
98 It becomes DEPLOYED after sending messages to enroll the node
101 if not (self.get('xmppUser') and self.get('xmppHost')
102 and self.get('xmppPort') and self.get('xmppPassword')):
103 msg = "Credentials are not initialzed. XMPP Connections impossible"
105 raise RuntimeError, msg
107 if not self._omf_api :
108 self._omf_api = OMF6APIFactory.get_api(self.get('xmppHost'),
109 self.get('xmppUser'), self.get('xmppPort'),
110 self.get('xmppPassword'), exp_id = self.exp_id)
112 if not self.get('hostname') :
113 msg = "Hostname's value is not initialized"
115 raise RuntimeError, msg
117 self._omf_api.enroll_topic(self.get('hostname'))
119 super(OMF6Node, self).do_deploy()
121 def do_release(self):
122 """ Clean the RM at the end of the experiment
126 # Should be deleted from the RC
127 #self._omf_api.frcp_release(self.get('hostname'))
129 OMF6APIFactory.release_api(self.get('xmppHost'),
130 self.get('xmppUser'), self.get('xmppPort'),
131 self.get('xmppPassword'), exp_id = self.exp_id)
133 super(OMF6Node, self).do_release()