cdd6faeb22fed43830c1b0f08942d71158a8eb7a
[sfa.git] / sfa / managers / driver.py
1
2 # an attempt to document what a driver class should provide, 
3 # and implement reasonable defaults
4 #
5
6 class Driver:
7     
8     def __init__ (self, config): 
9         # this is the hrn attached to the running server
10         self.hrn = config.SFA_INTERFACE_HRN
11
12     ########################################
13     ########## registry oriented
14     ########################################
15
16     # NOTE: the is_enabled method is deprecated
17     # it was only making things confusing, as the (PL) import mechanism would
18     # ignore not enabled users anyway..
19
20     # the following is used in Resolve (registry) when run in full mode
21     #     after looking up the sfa db, we wish to be able to display
22     #     testbed-specific info as well
23     # this at minima should fill in the 'researcher' field for slice records
24     # as this information is then used to compute rights
25     # roadmap: there is an intention to redesign the SFA database so as to clear up 
26     # this constraint, based on the principle that SFA should not rely on the
27     # testbed database to perform such a core operation (i.e. getting rights right)
28     def augment_records_with_testbed_info (self, sfa_records):
29         return sfa_records
30
31     # incoming record, as provided by the client to the Register API call
32     # expected retcod 'pointer'
33     # 'pointer' is typically an int db id, that makes sense in the testbed environment
34     # -1 if this feature is not relevant 
35     def register (self, sfa_record, hrn, pub_key) : 
36         return -1
37
38     # incoming record is the existing sfa_record
39     # expected retcod boolean, error message logged if result is False
40     def remove (self, sfa_record): 
41         return True
42
43     # incoming are the sfa_record:
44     # (*) old_sfa_record is what we have in the db for that hrn
45     # (*) new_sfa_record is what was passed in the Update call
46     # expected retcod boolean, error message logged if result is False
47     # NOTE 1. about keys
48     # this is confusing because a user may have several ssh keys in 
49     # the planetlab database, but we need to pick one to generate its cert
50     # so as much as in principle we should be able to use new_sfa_record['keys']
51     # the manager code actually picks one (the first one), and it seems safer
52     # to pass it along rather than depending on the driver code to do the same
53     #
54     # NOTE 2. about keys
55     # when changing the ssh key through this method the gid gets changed too
56     # should anything be passed back to the caller in this case ?
57     def update (self, old_sfa_record, new_sfa_record, hrn, new_key): 
58         return True
59
60     ########################################
61     ########## aggregate oriented
62     ########################################
63     
64     # a name for identifying the kind of testbed
65     def testbed_name (self): return "undefined"
66
67     # a dictionary that gets appended to the generic answer to GetVersion
68     # 'geni_request_rspec_versions' and 'geni_ad_rspec_versions' are mandatory
69     def aggregate_version (self): return {}
70
71     # the answer to ListSlices, a list of slice urns
72     def list_slices (self, creds, options):
73         return []
74
75     # answer to ListResources
76     # first 2 args are None in case of resource discovery
77     # expected : rspec (xml string)
78     def list_resources (self, slice_urn, slice_hrn, creds, options):
79         return "dummy Driver.list_resources needs to be redefined"
80
81     # the answer to SliverStatus on a given slice
82     def sliver_status (self, slice_urn, slice_hrn): return {}
83
84     # the answer to CreateSliver on a given slice
85     # expected to return a valid rspec 
86     # identical to ListResources after the slice was modified
87     def create_sliver (self, slice_urn, slice_hrn, creds, rspec_string, users, options):
88         return "dummy Driver.create_sliver needs to be redefined"
89
90     # the answer to DeleteSliver on a given slice
91     def delete_sliver (self, slice_urn, slice_hrn, creds, options):
92         return "dummy Driver.delete_sliver needs to be redefined"
93
94     # the answer to RenewSliver
95     # expected to return a boolean to indicate success
96     def renew_sliver (self, slice_urn, slice_hrn, creds, expiration_time, options):
97         return False
98
99     # the answer to start_slice/stop_slice
100     # 1 means success, otherwise raise exception
101     def start_slice (self, slice_urn, slice_xrn, creds):
102         return 1
103     def stop_slice (self, slice_urn, slice_xrn, creds):
104         return 1
105     # somehow this one does not have creds - not implemented in PL anyways
106     def reset_slice (self, slice_urn, slice_xrn, creds):
107         return 1
108
109     # the answer to GetTicket
110     # expected is a ticket, i.e. a certificate, as a string
111     def get_ticket (self, slice_urn, slice_xrn, creds, rspec, options):
112         return "dummy Driver.get_ticket needs to be redefined"
113