Subversion Repositories XServices

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
203 brianR 1
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://www.eclipse.org/alf/schema/EventBase/1"
2
           attributeFormDefault="unqualified" elementFormDefault="qualified"
3
           targetNamespace="http://www.eclipse.org/alf/schema/EventBase/1">
4
    <xs:annotation>
5
        <xs:documentation>
6
            Copyright Notice The material in this document is Copyright
7
            (c) Serena Software, Inc. and others, 2005, 2006, 2007 Terms and
8
            Conditions: The Eclipse Foundation makes available all
9
            content in this document ("Content"). Unless otherwise
10
            indicated below, the Content is provided to you under the
11
            terms and conditions of the Eclipse Public License Version
12
            1.0 ("EPL"). A copy of the EPL is available at
13
            http://www.eclipse.org/legal/epl-v10.html. For purposes of
14
            the EPL, "Program" will mean the Content. If you did not
15
            receive this Content directly from the Eclipse Foundation,
16
            the Content is being redistributed by another party
17
            ("Redistributor") and different terms and conditions may
18
            apply to your use of any object code in the Content. Check
19
            the Redistributor's license that was provided with the
20
            Content. If you did not receive any such license, contact
21
            the Redistributor. Unless otherwise indicated below, the
22
            terms and conditions of the EPL still apply to the Content.
23
        </xs:documentation>
24
    </xs:annotation>
25
    <xs:complexType name="EventBaseType">
26
        <xs:annotation>
27
            <xs:documentation>
28
                EventBaseType is a container for that portion of an ALF
29
                Event that is generally set by the Tool that raises the
30
                event.
31
            </xs:documentation>
32
        </xs:annotation>
33
        <xs:sequence>
34
            <xs:element name="EventId" type="SourceEventIdType"/>
35
            <xs:element name="Timestamp" nillable="true" type="TimestampType"/>
36
            <xs:element name="EventType" type="EventTypeType"/>
37
            <xs:element name="ObjectType" type="ObjectTypeType"/>
38
            <xs:element name="ObjectId" type="ObjectIdType"/>
39
            <xs:element name="Source" type="SourceType"/>
40
            <xs:element name="User" type="CredentialsType"/>
41
            <xs:element minOccurs="0" name="EventControl" type="EmBaseType"/>
42
            <xs:element minOccurs="0" name="BaseExtension" type="BaseExtensionType"/>
43
        </xs:sequence>
44
        <xs:anyAttribute/>
45
    </xs:complexType>
46
    <xs:complexType name="EmBaseType">
47
        <xs:annotation>
48
            <xs:documentation>
49
                EventControlType is a container for that portion of an
50
                ALF Event that is generally set by the ALF EventManager.
51
                In some cases, ALF compliant tools may set some fields,
52
                in particular when the event is a result of an ALF
53
                service call to that tool from a ServiceFlow.
54
            </xs:documentation>
55
        </xs:annotation>
56
        <xs:sequence>
57
            <xs:element name="EmEventId" type="EventIdType"/>
58
            <xs:element name="EmTimestamp" type="TimestampType"/>
59
            <xs:element name="PrecedingEmEventId" type="EventIdType"/>
60
            <xs:element name="ApplicationName" type="ApplicationNameType"/>
61
            <xs:element name="EventMatchName" type="EventMatchNameType"/>
62
            <xs:element name="ServiceFlowName" type="ServiceFlowNameType"/>
63
            <xs:element name="ServiceFlowId" type="ServiceFlowIdType"/>
64
            <xs:element name="Callback" type="xs:boolean"/>
65
            <xs:element name="Environment" type="EnvironmentType"/>
66
            <xs:element name="EmUser" type="CredentialsType"/>
67
            <xs:element minOccurs="0" name="AttemptCount" type="xs:int"/>
68
            <xs:element minOccurs="0" name="EmExtension" type="EmExtensionType"/>
69
        </xs:sequence>
70
        <xs:anyAttribute/>
71
    </xs:complexType>
72
    <xs:simpleType name="SourceEventIdType">
73
        <xs:annotation>
74
            <xs:documentation>
75
                A id that uniquely identifies the Event instance at the source.
76
            </xs:documentation>
77
        </xs:annotation>
78
        <xs:restriction base="xs:string">
79
            <xs:maxLength value="36"/>
80
        </xs:restriction>
81
    </xs:simpleType>
82
    <xs:simpleType name="EventIdType">
83
        <xs:annotation>
84
            <xs:documentation>
85
                A UUID that uniquely identifies the Event instance.
86
            </xs:documentation>
87
        </xs:annotation>
88
        <xs:restriction base="xs:string">
89
            <xs:maxLength value="36"/>
90
        </xs:restriction>
91
    </xs:simpleType>
92
    <xs:simpleType name="ServiceFlowIdType">
93
        <xs:annotation>
94
            <xs:documentation>
95
                A UUID that uniquely identifies the ServiceFlow
96
                instance.
97
            </xs:documentation>
98
        </xs:annotation>
99
        <xs:restriction base="xs:string">
100
            <xs:maxLength value="36"/>
101
        </xs:restriction>
102
    </xs:simpleType>
103
    <xs:simpleType name="TimestampType">
104
        <xs:annotation>
105
            <xs:documentation>
106
                The date and timestamp when the EventManager received
107
                the Event. This element may be left empty by the event
108
                emitter, in which case, the Event Manager will supply a
109
                value.
110
            </xs:documentation>
111
        </xs:annotation>
112
        <xs:restriction base="xs:dateTime"/>
113
    </xs:simpleType>
114
    <xs:simpleType name="EventTypeType">
115
        <xs:annotation>
116
            <xs:documentation>
117
                A string indicating the type of event. EventType
118
                designates the verb. That is what action happened to the
119
                Objects that triggered the event.
120
            </xs:documentation>
121
        </xs:annotation>
122
        <xs:restriction base="xs:string"/>
123
    </xs:simpleType>
124
    <xs:simpleType name="ObjectIdType">
125
        <xs:annotation>
126
            <xs:documentation>
127
                An ObjectId identifies the entity or relationship that
128
                changed within a tool. The identifier must be unique for
129
                a particular instance of the source tool. The format of
130
                this element will not be standardized by ALF. The
131
                primary purpose is to allow subsequent ServiceFlows to
132
                uniquely identify (and perhaps access) the object that
133
                triggered the event.
134
            </xs:documentation>
135
        </xs:annotation>
136
        <xs:restriction base="xs:string"/>
137
    </xs:simpleType>
138
    <xs:simpleType name="ObjectTypeType">
139
        <xs:annotation>
140
            <xs:documentation>
141
                The type of entity involved. Note that the word entity
142
                is taken in its broadest sense, referring to whatever
143
                artifact a tool was operating on. For example, for a
144
                data modeling tool, an E-R relationship is a type of
145
                entity (i.e., and ObjectType) to ALF.
146
            </xs:documentation>
147
        </xs:annotation>
148
        <xs:restriction base="xs:string"/>
149
    </xs:simpleType>
150
    <xs:complexType name="SourceType">
151
        <xs:annotation>
152
            <xs:documentation>
153
                A Source element is a container type that describes the
154
                source of the event. ProductCallbackURI is optional for
155
                tools that don't provide a listener to accept the
156
                callback from a tool or serviceflow at a later time.
157
            </xs:documentation>
158
        </xs:annotation>
159
        <xs:sequence>
160
            <xs:element name="Product" type="ProductType"/>
161
            <xs:element name="ProductVersion" type="ProductVersionType"/>
162
            <xs:element name="ProductInstance" type="ProductInstanceType"/>
163
            <xs:element minOccurs="0" name="ProductCallbackURI" type="ProductCallbackURIType"/>
164
        </xs:sequence>
165
    </xs:complexType>
166
    <xs:simpleType name="ProductType">
167
        <xs:annotation>
168
            <xs:documentation>
169
                A descriptive name for the tool (i.e., program) that
170
                emitted the Event. Note that this is a datatype for a
171
                Product element.
172
            </xs:documentation>
173
        </xs:annotation>
174
        <xs:restriction base="xs:string"/>
175
    </xs:simpleType>
176
    <xs:simpleType name="ProductCallbackURIType">
177
        <xs:annotation>
178
            <xs:documentation>
179
                The web service endpoint for tools that support
180
                callbacks from ServiceFlows for additional information.
181
                The element content is optional for transient tools that
182
                may not be running at a later time, and so cannot accept
183
                a callback. Constantly running (server) tools that
184
                support callbacks should supply a URI.
185
            </xs:documentation>
186
        </xs:annotation>
187
        <xs:restriction base="xs:anyURI"/>
188
    </xs:simpleType>
189
    <xs:simpleType name="ProductInstanceType">
190
        <xs:annotation>
191
            <xs:documentation>
192
                A unique string identifying the instance of the tool.
193
                This is useful when there may be multiple instances of a
194
                product working within an instance of ALF.
195
            </xs:documentation>
196
        </xs:annotation>
197
        <xs:restriction base="xs:string"/>
198
    </xs:simpleType>
199
    <xs:simpleType name="ProductVersionType">
200
        <xs:annotation>
201
            <xs:documentation>
202
                The release version of the product, such as 5.06
203
            </xs:documentation>
204
        </xs:annotation>
205
        <xs:restriction base="xs:string"/>
206
    </xs:simpleType>
207
    <xs:complexType name="ALFSecurityType">
208
        <xs:sequence>
209
            <xs:element name="UsernameToken">
210
                <xs:complexType>
211
                    <xs:sequence>
212
                        <xs:element name="Username" type="xs:string"/>
213
                        <xs:element name="Password" type="xs:string"/>
214
                        <xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
215
                    </xs:sequence>
216
                    <xs:anyAttribute/>
217
                </xs:complexType>
218
            </xs:element>
219
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
220
        </xs:sequence>
221
    </xs:complexType>
222
    <xs:complexType name="CredentialsType">
223
        <xs:annotation>
224
            <xs:documentation>
225
                A structure to hold security
226
                authentication-relevant data. If present the
227
                data within may be encrypted.
228
            </xs:documentation>
229
        </xs:annotation>
230
        <xs:sequence>
231
            <xs:element minOccurs="0" name="ALFSecurity" type="ALFSecurityType"/>
232
            <xs:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="lax"/>
233
        </xs:sequence>
234
        <xs:anyAttribute/>
235
    </xs:complexType>
236
    <xs:simpleType name="ApplicationNameType">
237
        <xs:annotation>
238
            <xs:documentation>
239
                The name of the ALF application to which this event
240
                belongs. Depending on the emitting tool, events may or
241
                may not be associated with an ALF application. If the
242
                emitting tool has the information available then it can
243
                provide the ALF ApplicationName as an additional
244
                information to distinguish the event.
245
            </xs:documentation>
246
        </xs:annotation>
247
        <xs:restriction base="xs:string"/>
248
    </xs:simpleType>
249
    <xs:simpleType name="EventMatchNameType">
250
        <xs:annotation>
251
            <xs:documentation>
252
                The name of the event match within the ALF Application
253
                that matches this event. This fields is set by the Event
254
                Manager when it dispatches the event.
255
            </xs:documentation>
256
        </xs:annotation>
257
        <xs:restriction base="xs:string"/>
258
    </xs:simpleType>
259
    <xs:simpleType name="ServiceFlowNameType">
260
        <xs:annotation>
261
            <xs:documentation>
262
                The name of the service flow withing the event match
263
                that matches this event. This field is set by the Event
264
                Manager when it dispatches the event.
265
            </xs:documentation>
266
        </xs:annotation>
267
        <xs:restriction base="xs:string"/>
268
    </xs:simpleType>
269
    <xs:simpleType name="EnvironmentType">
270
        <xs:annotation>
271
            <xs:documentation>
272
                The name of the environment in which this event is being
273
                raised. This element will be set by the ALF Event
274
                manager from its installation configuration.
275
            </xs:documentation>
276
        </xs:annotation>
277
        <xs:restriction base="xs:string"/>
278
    </xs:simpleType>
279
    <xs:simpleType name="ALFSchemaVersionType">
280
        <xs:restriction base="xs:string">
281
            <xs:enumeration value="1.0"/>
282
        </xs:restriction>
283
    </xs:simpleType>
284
    <xs:complexType name="BaseExtensionType">
285
        <xs:annotation>
286
            <xs:documentation>
287
                Place holder type for future extensions of
288
                BaseExtensionType
289
            </xs:documentation>
290
        </xs:annotation>
291
        <xs:sequence>
292
            <xs:any maxOccurs="unbounded" namespace="##targetNamespace" processContents="lax"/>
293
        </xs:sequence>
294
        <xs:anyAttribute/>
295
    </xs:complexType>
296
    <xs:complexType name="EmExtensionType">
297
        <xs:annotation>
298
            <xs:documentation>
299
                Place holder type for future extensions of EmBaseType
300
            </xs:documentation>
301
        </xs:annotation>
302
        <xs:sequence>
303
            <xs:any maxOccurs="unbounded" namespace="##targetNamespace" processContents="lax"/>
304
        </xs:sequence>
305
        <xs:anyAttribute/>
306
    </xs:complexType>
307
    <xs:complexType name="DetailExtensionType">
308
        <xs:annotation>
309
            <xs:documentation>
310
                Place holder type for vocabulary based Event payload
311
                "details"
312
            </xs:documentation>
313
        </xs:annotation>
314
        <xs:sequence>
315
            <xs:any maxOccurs="unbounded" namespace="##other" processContents="lax"/>
316
        </xs:sequence>
317
        <xs:anyAttribute/>
318
    </xs:complexType>
319
    <xs:complexType name="CustomExtensionType">
320
        <xs:annotation>
321
            <xs:documentation>
322
                Place holder type for custom Event payload "extensions"
323
                ##other namespace is recommended but ##any is specified allowing more primitive sources
324
            </xs:documentation>
325
        </xs:annotation>
326
        <xs:sequence>
327
            <xs:any maxOccurs="unbounded" namespace="##any" processContents="lax"/>
328
        </xs:sequence>
329
        <xs:anyAttribute/>
330
    </xs:complexType>
331
    <xs:complexType name="ALFEventType">
332
        <xs:sequence>
333
            <xs:element name="Base" type="EventBaseType"/>
334
            <xs:element minOccurs="0" name="Detail" type="DetailExtensionType"/>
335
            <xs:element minOccurs="0" name="Extension" type="CustomExtensionType"/>
336
            <xs:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="lax"/>
337
        </xs:sequence>
338
        <xs:attribute default="1.0" name="version" type="ALFSchemaVersionType"/>
339
    </xs:complexType>
340
    <xs:complexType name="ALFEventResponseType">
341
        <xs:sequence>
342
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
343
        </xs:sequence>
344
    </xs:complexType>
345
    <xs:complexType name="ALFEventWithReplyResponseType">
346
        <xs:sequence>
347
            <xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
348
        </xs:sequence>
349
    </xs:complexType>
350
 
351
	<!-- Element declaration for creating documents -->
352
	<xs:element name="ALFEventNoticeDoc" type="ALFEventType"/>
353
 
354
</xs:schema>