split api and driver
[sfa.git] / sfa / generic / __init__.py
1 from sfa.util.sfalogging import logger
2 from sfa.util.config import Config
3
4 from sfa.managers.managerwrapper import ManagerWrapper
5
6 # a bundle is the combination of 
7 # (*) an api that reacts on the incoming requests to trigger the API methods
8 # (*) a manager that implements the function of the service, 
9 #     either aggregate, registry, or slicemgr
10 # (*) a driver that controls the underlying testbed
11
12
13 # The Generic class is a utility that uses the configuration to figure out 
14 # which combination of these pieces need to be put together 
15 # from config.
16 # this extra indirection is needed to adapt to the current naming scheme
17 # where we have 'pl' and 'plc' and components and the like, that does not 
18 # yet follow a sensible scheme
19
20 # needs refinements to cache more efficiently, esp. wrt the config
21
22 class Generic:
23
24     def __init__ (self, flavour, config):
25         self.flavour=flavour
26         self.config=config
27
28     # proof of concept
29     # example flavour='pl' -> sfa.generic.pl.pl()
30     @staticmethod
31     def the_flavour (flavour=None, config=None):
32         if config is None: config=Config()
33         if flavour is None: flavour=config.SFA_GENERIC_FLAVOUR
34         flavour = flavour.lower()
35         #mixed = flavour.capitalize()
36         module_path="sfa.generic.%s"%flavour
37         classname="%s"%flavour
38         logger.info("Generic.the_flavour with flavour=%s"%flavour)
39         try:
40             module = __import__ (module_path, globals(), locals(), [classname])
41             return getattr(module, classname)(flavour,config)
42         except:
43             logger.log_exc("Cannot locate generic instance with flavour=%s"%flavour)
44
45     # in the simplest case these can be redefined to the class/module objects to be used
46     # see pl.py for an example
47     # some descendant of SfaApi
48     def api_class (self) : pass
49     # in practical terms these are modules for now
50     def registry_class (self) : pass
51     def slicemgr_class (self) : pass
52     def aggregate_class (self) : pass
53     def component_class (self) : pass
54
55
56     # build an API object
57     # insert a manager instance 
58     def make_api (self, *args, **kwargs):
59         # interface is a required arg
60         if not 'interface' in kwargs:
61             logger.critical("Generic.make_api: no interface found")
62         api = self.api_class()(*args, **kwargs)
63         manager = self.make_manager(api.interface)
64         driver = self.make_driver (api.config)
65         ### arrange stuff together
66         # add a manager wrapper
67         manager = ManagerWrapper(manager,api.interface)
68         api.manager=manager
69         # insert driver in manager
70         manager.driver=driver
71         # add it in api as well for convenience
72         api.driver=driver
73         return api
74
75     def make_manager (self, interface):
76         """
77         interface expected in ['registry', 'aggregate', 'slice', 'component']
78         flavour is e.g. 'pl' or 'max' or whatever
79         """
80         flavour = self.flavour
81         message="Generic.make_manager for interface=%s and flavour=%s"%(interface,flavour)
82         
83         classname = "%s_class"%interface
84         try:
85             module = getattr(self,classname)()
86             logger.info("%s : %s"%(message,module))
87             return module
88         except:
89             logger.log_exc_critical(message)
90         
91     def make_driver (self, config):
92         flavour = self.flavour
93         message="Generic.make_driver for flavour=%s"%(flavour)
94         
95         classname = "driver_class"
96         try:
97             class_obj = getattr(self,classname)()
98             logger.info("%s : %s"%(message,class_obj))
99             return class_obj(config)
100         except:
101             logger.log_exc_critical(message)
102         
103