source: fedd/fedd_types.xsd @ abb87eb

axis_examplecompt_changesinfo-opsversion-1.30version-2.00version-3.01version-3.02
Last change on this file since abb87eb was abb87eb, checked in by Ted Faber <faber@…>, 16 years ago

split acces to service and experiment access
  • Property mode set to 100644
File size: 15.5 KB
Line 
1<?xml version="1.0"?>
2<xsd:schema targetNamespace="http://www.isi.edu/faber/fedd_types"
3  xmlns:tns="http://www.isi.edu/faber/fedd_types"
4  xmlns:xsd="http://www.w3.org/2000/10/XMLSchema"
5  xmlns="http://www.w3.org/2000/10/XMLSchema">
6
7  <xsd:complexType name="IDType">
8    <xsd:annotation>
9      <xsd:documentation>
10        The types of user IDs
11      </xsd:documentation>
12    </xsd:annotation>
13    <xsd:choice>
14      <xsd:element name="uuid" type="xsd:base64Binary"/>
15      <xsd:element name="fedid" type="xsd:base64Binary"/>
16      <xsd:element name="uri" type="xsd:string"/>
17      <xsd:element name="localname" type="xsd:string"/>
18      <xsd:element name="kerberosUsername" type="xsd:string"/>
19    </xsd:choice>
20  </xsd:complexType>
21
22  <xsd:complexType name="nodeType">
23    <xsd:annotation>
24      <xsd:documentation>
25        Nodes are described in terms of their images or hardware requirements.
26        This description may be empty
27      </xsd:documentation>
28    </xsd:annotation>
29    <xsd:sequence>
30      <xsd:element name="image" type="xsd:string" minOccurs="0"
31        maxOccurs="unbounded"/>
32      <xsd:element name="hardware" type="xsd:string" minOccurs="0"
33        maxOccurs="unbounded"/>
34    </xsd:sequence>
35    <xsd:attribute name="count" type="xsd:int" use="optional"/>
36  </xsd:complexType>
37
38  <xsd:simpleType name="kindType">
39    <xsd:restriction base="xsd:string">
40      <xsd:enumeration value="max"/>
41      <xsd:enumeration value="average"/>
42    </xsd:restriction>
43  </xsd:simpleType>
44
45  <xsd:complexType name="capacityType">
46    <xsd:annotation>
47      <xsd:documentation>
48        Capacity value and type of cut
49      </xsd:documentation>
50    </xsd:annotation>
51    <xsd:sequence>
52      <xsd:element name="rate" type="xsd:double"/>
53      <xsd:element name="kind" type="tns:kindType"/>
54    </xsd:sequence>
55  </xsd:complexType>
56
57  <xsd:complexType name="accessType">
58    <xsd:annotation>
59      <xsd:documentation>
60        The types of credentails used for remote project access
61      </xsd:documentation>
62    </xsd:annotation>
63    <xsd:choice>
64      <xsd:element name="X509" type="xsd:base64Binary"/>
65      <xsd:element name="sshPubkey" type="xsd:base64Binary"/>
66      <xsd:element name="pgpPubkey" type="xsd:base64Binary"/>
67    </xsd:choice>
68  </xsd:complexType>
69
70  <xsd:simpleType name="userRole">
71    <xsd:annotation>
72      <xsd:documentation>
73        Purpose of this user - service access or experiment creation
74      </xsd:documentation>
75    </xsd:annotation>
76    <xsd:restriction base="xsd:string">
77      <xsd:enumeration value="serviceAccess"/>
78      <xsd:enumeration value="experimentCreation"/>
79    </xsd:restriction>
80  </xsd:simpleType>
81
82
83  <xsd:complexType name="userType">
84    <xsd:annotation>
85      <xsd:documentation>
86        A user consists of one or both of an identifier and an access
87        credential.
88      </xsd:documentation>
89    </xsd:annotation>
90    <xsd:sequence>
91      <xsd:element name="userID" type="tns:IDType" minOccurs="0"
92        maxOccurs="1"/>
93      <xsd:element name="access" type="tns:accessType" minOccurs="0"
94        maxOccurs="unbounded"/>
95      <xsd:element name="role" type="tns:userRole" minOccurs="0" maxOccurs="1"/>
96    </xsd:sequence>
97  </xsd:complexType>
98
99  <xsd:complexType name="fedAttrType">
100    <xsd:annotation>
101      <xsd:documentation>
102        A general attribute value pair for passing federation parameters and
103        preferences
104      </xsd:documentation>
105    </xsd:annotation>
106    <xsd:sequence>
107      <xsd:element name="attribute" type="xsd:string"/>
108      <xsd:element name="value" type="xsd:string"/>
109    </xsd:sequence>
110  </xsd:complexType>
111
112
113  <xsd:complexType name="resourcesType">
114    <xsd:annotation>
115      <xsd:documentation>
116        An estimate of the resources than a federated experiment may require
117      </xsd:documentation>
118    </xsd:annotation>
119    <xsd:sequence>
120      <xsd:element name="node" type="tns:nodeType" minOccurs="0"
121        maxOccurs="unbounded" />
122      <xsd:element name="capacity" type="tns:capacityType" minOccurs="0"
123        maxOccurs="unbounded"/>
124    </xsd:sequence>
125  </xsd:complexType>
126
127  <xsd:complexType name="mapType">
128    <xsd:annotation>
129      <xsd:documentation>
130        Explicit translation of testbed attribute in a federated experiment
131        description.  Used in a creation request.
132      </xsd:documentation>
133    </xsd:annotation>
134    <xsd:sequence>
135      <xsd:element name="testbed" type="tns:IDType"/>
136      <xsd:element name="uri" type="xsd:string"/>
137    </xsd:sequence>
138  </xsd:complexType>
139
140
141  <xsd:complexType name="projectType">
142    <xsd:annotation>
143      <xsd:documentation>
144        A project name and access user
145      </xsd:documentation>
146    </xsd:annotation>
147    <xsd:sequence>
148      <xsd:element name="testbed" type="tns:IDType" minOccurs="0"
149        maxOccurs="1"/>
150      <xsd:element name="name" type="tns:IDType" minOccurs="0" maxOccurs="1"/>
151      <xsd:element name="user" type="tns:userType" minOccurs="0"
152        maxOccurs="unbounded"/>
153    </xsd:sequence>
154  </xsd:complexType>
155
156  <xsd:complexType name="emulabType">
157    <xsd:annotation>
158      <xsd:documentation>
159        The information needed to swap an emulab experiment in
160      </xsd:documentation>
161    </xsd:annotation>
162    <xsd:sequence>
163      <xsd:element name="project" type="tns:projectType"/>
164      <xsd:element name="domain" type="xsd:string"/>
165      <xsd:element name="boss" type="xsd:string"/>
166      <xsd:element name="ops" type="xsd:string"/>
167      <xsd:element name="fileServer" type="xsd:string"/>
168      <xsd:element name="eventServer" type="xsd:string"/>
169      <xsd:element name="fedAttr" type="tns:fedAttrType" minOccurs="0"
170        maxOccurs="unbounded"/>
171    </xsd:sequence>
172  </xsd:complexType>
173
174  <xsd:complexType name="federatedExperimentType">
175    <xsd:annotation>
176      <xsd:documentation>
177        The information about a federated sub-experiment
178      </xsd:documentation>
179    </xsd:annotation>
180    <xsd:sequence>
181      <xsd:element name="name" type="tns:IDType" minOccurs="1" 
182        maxOccurs="unbounded"/>
183      <xsd:element name="emulab" type="tns:emulabType"/>
184      <xsd:element name="master" type="xsd:boolean"/>
185    </xsd:sequence>
186  </xsd:complexType>
187
188
189  <xsd:complexType name="vtoponodeType">
190    <xsd:annotation>
191      <xsd:documentation>
192        Node in the virtual topology of a federated experiment (emulab legacy)
193      </xsd:documentation>
194    </xsd:annotation>
195    <xsd:sequence>
196      <xsd:element name="vname" type="xsd:string"/>
197      <xsd:element name="ips" type="xsd:string"/>
198    </xsd:sequence>
199  </xsd:complexType>
200
201  <xsd:complexType name="vtopolanType">
202    <xsd:annotation>
203      <xsd:documentation>
204        LAN in the virtual topology of a federated experiment (emulab legacy)
205      </xsd:documentation>
206    </xsd:annotation>
207    <xsd:sequence>
208      <xsd:element name="vname" type="xsd:string"/>
209      <xsd:element name="vnode" type="xsd:string"/>
210      <xsd:element name="ip" type="xsd:string"/>
211      <xsd:element name="bandwidth" type="xsd:int"/>
212      <xsd:element name="delay" type="xsd:float"/>
213      <xsd:element name="member" type="xsd:string"/>
214    </xsd:sequence>
215  </xsd:complexType>
216
217  <xsd:complexType name="vtopoType">
218    <xsd:annotation>
219      <xsd:documentation>
220        The virtual topology of a federated experiment (emulab legacy)
221      </xsd:documentation>
222    </xsd:annotation>
223    <xsd:sequence>
224      <xsd:element name="node" type="tns:vtoponodeType" minOccurs="0" 
225        maxOccurs="unbounded" />
226      <xsd:element name="lan" type="tns:vtopolanType" minOccurs="0"
227        maxOccurs="unbounded"/>
228    </xsd:sequence>
229  </xsd:complexType>
230
231  <xsd:complexType name="visnodeType">
232    <xsd:annotation>
233      <xsd:documentation>
234        Node in the visualization of a federated experiment (emulab legacy)
235      </xsd:documentation>
236    </xsd:annotation>
237    <xsd:sequence>
238      <xsd:element name="name" type="xsd:string"/>
239      <xsd:element name="x" type="xsd:int"/>
240      <xsd:element name="y" type="xsd:int"/>
241      <xsd:element name="type" type="xsd:string"/>
242    </xsd:sequence>
243  </xsd:complexType>
244
245  <xsd:complexType name="visType">
246    <xsd:annotation>
247      <xsd:documentation>
248        The visualization of a federated experiment (emulab legacy)
249      </xsd:documentation>
250    </xsd:annotation>
251    <xsd:sequence>
252      <xsd:element name="node" type="tns:visnodeType" minOccurs="0"
253        maxOccurs="unbounded"/>
254    </xsd:sequence>
255  </xsd:complexType>
256
257  <xsd:complexType name="projectAllocType">
258    <xsd:annotation>
259      <xsd:documentation>
260        The information needed to create a dynamic project
261      </xsd:documentation>
262    </xsd:annotation>
263    <xsd:sequence>
264      <xsd:element name="project" type="tns:projectType"/>
265      <xsd:element name="resources" type="tns:resourcesType" 
266        minOccurs="0" maxOccurs="1"/>
267    </xsd:sequence>
268  </xsd:complexType>
269
270  <xsd:complexType name="projectAllocResponseType">
271    <xsd:annotation>
272      <xsd:documentation>
273        The information needed to create a dynamic project
274      </xsd:documentation>
275    </xsd:annotation>
276    <xsd:sequence>
277      <xsd:element name="project" type="tns:projectType"/>
278    </xsd:sequence>
279  </xsd:complexType>
280
281  <xsd:complexType name="experimentDescriptionType">
282    <xsd:annotation>
283      <xsd:documentation>
284        The description of the federated experiment
285      </xsd:documentation>
286    </xsd:annotation>
287    <xsd:choice>
288      <xsd:element name="ns2description" type="xsd:base64Binary"/>
289    </xsd:choice>
290  </xsd:complexType>
291
292
293  <xsd:complexType name="requestType">
294    <xsd:annotation>
295      <xsd:documentation>
296        The full on request type.
297      </xsd:documentation>
298    </xsd:annotation>
299    <xsd:sequence>
300      <xsd:element name="destinationTestbed" type="tns:IDType"
301        minOccurs="0" maxOccurs="1" />
302      <xsd:choice>
303        <xsd:element name="project" type="tns:projectType" minOccurs="0" 
304          maxOccurs="1"/>
305        <xsd:element name="user" type="tns:userType" minOccurs="0"
306          maxOccurs="unbounded"/>
307      </xsd:choice>
308      <xsd:element name="resources" type="tns:resourcesType" minOccurs="0" 
309        maxOccurs="1"/>
310      <xsd:element name="createAccess" type="tns:accessType" minOccurs="1" 
311        maxOccurs="unbounded"/>
312      <xsd:element name="serviceAccess" type="tns:accessType" minOccurs="1" 
313        maxOccurs="unbounded"/>
314      <xsd:element name="allocID" type="tns:IDType"/>
315      <xsd:element name="when" type="xsd:dateTime" minOccurs="0" maxOccurs="1"/>
316      <xsd:element name="until" type="xsd:dateTime" minOccurs="0" 
317        maxOccurs="1"/>
318    </xsd:sequence>
319  </xsd:complexType>
320
321  <xsd:complexType name="responseType">
322    <xsd:annotation>
323      <xsd:documentation>
324        The full on response type.
325      </xsd:documentation>
326    </xsd:annotation>
327    <xsd:sequence>
328      <xsd:element name="allocID" type="tns:IDType"/>
329      <xsd:element name="emulab" type="tns:emulabType"/>
330      <xsd:element name="when" type="xsd:dateTime" minOccurs="0" maxOccurs="1"/>
331      <xsd:element name="until" type="xsd:dateTime" minOccurs="0" 
332        maxOccurs="1"/>
333    </xsd:sequence>
334  </xsd:complexType>
335
336  <xsd:complexType name="createRequestType">
337    <xsd:annotation>
338      <xsd:documentation>
339        A request to embed a federated experiment across testbeds
340      </xsd:documentation>
341    </xsd:annotation>
342    <xsd:sequence>
343      <xsd:element name="testbedmap" type="tns:mapType" minOccurs="0"
344        maxOccurs="unbounded"/>
345      <xsd:element name="user" type="tns:userType" minOccurs="1"
346        maxOccurs="unbounded"/>
347      <xsd:element name="experimentdescription" 
348        type="tns:experimentDescriptionType"/>
349      <xsd:element name="master" type="xsd:string"/>
350      <xsd:element name="experimentID" type="tns:IDType" minOccurs="0" 
351        maxOccurs="1"/>
352    </xsd:sequence>
353  </xsd:complexType>
354
355  <xsd:complexType name="createResponseType">
356    <xsd:annotation>
357      <xsd:documentation>
358        A request to embed a federated experiment across testbeds
359      </xsd:documentation>
360    </xsd:annotation>
361    <xsd:sequence>
362      <xsd:element name="federant" type="tns:federatedExperimentType" 
363        minOccurs="1" maxOccurs="unbounded"/>
364      <xsd:element name="vtopo" type="tns:vtopoType" minOccurs="0"
365        maxOccurs="1"/>
366      <xsd:element name="vis" type="tns:visType" minOccurs="0"
367        maxOccurs="1"/>
368      <xsd:element name="experimentID" type="tns:IDType" minOccurs="1"
369        maxOccurs="unbounded"/>
370      <xsd:element name="experimentAccess" type="tns:accessType" minOccurs="0"
371        maxOccurs="1"/>
372    </xsd:sequence>
373  </xsd:complexType>
374
375  <xsd:complexType name="vtopoRequestType">
376    <xsd:annotation>
377      <xsd:documentation>
378        Request for an existing experiment's topology
379      </xsd:documentation>
380    </xsd:annotation>
381    <xsd:sequence>
382      <xsd:element name="experiment" type="tns:IDType"/>
383    </xsd:sequence>
384  </xsd:complexType>
385
386  <xsd:complexType name="vtopoResponseType">
387    <xsd:annotation>
388      <xsd:documentation>
389        Request for an existing experiment's topology
390      </xsd:documentation>
391    </xsd:annotation>
392    <xsd:sequence>
393      <xsd:element name="experiment" type="tns:IDType"/>
394      <xsd:element name="vtopo" type="tns:vtopoType"/>
395    </xsd:sequence>
396  </xsd:complexType>
397
398
399  <xsd:complexType name="visRequestType">
400    <xsd:annotation>
401      <xsd:documentation>
402        Request for an existing experiment's topology
403      </xsd:documentation>
404    </xsd:annotation>
405    <xsd:sequence>
406      <xsd:element name="experiment" type="tns:IDType"/>
407    </xsd:sequence>
408  </xsd:complexType>
409
410  <xsd:complexType name="visResponseType">
411    <xsd:annotation>
412      <xsd:documentation>
413        Request for an existing experiment's topology
414      </xsd:documentation>
415    </xsd:annotation>
416    <xsd:sequence>
417      <xsd:element name="experiment" type="tns:IDType"/>
418      <xsd:element name="vis" type="tns:visType"/>
419    </xsd:sequence>
420  </xsd:complexType>
421
422  <xsd:complexType name="infoRequestType">
423    <xsd:annotation>
424      <xsd:documentation>
425        Request for an existing experiment's topology
426      </xsd:documentation>
427    </xsd:annotation>
428    <xsd:sequence>
429      <xsd:element name="experiment" type="tns:IDType"/>
430    </xsd:sequence>
431  </xsd:complexType>
432
433  <xsd:complexType name="infoResponseType">
434    <xsd:annotation>
435      <xsd:documentation>
436        Information on an instantiated experiment.  The createResponse without
437        the secret information
438      </xsd:documentation>
439    </xsd:annotation>
440    <xsd:sequence>
441      <xsd:element name="federant" type="tns:federatedExperimentType" 
442        minOccurs="1" maxOccurs="unbounded"/>
443      <xsd:element name="vtopo" type="tns:vtopoType" minOccurs="0"
444        maxOccurs="1"/>
445      <xsd:element name="vis" type="tns:visType" minOccurs="0"
446        maxOccurs="1"/>
447      <xsd:element name="experimentID" type="tns:IDType" minOccurs="1"
448        maxOccurs="unbounded"/>
449    </xsd:sequence>
450  </xsd:complexType>
451
452  <xsd:complexType name="terminateRequestType">
453    <xsd:annotation>
454      <xsd:documentation>
455        Request to terminate an experiment
456      </xsd:documentation>
457    </xsd:annotation>
458    <xsd:sequence>
459      <xsd:element name="experiment" type="tns:IDType"/>
460    </xsd:sequence>
461  </xsd:complexType>
462
463  <xsd:complexType name="terminateResponseType">
464    <xsd:annotation>
465      <xsd:documentation>
466        Request to terminate an experiment
467      </xsd:documentation>
468    </xsd:annotation>
469    <xsd:sequence>
470      <xsd:element name="experiment" type="tns:IDType"/>
471    </xsd:sequence>
472  </xsd:complexType>
473
474
475  <xsd:complexType name="faultType">
476    <xsd:sequence>
477      <xsd:element name="code" type="xsd:int">
478        <xsd:restriction>
479          <xsd:enumeration value="1"/>  <!-- access denied -->
480          <xsd:enumeration value="2"/>  <!-- proxy error -->
481          <xsd:enumeration value="3"/>  <!-- badly formed request -->
482          <xsd:enumeration value="4"/>  <!-- server configuration error -->
483          <xsd:enumeration value="5"/>  <!-- internal error -->
484          <xsd:enumeration value="6"/>  <!-- partial instantiation -->
485          <xsd:enumeration value="7"/>  <!-- federant error -->
486        </xsd:restriction>
487      </xsd:element>
488      <xsd:element name="errstr" minOccurs="0" maxOccurs="1" type="xsd:string">
489      </xsd:element>
490      <xsd:element name="desc" type="xsd:string"/>
491    </xsd:sequence>
492  </xsd:complexType>
493</xsd:schema>
Note: See TracBrowser for help on using the repository browser.