bundles/org.simantics/schema/startup.exsd

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <!-- Schema file written by PDE -->
   3 <schema targetNamespace="org.simantics" xmlns="http://www.w3.org/2001/XMLSchema">
   4 <annotation>
   5       <appinfo>
   6          <meta.schema plugin="org.simantics" id="startup" name="Simantics Platform Startup"/>
   7       </appinfo>
   8       <documentation>
   9          This is an extension point for programmatical contribution of Simantics platform startup procedures. Startup extensions can be used to perform product-specific checks e.g. on the workspace in use before starting up the Simantics platform.
  10
  11 Startup extensions have no ordering, i.e. the system does not guarantee anything about the order in which they are executed. Therefore implementations must not rely on any particular order or execution.
  12
  13 Startup checks can be performed also headlessly (without UI) so these extensions should not depend on being able to access Workbench UI.
  14       </documentation>
  15    </annotation>
  16
  17    <element name="extension">
  18       <annotation>
  19          <appinfo>
  20             <meta.element />
  21          </appinfo>
  22       </annotation>
  23       <complexType>
  24          <sequence>
  25             <element ref="startup" minOccurs="0" maxOccurs="unbounded"/>
  26          </sequence>
  27          <attribute name="point" type="string" use="required">
  28             <annotation>
  29                <documentation>
  30
  31                </documentation>
  32             </annotation>
  33          </attribute>
  34          <attribute name="id" type="string">
  35             <annotation>
  36                <documentation>
  37
  38                </documentation>
  39             </annotation>
  40          </attribute>
  41          <attribute name="name" type="string">
  42             <annotation>
  43                <documentation>
  44
  45                </documentation>
  46                <appinfo>
  47                   <meta.attribute translatable="true"/>
  48                </appinfo>
  49             </annotation>
  50          </attribute>
  51       </complexType>
  52    </element>
  53
  54    <element name="startup">
  55       <annotation>
  56          <documentation>
  57             Defines an extension that will be invoked before doing anything else in SimanticsPlatform.startup.
  58
  59 Only after all Startup methods have been invoked the platform startup will commence by initializing database, starting the database server and synchronizing ontologies.
  60
  61 preStartup extension can prevent platform startup by throwing a PlatformException such as CancelStartupException in their implementation.
  62          </documentation>
  63       </annotation>
  64       <complexType>
  65          <attribute name="class" type="string" use="required">
  66             <annotation>
  67                <documentation>
  68
  69                </documentation>
  70                <appinfo>
  71                   <meta.attribute kind="java" basedOn=":org.simantics.startup.IStartup"/>
  72                </appinfo>
  73             </annotation>
  74          </attribute>
  75       </complexType>
  76    </element>
  77
  78    <annotation>
  79       <appinfo>
  80          <meta.section type="since"/>
  81       </appinfo>
  82       <documentation>
  83          Simantics 1.18.1
  84       </documentation>
  85    </annotation>
  86
  87    <annotation>
  88       <appinfo>
  89          <meta.section type="examples"/>
  90       </appinfo>
  91       <documentation>
  92          &lt;pre&gt;
  93    &lt;extension point=&quot;org.simantics.startup&quot;&gt;
  94       &lt;feature
  95             class=&quot;org.example.Startup&quot;
  96       &lt;/feature&gt;
  97    &lt;/extension&gt;
  98 &lt;/pre&gt;
  99       </documentation>
 100    </annotation>
 101
 102    <annotation>
 103       <appinfo>
 104          <meta.section type="apiinfo"/>
 105       </appinfo>
 106       <documentation>
 107          See the contents of the org.simantics.startup package.
 108       </documentation>
 109    </annotation>
 110
 111
 112    <annotation>
 113       <appinfo>
 114          <meta.section type="copyright"/>
 115       </appinfo>
 116       <documentation>
 117          Copyright (c) 2015 Association for Decentralized Information Management in Industry THTH ry.&lt;br/&gt;
 118 All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at &lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
 119       </documentation>
 120    </annotation>
 121
 122 </schema>