8b7364449f609af8f48147fac79874db2c4afe1f
[sfa.git] / sfa / managers / aggregate_manager.py
1 import socket
2 from sfa.rspecs.version_manager import VersionManager
3 from sfa.util.version import version_core
4 from sfa.util.xrn import Xrn
5 from sfa.util.callids import Callids
6 from sfa.util.sfalogging import logger
7 from sfa.util.faults import SfaInvalidArgument, InvalidRSpecVersion
8 from sfa.server.api_versions import ApiVersions
9
10
11 class AggregateManager:
12
13     def __init__ (self, config): pass
14     
15     # essentially a union of the core version, the generic version (this code) and
16     # whatever the driver needs to expose
17
18     def rspec_versions(self):
19         version_manager = VersionManager()
20         ad_rspec_versions = []
21         request_rspec_versions = []
22         for rspec_version in version_manager.versions:
23             if rspec_version.content_type in ['*', 'ad']:
24                 ad_rspec_versions.append(rspec_version.to_dict())
25             if rspec_version.content_type in ['*', 'request']:
26                 request_rspec_versions.append(rspec_version.to_dict())
27         return {
28             'geni_request_rspec_versions': request_rspec_versions,
29             'geni_ad_rspec_versions': ad_rspec_versions,
30             }
31
32     def get_rspec_version_string(self, rspec_version, options=None):
33         if options is None: options={}
34         version_string = "rspec_%s" % (rspec_version)
35
36         #panos adding the info option to the caching key (can be improved)
37         if options.get('info'):
38             version_string = version_string + "_"+options.get('info', 'default')
39
40         # Adding the list_leases option to the caching key
41         if options.get('list_leases'):
42             version_string = version_string + "_"+options.get('list_leases', 'default')
43
44         # Adding geni_available to caching key
45         if options.get('geni_available'):
46             version_string = version_string + "_" + str(options.get('geni_available'))
47
48         return version_string
49
50     def GetVersion(self, api, options):
51         xrn=Xrn(api.hrn, type='authority+am')
52         version = version_core()
53         cred_types = [{'geni_type': 'geni_sfa', 'geni_version': str(i)} for i in range(4)[-2:]]
54         geni_api_versions = ApiVersions().get_versions()
55         geni_api_versions['3'] = 'http://%s:%s' % (api.config.sfa_aggregate_host, api.config.sfa_aggregate_port)
56         version_generic = {
57             'testbed': api.driver.testbed_name(),
58             'interface':'aggregate',
59             'sfa': 3,
60             'hrn':xrn.get_hrn(),
61             'urn':xrn.get_urn(),
62             'geni_api': 3,
63             'geni_api_versions': geni_api_versions,
64             'geni_single_allocation': 0, # Accept operations that act on as subset of slivers in a given state.
65             'geni_allocate': 'geni_many',# Multiple slivers can exist and be incrementally added, including those which connect or overlap in some way.
66             'geni_credential_types': cred_types,
67             'geni_handles_speaksfor': True,     # supports 'speaks for' credentials
68         }
69         version.update(version_generic)
70         version.update(self.rspec_versions())
71         testbed_version = api.driver.aggregate_version()
72         version.update(testbed_version)
73         return version
74     
75     def ListResources(self, api, creds, options):
76         call_id = options.get('call_id')
77         if Callids().already_handled(call_id): return ""
78
79         # get the rspec's return format from options
80         version_manager = VersionManager()
81         rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
82         version_string = self.get_rspec_version_string(rspec_version, options)
83
84         # look in cache first
85         cached_requested = options.get('cached', True)
86         if cached_requested and api.driver.cache:
87             rspec = api.driver.cache.get(version_string)
88             if rspec:
89                 logger.debug("%s.ListResources returning cached advertisement" % (api.driver.__module__))
90                 return rspec
91        
92         rspec = api.driver.list_resources (rspec_version, options) 
93         if api.driver.cache:
94             logger.debug("%s.ListResources stores advertisement in cache" % (api.driver.__module__))
95             api.driver.cache.add(version_string, rspec)    
96         return rspec
97     
98     def Describe(self, api, creds, urns, options):
99         call_id = options.get('call_id')
100         if Callids().already_handled(call_id): return ""
101
102         version_manager = VersionManager()
103         rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
104         return api.driver.describe(urns, rspec_version, options)
105         
106     
107     def Status (self, api, urns, creds, options):
108         call_id = options.get('call_id')
109         if Callids().already_handled(call_id): return {}
110         return api.driver.status (urns, options=options)
111    
112
113     def Allocate(self, api, xrn, creds, rspec_string, expiration, options):
114         """
115         Allocate resources as described in a request RSpec argument 
116         to a slice with the named URN.
117         """
118         call_id = options.get('call_id')
119         if Callids().already_handled(call_id): return ""
120         return api.driver.allocate(xrn, rspec_string, expiration, options)
121  
122     def Provision(self, api, xrns, creds, options):
123         """
124         Create the sliver[s] (slice) at this aggregate.    
125         Verify HRN and initialize the slice record in PLC if necessary.
126         """
127         call_id = options.get('call_id')
128         if Callids().already_handled(call_id): return ""
129
130         # make sure geni_rspec_version is specified in options
131         if 'geni_rspec_version' not in options:
132             msg = 'geni_rspec_version is required and must be set in options struct'
133             raise SfaInvalidArgument(msg, 'geni_rspec_version')
134         # make sure we support the requested rspec version
135         version_manager = VersionManager()
136         rspec_version = version_manager.get_version(options['geni_rspec_version']) 
137         if not rspec_version:
138             raise InvalidRSpecVersion(options['geni_rspec_version'])
139                        
140         return api.driver.provision(xrns, options)
141     
142     def Delete(self, api, xrns, creds, options):
143         call_id = options.get('call_id')
144         if Callids().already_handled(call_id): return True
145         return api.driver.delete(xrns, options)
146
147     def Renew(self, api, xrns, creds, expiration_time, options):
148         call_id = options.get('call_id')
149         if Callids().already_handled(call_id): return True
150
151         return api.driver.renew(xrns, expiration_time, options)
152
153     def PerformOperationalAction(self, api, xrns, creds, action, options=None):
154         if options is None: options={}
155         call_id = options.get('call_id')
156         if Callids().already_handled(call_id): return True
157         return api.driver.perform_operational_action(xrns, action, options) 
158
159     def Shutdown(self, api, xrn, creds, options=None):
160         if options is None: options={}
161         call_id = options.get('call_id')
162         if Callids().already_handled(call_id): return True
163         return api.driver.shutdown(xrn, options) 
164