/[volute]/trunk/projects/grid/uws/doc/UWS.xsd
ViewVC logotype

Contents of /trunk/projects/grid/uws/doc/UWS.xsd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2751 - (show annotations)
Mon Oct 20 07:45:19 2014 UTC (5 years, 9 months ago) by harripa@gmail.com
File MIME type: text/plain
File size: 14818 byte(s)
minor documentation updates
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- $Revision$ $Date$ $HeadURL$ -->
3 <!-- UWS schema - Paul Harrison May 2008 -->
4 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
5 targetNamespace="http://www.ivoa.net/xml/UWS/v1.1" xmlns:uws="http://www.ivoa.net/xml/UWS/v1.1"
6 xmlns:xlink="http://www.w3.org/1999/xlink" elementFormDefault="qualified"
7 attributeFormDefault="unqualified"
8 >
9 <!--
10 <xs:import namespace="http://www.w3.org/1999/xlink"
11 schemaLocation="../../../stc/STC/v1.30/XLINK.xsd" />
12 -->
13 <xs:import namespace="http://www.w3.org/1999/xlink"
14 schemaLocation="http://www.ivoa.net/xml/Xlink/xlink.xsd"/>
15
16 <xs:complexType name="ShortJobDescription">
17 <xs:sequence>
18 <xs:element name="phase" type="uws:ExecutionPhase">
19 <xs:annotation>
20 <xs:documentation> the execution phase - returned at
21 /(jobs)/(jobid)/phase</xs:documentation>
22 </xs:annotation>
23 </xs:element>
24 </xs:sequence>
25 <xs:attribute name="id" type="uws:JobIdentifier" use="required"></xs:attribute>
26 <xs:attributeGroup ref="uws:reference"></xs:attributeGroup>
27 </xs:complexType>
28 <xs:attributeGroup name="reference">
29 <xs:annotation>
30 <xs:documentation>standard xlink references
31 </xs:documentation>
32 </xs:annotation>
33 <xs:attribute ref="xlink:type" use="optional"
34 default="simple" />
35 <xs:attribute ref="xlink:href" use="optional" />
36 </xs:attributeGroup>
37 <xs:simpleType name="ExecutionPhase">
38 <xs:annotation>
39 <xs:documentation>
40 Enumeration of possible phases of job execution
41 </xs:documentation>
42 </xs:annotation>
43 <xs:restriction base="xs:string">
44 <xs:enumeration value="PENDING">
45 <xs:annotation>
46 <xs:documentation>
47 The first phase a job is entered into - this is where
48 a job is being set up but no request to run has
49 occurred.
50 </xs:documentation>
51 </xs:annotation>
52 </xs:enumeration>
53 <xs:enumeration value="QUEUED">
54 <xs:annotation>
55 <xs:documentation>
56 A job has been accepted for execution but is waiting
57 in a queue
58 </xs:documentation>
59 </xs:annotation>
60 </xs:enumeration>
61 <xs:enumeration value="EXECUTING">
62 <xs:annotation>
63 <xs:documentation>A job is running</xs:documentation>
64 </xs:annotation>
65 </xs:enumeration>
66 <xs:enumeration value="COMPLETED">
67 <xs:annotation>
68 <xs:documentation>
69 A job has completed successfully
70 </xs:documentation>
71 </xs:annotation>
72 </xs:enumeration>
73 <xs:enumeration value="ERROR">
74 <xs:annotation>
75 <xs:documentation>
76 Some form of error has occurred
77 </xs:documentation>
78 </xs:annotation>
79 </xs:enumeration>
80 <xs:enumeration value="UNKNOWN">
81 <xs:annotation>
82 <xs:documentation>
83 The job is in an unknown state.
84 </xs:documentation>
85 </xs:annotation>
86 </xs:enumeration>
87 <xs:enumeration value="HELD">
88 <xs:annotation>
89 <xs:documentation>
90 The job is HELD pending execution and will not
91 automatically be executed - can occur after a
92 PHASE=RUN request has been made (cf PENDING).
93 </xs:documentation>
94 </xs:annotation>
95 </xs:enumeration>
96 <xs:enumeration value="SUSPENDED">
97 <xs:annotation>
98 <xs:documentation>
99 The job has been suspended by the system during
100 execution
101 </xs:documentation>
102 </xs:annotation>
103 </xs:enumeration>
104 <xs:enumeration value="ABORTED">
105 <xs:annotation>
106 <xs:documentation>
107 The job has been aborted, either by user request or by
108 the server because of lack or overuse of resources.
109 </xs:documentation>
110 </xs:annotation>
111 </xs:enumeration>
112 <xs:enumeration value="ARCHIVED">
113 <xs:annotation>
114 <xs:documentation>
115 The job has been archived by the server at destruction time. An archived job
116 may have deleted the results to reclaim resources, but must have job metadata preserved.
117 This is an alternative that the server may choose in contrast to completely destroying all record of the job.
118 </xs:documentation>
119 </xs:annotation>
120 </xs:enumeration>
121 </xs:restriction>
122 </xs:simpleType>
123 <xs:complexType name="JobSummary">
124 <xs:annotation>
125 <xs:documentation>The complete representation of the state
126 of a job</xs:documentation>
127 </xs:annotation>
128 <xs:sequence>
129 <xs:element name="jobId" type="uws:JobIdentifier" />
130 <xs:element name="runId" type="xs:string" maxOccurs="1"
131 minOccurs="0"
132 >
133 <xs:annotation>
134 <xs:documentation> this is a client supplied identifier -
135 the UWS system does nothing other than to return it as
136 part of the description of the job</xs:documentation>
137 </xs:annotation>
138 </xs:element>
139 <xs:element name="ownerId" type="xs:string"
140 nillable="true"
141 >
142 <xs:annotation>
143 <xs:documentation>the owner (creator) of the job -
144 this should be expressed as a string that can be
145 parsed in accordance with IVOA security standards. If
146 there was no authenticated job creator then this
147 should be set to NULL.</xs:documentation>
148 </xs:annotation>
149 </xs:element>
150 <xs:element name="phase" type="uws:ExecutionPhase">
151 <xs:annotation>
152 <xs:documentation> the execution phase - returned at
153 /(jobs)/(jobid)/phase</xs:documentation>
154 </xs:annotation>
155 </xs:element>
156 <xs:element name="quote" type="xs:dateTime"
157 nillable="true" maxOccurs="1" minOccurs="0"
158 >
159 <xs:annotation>
160 <xs:documentation> A Quote predicts when the job is likely to complete - returned at /(jobs)/(jobid)/quote
161 "don't know" is encoded by setting to the XML null value xsi:nil="true"</xs:documentation>
162 </xs:annotation>
163 </xs:element>
164 <xs:element name="startTime" type="xs:dateTime"
165 nillable="true" >
166 <xs:annotation>
167 <xs:documentation>The instant at which the job started execution.</xs:documentation>
168 </xs:annotation></xs:element>
169 <xs:element name="endTime" type="xs:dateTime"
170 nillable="true" >
171 <xs:annotation>
172 <xs:documentation>The instant at which the job finished execution</xs:documentation>
173 </xs:annotation></xs:element>
174 <xs:element name="executionDuration" type="xs:int"
175 nillable="false"
176 >
177 <!-- TODO look if xs:duration here has any benefits -->
178 <xs:annotation>
179 <xs:documentation> The duration (in seconds) for which
180 the job should be allowed to run - a value of 0 is
181 intended to mean unlimited - returned at
182 /(jobs)/(jobid)/executionduration</xs:documentation>
183 </xs:annotation>
184 </xs:element>
185 <xs:element name="destruction" type="xs:dateTime"
186 nillable="true"
187 >
188 <xs:annotation>
189 <xs:documentation> The time at which the whole job +
190 records + results will be destroyed. returned at
191 /(jobs)/(jobid)/destruction</xs:documentation>
192 </xs:annotation>
193 </xs:element>
194 <xs:element ref="uws:parameters" maxOccurs="1"
195 minOccurs="0"
196 >
197 <xs:annotation>
198 <xs:documentation>The parameters to the job (where appropriate)
199 can also be retrieved at /(jobs)/(jobid)/parameters</xs:documentation>
200 </xs:annotation>
201 </xs:element>
202 <xs:element ref="uws:results">
203 <xs:annotation>
204 <xs:documentation>The results for the job - can also be retrieved at /(jobs)/(jobid)/results</xs:documentation>
205 </xs:annotation></xs:element>
206 <xs:element name="errorSummary" type="uws:ErrorSummary"
207 maxOccurs="1" minOccurs="0"
208 >
209 </xs:element>
210 <xs:element name="jobInfo" maxOccurs="1" minOccurs="0">
211 <xs:annotation>
212 <xs:documentation> This is arbitrary information that can
213 be added to the job description by the UWS
214 implementation.</xs:documentation>
215 </xs:annotation>
216 <xs:complexType>
217 <xs:sequence>
218 <xs:any namespace="##any" processContents="lax"
219 minOccurs="0" maxOccurs="unbounded" />
220 </xs:sequence>
221 </xs:complexType>
222 </xs:element>
223 </xs:sequence>
224 </xs:complexType>
225 <xs:simpleType name="JobIdentifier">
226 <xs:annotation>
227 <xs:documentation> The identifier for the job
228 </xs:documentation>
229 </xs:annotation>
230 <xs:restriction base="xs:string" />
231 </xs:simpleType>
232 <xs:element name="job" type="uws:JobSummary">
233 <xs:annotation>
234 <xs:documentation> This is the information that is returned
235 when a GET is made for a single job resource - i.e.
236 /(jobs)/(jobid)</xs:documentation>
237 </xs:annotation>
238 </xs:element>
239 <xs:element name="jobs">
240 <xs:annotation>
241 <xs:documentation> The list of job references returned at
242 /(jobs)</xs:documentation>
243 </xs:annotation>
244 <xs:complexType>
245 <xs:annotation>
246 <xs:documentation> ISSUE - do we want to have any sort of
247 paging or selection mechanism in case the job list gets
248 very large? Or is that an unnecessary complication...
249 </xs:documentation>
250 </xs:annotation>
251 <xs:sequence>
252 <xs:element name="jobref" type="uws:ShortJobDescription"
253 maxOccurs="unbounded" minOccurs="0"
254 ></xs:element>
255 </xs:sequence>
256 </xs:complexType>
257 </xs:element>
258 <xs:complexType name="ResultReference" mixed="false">
259 <xs:annotation>
260 <xs:documentation> A reference to a UWS result. If the
261 </xs:documentation>
262 </xs:annotation>
263 <xs:attribute name="id" type="xs:string" use="required"></xs:attribute>
264 <xs:attributeGroup ref="uws:reference"></xs:attributeGroup>
265 <xs:attribute name="size" type="xs:long" use="required" ></xs:attribute>
266 <xs:attribute name="mime-type" type="xs:string" use="required"></xs:attribute>
267 <xs:anyAttribute namespace="urn:uwscustom" processContents="lax" />
268 </xs:complexType>
269 <xs:element name="results">
270 <xs:annotation>
271 <xs:documentation> The element returned for
272 /(jobs)/(jobid)/results</xs:documentation>
273 </xs:annotation>
274 <xs:complexType>
275 <xs:sequence>
276 <xs:element name="result" type="uws:ResultReference"
277 maxOccurs="unbounded" minOccurs="0"
278 ></xs:element>
279 </xs:sequence>
280 </xs:complexType>
281 </xs:element>
282 <xs:complexType name="ErrorSummary">
283 <xs:annotation>
284 <xs:documentation>
285 A short summary of an error - a fuller representation of the
286 error may be retrieved from /(jobs)/(jobid)/error
287 </xs:documentation>
288 </xs:annotation>
289 <xs:sequence>
290 <xs:element name="message" type="xs:string"></xs:element>
291 </xs:sequence>
292 <xs:attribute name="type" type="uws:ErrorType" use="required">
293 <xs:annotation>
294 <xs:documentation>
295 characterization of the type of the error
296 </xs:documentation>
297 </xs:annotation>
298 </xs:attribute>
299 <xs:attribute name="hasDetail" type="xs:boolean" use="required">
300 <xs:annotation>
301 <xs:documentation>if true then there is a more detailed error message available at /(jobs)/(jobid)/error</xs:documentation>
302 </xs:annotation></xs:attribute>
303 </xs:complexType>
304 <xs:simpleType name="ErrorType">
305 <xs:restriction base="xs:string">
306 <xs:enumeration value="transient"></xs:enumeration>
307 <xs:enumeration value="fatal"></xs:enumeration>
308 </xs:restriction>
309 </xs:simpleType>
310 <xs:complexType name="Parameter" mixed="true">
311 <xs:annotation>
312 <xs:documentation> the list of input parameters to the job - if
313 the job description language does not naturally have
314 parameters, then this list should contain one element which
315 is the content of the original POST that created the job.
316 </xs:documentation>
317 </xs:annotation>
318 <xs:attribute name="byReference" type="xs:boolean"
319 default="false"
320 >
321 <xs:annotation>
322 <xs:documentation> if this attribute is true then the
323 content of the parameter represents a URL to retrieve the
324 actual parameter value.</xs:documentation>
325 <xs:documentation> It is up to the implementation to decide
326 if a parameter value cannot be returned directly as the
327 content - the basic rule is that the representation of
328 the parameter must allow the whole job element to be
329 valid XML. If this cannot be achieved then the parameter
330 value must be returned by reference.</xs:documentation>
331 </xs:annotation>
332 </xs:attribute>
333 <xs:attribute name="id" type="xs:string" use="required">
334 <xs:annotation>
335 <xs:documentation> the identifier for the parameter
336 </xs:documentation>
337 </xs:annotation>
338 </xs:attribute>
339 <xs:attribute name="isPost" type="xs:boolean"></xs:attribute>
340 </xs:complexType>
341 <xs:element name="parameters">
342 <xs:complexType>
343 <xs:sequence>
344 <xs:element name="parameter" type="uws:Parameter"
345 maxOccurs="unbounded" minOccurs="0"
346 ></xs:element>
347 </xs:sequence>
348 </xs:complexType>
349 </xs:element>
350 </xs:schema>
351
352 <!-- -->

Properties

Name Value
svn:keywords LastChangedDate LastChangedRevision HeadURL Id
svn:mime-type text/plain

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26