c9609744fdb0be8546bad8e82099410dac8f6329
[sfa.git] / sfa / methods / get_aggregates.py
1 ### $Id: get_slices.py 14387 2009-07-08 18:19:11Z faiyaza $
2 ### $URL: https://svn.planet-lab.org/svn/sfa/trunk/sfa/methods/get_aggregates.py $
3 from types import StringTypes
4 from sfa.util.faults import *
5 from sfa.util.namespace import *
6 from sfa.util.method import Method
7 from sfa.util.parameter import Parameter, Mixed
8 from sfa.trust.auth import Auth
9 from sfa.server.aggregate import Aggregates
10
11 class get_aggregates(Method):
12     """
13     Get a list of connection information for all known aggregates.      
14
15     @param cred credential string specifying the rights of the caller
16     @param a Human readable name (hrn or urn), or list of hrns or None
17     @return list of dictionaries with aggregate information.  
18     """
19
20     interfaces = ['registry', 'aggregate', 'slicemgr']
21     
22     accepts = [
23         Parameter(str, "Credential string"),
24         Mixed(Parameter(str, "Human readable name (hrn or urn)"),
25               Parameter(None, "hrn not specified"))
26         ]
27
28     returns = [Parameter(dict, "Aggregate interface information")]
29     
30     def call(self, cred, xrn = None):
31         hrn, type = urn_to_hrn(xrn)
32         self.api.auth.check(cred, 'list')
33         aggregates = Aggregates(self.api).interfaces.values()
34         if hrn:
35             aggregates = [agg for agg in aggregates if agg['hrn'] == hrn]
36         return aggregates