Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
ALF/architecture/ALF Schemas/ALFEventBase 001.xsd
< ALF | architecture | ALF Schemas
ALFEventBase_001.xsd
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:evt="http://www.eclipse.org/alf/XMLSchema/Events.xsd" xmlns="http://www.eclipse.org/alf/XMLSchema/Events.xsd" targetNamespace="http://www.eclipse.org/alf/XMLSchema/Events.xsd" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:annotation> <xs:documentation> WARNING: PRELIMINARY VERSION </xs:documentation> </xs:annotation> <xs:annotation> <xs:documentation> Copyright Notice The material in this document is Copyright (c) Serena Software, Inc. and others, 2005 Terms and Conditions: The Eclipse Foundation makes available all content in this document ("Content"). Unless otherwise indicated below, the Content is provided to you under the terms and conditions of the Eclipse Public License Version 1.0 ("EPL"). A copy of the EPL is available at http://www.eclipse.org/legal/epl-v10.html. For purposes of the EPL, "Program" will mean the Content. If you did not receive this Content directly from the Eclipse Foundation, the Content is being redistributed by another party ("Redistributor") and different terms and conditions may apply to your use of any object code in the Content. Check the Redistributor's license that was provided with the Content. If you did not receive any such license, contact the Redistributor. Unless otherwise indicated below, the terms and conditions of the EPL still apply to the Content. </xs:documentation> </xs:annotation> <!-- Begin EventBaseTypes --> <xs:complexType name="EventBaseType"> <xs:annotation> <xs:documentation> EventBaseType is a container for that portion of an ALF Event that is inspected by the ALF EventManager. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="EventID" type="EventIDType"/> <xs:element name="Timestamp" type="TimestampType"/> <xs:element name="EventType" type="EventTypeType"/> <xs:element name="Object" type="ObjectDataType"/> <xs:element name="Source" type="SourceType"/> <xs:element name="PredecedingEvent" type="EventIDType" nillable="true"/> <xs:element name="ApplicationName" type="ApplicationNameType" nillable="true"/> <xs:element name="Environment" type="EnvironmentType" nillable="true"/> <xs:element name="User" type="UserType"/> </xs:sequence> <xs:attribute name="alfEventVersion" type="xs:string" use="required"/> </xs:complexType> <xs:simpleType name="EventIDType"> <xs:annotation> <xs:documentation> A UUID that uniquely identifies the Event instance. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"> <xs:maxLength value="36"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="TimestampType"> <xs:annotation> <xs:documentation> The date and timestamp when the EventManager received the Event. This element may be left empty by the event emitter, in which case, the Event Manager will supply a value. </xs:documentation> </xs:annotation> <xs:restriction base="xs:dateTime"/> </xs:simpleType> <xs:simpleType name="EventTypeType"> <xs:annotation> <xs:documentation> A string indicating the type of event. EventType designates the verb. That is what action happened to the Objects that triggered the event. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <!-- ============= Array of Objects that triggered the event ============= --> <xs:complexType name="ObjectDataType"> <xs:annotation> <xs:documentation> A container for the identification of the objects that the tool was operating on. The purpose of the Object element is to identify the entity that was being operated on and which caused the event. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="ObjectType" type="ObjectTypeType"/> <xs:element name="ObjectId" type="ObjectIdType"/> </xs:sequence> </xs:complexType> <xs:simpleType name="ObjectIdType"> <xs:annotation> <xs:documentation> An ObjectId identifies the entity or relationship that changed within a tool. The identifier must be unique for a particular instance of the source tool. The format of this element will not be standardized by ALF. The primary purpose is to allow subsequent ServiceFlows to uniquely identify (and perhaps access) the object that triggered the event. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <xs:simpleType name="ObjectTypeType"> <xs:annotation> <xs:documentation> The type of entity involved. Note that the word entity is taken in its broadest sense, referring to whatever artifact a tool was operating on. For example, for a data modeling tool, an E-R relationship is a type of entity (i.e., and ObjectType) to ALF. The following are Object types enumerated by ALF: Business Activity Business Entity Business Process Individual Organization Oganizational Unit Role Use Case Business Location Entity Relationship System Model Source code Database Table Column File Folder Application Host Network Protocol Build Test Test Plan Test Result Workflow Item Requirement Request Issue Version Configuration Baseline Project Package Business Realm Logical Realm Physical Design Realm System Implementation Realm System Operations Realm Cross-Realm Infrastructure </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <!-- ============= The source (i.e, tool or product) that emitted the event ============= --> <xs:complexType name="SourceType"> <xs:annotation> <xs:documentation> A Source element is a container type that describes the source of the event. ProductCallbackURI is optional for tools that don't provide a listener to accept the callback from a tool or serviceflow at a later time. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="Product" type="ProductType"/> <xs:element name="ProductVersion" type="ProductVersionType"/> <xs:element name="ProductInstance" type="ProductInstanceType"/> <xs:element name="ProductCallbackURI" type="ProductCallbackURIType" nillable="true" minOccurs="0"/> </xs:sequence> </xs:complexType> <xs:simpleType name="ProductType"> <xs:annotation> <xs:documentation> A descriptive name for the tool (i.e., program) that emitted the Event. Note that this is a datatype for a Product element. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <xs:simpleType name="ProductCallbackURIType"> <xs:annotation> <xs:documentation> The web service endpoint for tools that support callbacks from ServiceFlows for additional information. The element content is optional for transient tools that may not be running at a later time, and so cannot accept a callback. Constantly running (server) tools that support callbacks should supply a URI. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <xs:simpleType name="ProductInstanceType"> <xs:annotation> <xs:documentation> A unique string identifying the instance of the tool. This is useful when there may be multiple instances of a product working within an instance of ALF. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <xs:simpleType name="ProductVersionType"> <xs:annotation> <xs:documentation> The release version of the product, such as 5.06 </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <!-- ====== The user (or userid) providing the context when the event occurred ======= --> <xs:complexType name="UserType"> <xs:annotation> <xs:documentation> A container for elements that identify the end user and his/her credentials. Note on possible future change: As the ALF Security work is progressing, we may eliminate the Credentials element here and move it to the SOAP Header. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="CommonName" type="CommonNameType" nillable="true"/> <xs:element name="LoginID" type="LoginIDType"/> <xs:element name="Credentials" type="CredentialsType" nillable="true"/> </xs:sequence> </xs:complexType> <xs:simpleType name="CommonNameType"> <xs:annotation> <xs:documentation> The first name and surname name of the user. The exact format may vary from locale to locale. If the emitting tool does not know this information, the element is optional. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <xs:simpleType name="LoginIDType"> <xs:annotation> <xs:documentation> The ID of the user when they authenticated to the tool that emitted the event. For tools running under the control of a ServiceFlow, the LoginID will be the user id presented by the ServiceFlow. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <xs:complexType name="CredentialsType"> <xs:annotation> <xs:documentation> A Credentials element contains the security credentials that may be passed among tools that operate as part of a ServiceFlow. ALF SSO leverages WS-Security which passes credential information as part ot hte SOAP header. When ALF SSO is use this Credential element should be unecessary and will be nilled When ALF SSO is not being used or there are mixed security methods, the credential field may be used to pass a security credential through the event to the service flow. If present this element may be encrypted. </xs:documentation> </xs:annotation> <xs:sequence> <xs:any/> </xs:sequence> </xs:complexType> <xs:simpleType name="ApplicationNameType"> <xs:annotation> <xs:documentation> The name of the ALF application to which this event belongs. Depending on the emitting tool, events may or may not be associated with an ALF application. If the emitting tool has the information available then it can provide the ALF ApplicationName as an additional information to distinguish the event. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <xs:simpleType name="EnvironmentType"> <xs:annotation> <xs:documentation> The name of the environment in which this event is bing raised. This element will be set by the ALF Event manager from its installation configuration. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"/> </xs:simpleType> <xs:complexType name="EventDetailType"> <xs:annotation> <xs:documentation> This element conveys the detailed information about the object that triggered the event, for example about a file that was checked into a configuration management tool. For the purposes of the EventBase, this element will be of type xs:any. The structure of this portion of the message will be specified by XML Schemas developed by the ALF Vocabulary Committees. This area will be passed through by the EventManager, and will not be examined by the Event Manager. </xs:documentation> </xs:annotation> <xs:sequence> <xs:any/> </xs:sequence> <xs:attribute name="schemaLocation" type="xs:anyURI" use="required"/> </xs:complexType> <xs:complexType name="EventExtensionType"> <xs:annotation> <xs:documentation> This element conveys the detailed information that is tool-specific and goes beyond the information defined by the ALF Vocabularies. For the purposes of the EventBase, this element will be of type xs:any. The concrete structure of this portion of the message will be defined by concrete schemas that include XML Schemas defining the tool-specific structure. This area will be passed through by the EventManager, and will not be examined by the Event Manager. </xs:documentation> </xs:annotation> <xs:sequence> <xs:any/> </xs:sequence> <xs:attribute name="schemaLocation" type="xs:anyURI" use="required"/> </xs:complexType> <!-- End EventBaseTypes --> <!-- BEGIN ALFEvent --> <xs:complexType name="ALFEventType"> <xs:sequence> <xs:element name="Base" type="EventBaseType"/> <xs:element name="Detail" type="EventDetailType"/> <xs:element name="Extension" type="EventExtensionType"/> </xs:sequence> <xs:attribute name="version" type="xs:string" use="required"/> </xs:complexType> <xs:complexType name="ALFEventResponseType"> <xs:sequence> <xs:element name="Base" type="EventBaseType"/> </xs:sequence> </xs:complexType> <xs:complexType name="ALFEventWithReplyResponseType"> <xs:sequence> <xs:element name="Base" type="EventBaseType"/> <xs:any/> </xs:sequence> </xs:complexType> <!-- END ALFEvent --> <!-- Event Notice --> <xs:element name="EventNotice" type="ALFEventType"/> <xs:element name="EventNoticeResponse" type="ALFEventResponseType"/> <xs:element name="EventNoticeWithReply" type="ALFEventType"/> <xs:element name="EventNoticeWithReplyResponse" type="ALFEventWithReplyResponseType"/> </xs:schema>