Changes between Version 10 and Version 11 of LayoutAspect

Timestamp:

Oct 15, 2013 4:15:31 PM (11 years ago)

Author:

faber

Comment:

--

LayoutAspect

@@ -123 +123 @@
 
 Implementations will support adding new views to the extent that it is possible to do so.
+
+== Interfaces ==
+
+This section discusses the encodeing of a view used for exchange and the interfaces to the Descartes interface that are relevant to manipulating topology views.
+
+The exact format of these interfaces - the XSD defining the exchange format and RPC calls - are still in a bit of flux.
+
+=== View Exchange Format (topdl v2) ===
+
+When passing views from researchers to the testbed or from the testbed to a reseacrher Descartes uses an XML format based on [http://fedd.deterlab.net/wiki/TopDl topdl].  This document defines version 2 of topdl that supports regions.  There are a few other changes mentioned here.
+
+A topdl topology element consists of 4 sections
+
+ * Substrates
+ * Elements
+ * Fragments
+ * Name maps
+
+The substrates and elements sections are exactly as defined in [http://fedd.deterlab.net/wiki/TopDl topdl v1], except that regions are allowed as elements.  A region includes a name and the fragment name that it expands to.  The fragment name is either the name of a fragment in the fragments section, or a name that can be used to request the fragment from the testbed.
+
+The fragments section contains fragment objects that are composed of elements and substrates.  These may be referenced by region objects in the main topology or by region elements in fragements.
+
+The name maps are a set of mappings, keyed by the pathname of a region.  Each includes 
+
+ * the region interface to fragment element mapping
+ * a fragment element or substrate name to global name mapping
+ * a description of the region
+
+XSD for this format is forthcoming.
+
+=== Topology Calls to the Experiment API ===
+
+Researchers interested inworking with experiment topologies can make the following calls on the Experiment API.
+
+ * getViews(ExperimentName)
+
+ExperimentName is a string returned from viewExperiments. Returns a list of string pairs, the first being the name of a topology view and the second being a short description of the view.
+
+ * getTopology(ExperimentName, ViewName)
+
+ExperimentName is a string from viewExperiments, and ViewName is a string from getViews. Returns a topdl v2 file containing the initial topology.
+
+ * getFragment(ExperimentName, ViewName, FragmentName)
+
+ExperimentName is a string from viewExperiments, and ViewName is a string from getViews.  Returns a topdl v2 file without elements or substrates, but with at least the requested fragment. It may also include other fragments and name maps.
+
+ * addView(ExperimentName, ViewName, topdl)
+
+ExperimentName is the name of an existing experiment, from viewExperiments, and topdl is a new view of that experiment.  If the testbed can determine that the view describes the same topology as the experiment currently has, the new view will be added with viewName as the name.  If the topology does not match, or the testbed cannot determine that it does so, an error will be returned.  Topdl is a the new view encoded in topdl.  There will be a version of this that can retrieve the topdl from a URL as well.
+
+ * removeView(ExperimentName, ViewName)
+
+ExperimentName is a string from viewExperiments, and ViewName is a string from getViews. Remove the given view from the experiment.  Will fail if the view is the last one.
+