Initial checkin
authorTony Mack <tmack@paris.CS.Princeton.EDU>
Thu, 16 Aug 2012 20:25:02 +0000 (16:25 -0400)
committerTony Mack <tmack@paris.CS.Princeton.EDU>
Thu, 16 Aug 2012 20:25:02 +0000 (16:25 -0400)
sfa/methods/Describe.py [new file with mode: 0644]

diff --git a/sfa/methods/Describe.py b/sfa/methods/Describe.py
new file mode 100644 (file)
index 0000000..7a03085
--- /dev/null
@@ -0,0 +1,61 @@
+import zlib
+
+from sfa.util.xrn import urn_to_hrn
+from sfa.util.method import Method
+from sfa.util.sfatablesRuntime import run_sfatables
+from sfa.util.faults import SfaInvalidArgument
+from sfa.trust.credential import Credential
+
+from sfa.storage.parameter import Parameter, Mixed
+
+class Describe(Method):
+    """
+    Retrieve a manifest RSpec describing the resources contained by the 
+    named entities, e.g. a single slice or a set of the slivers in a 
+    slice. This listing and description should be sufficiently 
+    descriptive to allow experimenters to use the resources.    
+    @param credential list
+    @param options dictionary
+    @return dict
+    """
+    interfaces = ['aggregate', 'slicemgr']
+    accepts = [
+        Mixed(Parameter(str, "Credential string"), 
+              Parameter(type([str]), "List of credentials")),
+        Parameter(dict, "Options")
+        ]
+    returns = Parameter(str, "List of resources")
+
+    def call(self, creds, options):
+        self.api.logger.info("interface: %s\tmethod-name: %s" % (self.api.interface, self.name))
+       
+        # client must specify a version
+        if not options.get('geni_rspec_version'):
+            if options.get('rspec_version'):
+                options['geni_rspec_version'] = options['rspec_version']
+            else:
+                raise SfaInvalidArgument('Must specify an rspec version option. geni_rspec_version cannot be null')
+        # Find the valid credentials
+        valid_creds = self.api.auth.checkCredentials(creds, 'listnodes')
+
+        # get hrn of the original caller 
+        origin_hrn = options.get('origin_hrn', None)
+        if not origin_hrn:
+            origin_hrn = Credential(string=valid_creds[0]).get_gid_caller().get_hrn()
+        rspec = self.api.manager.ListResources(self.api, creds, options)
+
+        # filter rspec through sfatables 
+        if self.api.interface in ['aggregate']:
+            chain_name = 'OUTGOING'
+        elif self.api.interface in ['slicemgr']: 
+            chain_name = 'FORWARD-OUTGOING'
+        self.api.logger.debug("ListResources: sfatables on chain %s"%chain_name)
+        filtered_rspec = run_sfatables(chain_name, '', origin_hrn, rspec) 
+        if options.has_key('geni_compressed') and options['geni_compressed'] == True:
+            filtered_rspec = zlib.compress(filtered_rspec).encode('base64')
+
+        return filtered_rspec  
+    
+