platform-update-home/doc/eclipse_update_packaging.html
Parent Directory
| 
Revision Log
Revision 1.14 - (view) (download) (as text)
| 1 : | droberts | 1.6 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 : | vlad | 1.1 | <html> |
| 3 : | <head> | ||
| 4 : | celek | 1.14 | |
| 5 : | celek | 1.9 | <meta http-equiv="Content-Type" |
| 6 : | content="text/html; charset=iso-8859-1"> | ||
| 7 : | celek | 1.14 | |
| 8 : | celek | 1.7 | <meta name="Author" content="Lab User"> |
| 9 : | celek | 1.14 | |
| 10 : | celek | 1.7 | <meta name="GENERATOR" content="Microsoft FrontPage 4.0"> |
| 11 : | <title>Eclipse Platform: Installation and Update</title> | ||
| 12 : | celek | 1.14 | |
| 13 : | vlad | 1.1 | </head> |
| 14 : | celek | 1.7 | <body> |
| 15 : | celek | 1.14 | |
| 16 : | celek | 1.7 | <h1> Eclipse Platform<br> |
| 17 : | celek | 1.14 | Update Packaging Conventions</h1> |
| 18 : | <font size="-1">Revision Date: 01/15/2003 9:33AM - Version: 2.0.17</font><br> | ||
| 19 : | <a href="../../../../../hglegal.htm"><img src="ngibmcpy.gif" | ||
| 20 : | celek | 1.10 | border="0" height="12" width="195"> |
| 21 : | celek | 1.14 | </a> |
| 22 : | celek | 1.9 | <p><b>Change History:</b> </p> |
| 23 : | celek | 1.14 | |
| 24 : | celek | 1.7 | <ul> |
| 25 : | celek | 1.14 | <li><small>2.0.17</small></li> |
| 26 : | <ul> | ||
| 27 : | <li><small>added $os$,$ws$,$arch$ and $nl$ for copyright, description | ||
| 28 : | and license URL tag in feature.<br> | ||
| 29 : | </small></li> | ||
| 30 : | </ul> | ||
| 31 : | <li><small>2.0.16</small> <small><br> | ||
| 32 : | </small> | ||
| 33 : | celek | 1.11 | <ul> |
| 34 : | celek | 1.14 | <li><small>added <site><feature> os,arch,nl,ws support |
| 35 : | "*"</small></li> | ||
| 36 : | |||
| 37 : | celek | 1.11 | </ul> |
| 38 : | celek | 1.14 | </li> |
| 39 : | <li><small>2.0.15</small> | ||
| 40 : | celek | 1.12 | <ul> |
| 41 : | celek | 1.14 | <li><small>added <site><feature> os,arch,nl,ws,patch |
| 42 : | tag</small></li> | ||
| 43 : | |||
| 44 : | celek | 1.12 | </ul> |
| 45 : | celek | 1.14 | </li> |
| 46 : | <li><small>2.0.14<br> | ||
| 47 : | </small> | ||
| 48 : | celek | 1.10 | <ul> |
| 49 : | celek | 1.14 | <li><small>added <site><feature> label tag</small><br> |
| 50 : | </li> | ||
| 51 : | |||
| 52 : | </ul> | ||
| 53 : | celek | 1.13 | </li> |
| 54 : | celek | 1.14 | <li><small>2.0.13<br> |
| 55 : | </small> </li> | ||
| 56 : | |||
| 57 : | <ul> | ||
| 58 : | <li><small>added <includes name,optional,match,search_location</small> | ||
| 59 : | ></li> | ||
| 60 : | <li><small>added <import feature,patch></small></li> | ||
| 61 : | |||
| 62 : | </ul> | ||
| 63 : | <li><small>2.0.12<br> | ||
| 64 : | </small></li> | ||
| 65 : | |||
| 66 : | celek | 1.11 | <ul> |
| 67 : | celek | 1.14 | <li> <font size="-1">added reference to the <a |
| 68 : | celek | 1.13 | href="http://www.eclipse.org/legal/updatemanager.html"> Eclipse.org Update |
| 69 : | celek | 1.14 | Manager Agreement</a> </font></li> |
| 70 : | |||
| 71 : | celek | 1.7 | </ul> |
| 72 : | celek | 1.14 | <li> <font size="-1">2.0.11</font></li> |
| 73 : | |||
| 74 : | celek | 1.7 | <ul> |
| 75 : | celek | 1.14 | <li> <font size="-1"><feature> <license> is required</font></li> |
| 76 : | |||
| 77 : | celek | 1.7 | </ul> |
| 78 : | celek | 1.14 | <li> <font size="-1">2.0.10</font></li> |
| 79 : | |||
| 80 : | <ul> | ||
| 81 : | <li> <font size="-1"><feature colocation-affinity=""></font></li> | ||
| 82 : | |||
| 83 : | </ul> | ||
| 84 : | <li> <font size="-1">2.0.9</font></li> | ||
| 85 : | |||
| 86 : | <ul> | ||
| 87 : | <li> <font size="-1"><site> <feature> changes - additional | ||
| 88 : | markup to optionally expose feature identification information to speed | ||
| 89 : | up searches</font></li> | ||
| 90 : | <li> <font size="-1">removed obsolete text</font></li> | ||
| 91 : | <li> <font size="-1">web-triggered update not in 2.0</font></li> | ||
| 92 : | <li> <font size="-1">no assist in 2.0 for license/ "key file" | ||
| 93 : | handling (individual application/ plugin responsibility)</font></li> | ||
| 94 : | |||
| 95 : | </ul> | ||
| 96 : | <li> <font size="-1">2.0.8</font></li> | ||
| 97 : | |||
| 98 : | <ul> | ||
| 99 : | <li> <font size="-1"><feature> <includes></font></li> | ||
| 100 : | |||
| 101 : | </ul> | ||
| 102 : | <li> <font size="-1">2.0.7</font></li> | ||
| 103 : | |||
| 104 : | <ul> | ||
| 105 : | <li> <font size="-1">support explicit xml markup for primary features</font></li> | ||
| 106 : | |||
| 107 : | </ul> | ||
| 108 : | <li> <font size="-1">2.0.6</font></li> | ||
| 109 : | |||
| 110 : | <ul> | ||
| 111 : | <li> <font size="-1">install handler markup changes</font></li> | ||
| 112 : | |||
| 113 : | </ul> | ||
| 114 : | <li> <font size="-1">2.0.5</font></li> | ||
| 115 : | |||
| 116 : | <ul> | ||
| 117 : | <li> <font size="-1">updates to security section</font></li> | ||
| 118 : | |||
| 119 : | </ul> | ||
| 120 : | <li> <font size="-1">2.0.4</font></li> | ||
| 121 : | |||
| 122 : | <ul> | ||
| 123 : | <li> <font size="-1">general text cleanup</font></li> | ||
| 124 : | <li> <font size="-1"><feature><group> support removed | ||
| 125 : | (will not be in Eclipse 2.0)</font></li> | ||
| 126 : | <li> <font size="-1">arch= support added to <feature> and | ||
| 127 : | <feature><plugin></font></li> | ||
| 128 : | <li> <font size="-1">os=/ arch=/ ws=/ nl= added to <fetaure><data></font></li> | ||
| 129 : | <li> <font size="-1"><site url=""> new semantics</font></li> | ||
| 130 : | <li> <font size="-1">corrected errors in native installer link | ||
| 131 : | support</font></li> | ||
| 132 : | <li> <font size="-1">defined callback query strings for browser-triggered | ||
| 133 : | processing</font></li> | ||
| 134 : | |||
| 135 : | celek | 1.10 | </ul> |
| 136 : | celek | 1.14 | |
| 137 : | celek | 1.7 | </ul> |
| 138 : | celek | 1.14 | |
| 139 : | celek | 1.7 | <h3> <font size="+2">Table of Contents</font></h3> |
| 140 : | celek | 1.14 | <a href="#Introduction">Introduction</a> <br> |
| 141 : | <a | ||
| 142 : | href="#Changes_from_R1.0">Changes from 1.0</a> <br> | ||
| 143 : | <a href="#Concepts">Concepts</a> | ||
| 144 : | <br> | ||
| 145 : | <a href="#Framework">Framework</a> | ||
| 146 : | <br> | ||
| 147 : | <a href="#Packaging_Conventions">Packaging Conventions</a> <br> | ||
| 148 : | <a href="#Feature_Archive">Feature | ||
| 149 : | Archive</a> <br> | ||
| 150 : | <a href="#Plug-In_Archive">Plug-In | ||
| 151 : | Archive</a> <br> | ||
| 152 : | <a href="#Packaging_NL">Packaging | ||
| 153 : | NL</a> <br> | ||
| 154 : | <a | ||
| 155 : | celek | 1.13 | href="#Translated_Feature_Information"> Translated Feature Information</a> |
| 156 : | celek | 1.14 | <br> |
| 157 : | <a | ||
| 158 : | celek | 1.13 | href="#Translated_Plug-In_Information"> Translated Plug-In Information</a> |
| 159 : | celek | 1.14 | <br> |
| 160 : | <a | ||
| 161 : | celek | 1.13 | href="#Packaging_Target-Specific_Support"> Packaging Target-Specific Support</a> |
| 162 : | celek | 1.14 | <br> |
| 163 : | <a | ||
| 164 : | celek | 1.13 | href="#Packaging_Attribution_Information"> Packaging Attribution Information</a> |
| 165 : | celek | 1.14 | <br> |
| 166 : | <a | ||
| 167 : | celek | 1.13 | href="#Packaging_Attribution_Information"> Packaging Non-Plug-In Files</a> |
| 168 : | celek | 1.14 | <br> |
| 169 : | <a | ||
| 170 : | celek | 1.13 | href="#Packaging_Attribution_Information"> Custom Install Handling</a> |
| 171 : | <br> | ||
| 172 : | celek | 1.14 | <a |
| 173 : | celek | 1.11 | href="#Security_Considerations">Security Considerations</a> <br> |
| 174 : | celek | 1.14 | <a href="#Update_Server">Update Server</a> <br> |
| 175 : | <a href="#Site_Map">Site Map</a> | ||
| 176 : | <br> | ||
| 177 : | <a | ||
| 178 : | href="#Default_Site_Layout">Default Site Layout</a> <br> | ||
| 179 : | <a | ||
| 180 : | href="#Controlling_Access">Controlling Access</a> <br> | ||
| 181 : | <a href="#Eclipse_Install">Eclipse Install</a> <br> | ||
| 182 : | <a | ||
| 183 : | celek | 1.11 | href="#Default_Install_Layout">Default Install Layout</a> <br> |
| 184 : | celek | 1.14 | <a |
| 185 : | href="#Unmanaged_Plugins">"Unmanaged" Plug-Ins</a> <br> | ||
| 186 : | <a | ||
| 187 : | celek | 1.13 | href="#Using_Native_Platform_Installers"> Using Native Platform Installers</a> |
| 188 : | celek | 1.14 | |
| 189 : | celek | 1.9 | <h2> <a name="Introduction"></a> Introduction</h2> |
| 190 : | celek | 1.14 | This document outlines the support for managing the delivery of |
| 191 : | function within the Eclipse platform. Also refer to the "<a | ||
| 192 : | celek | 1.13 | href="http://www.eclipse.org/legal/updatemanager.html"> Eclipse.org Update |
| 193 : | celek | 1.14 | Manager Agreement</a> " for additional legal information governing the |
| 194 : | use of the Eclipse update manager function. | ||
| 195 : | celek | 1.9 | <h3> <a name="Changes_from_R1.0"></a> Changes from R1.0</h3> |
| 196 : | celek | 1.14 | This section describes the major design changes from the R1.0 Installation |
| 197 : | and Update support and supplies rationale for each design change. | ||
| 198 : | |||
| 199 : | celek | 1.7 | <ul> |
| 200 : | celek | 1.14 | <li> <b>extendable framework</b></li> |
| 201 : | <br> | ||
| 202 : | In R2.0 Eclipse defines an extendable framework for installation | ||
| 203 : | and update, allowing the support for alternate packaging and site management | ||
| 204 : | schemes. R2.0 supplies a default concrete implementation of this framework. | ||
| 205 : | <li> <b> feature support</b></li> | ||
| 206 : | <br> | ||
| 207 : | In R2.0 the concept of a <i>component</i> and <i>configuration</i> | ||
| 208 : | is merged into <i>feature</i>. Features define the packaging structure | ||
| 209 : | for a group of related plug-ins, plug-in fragments, and optionally non-plug-in | ||
| 210 : | files. Features are treated purely as an installation and packaging construct. | ||
| 211 : | They do not play a role during Eclipse plug-in execution. Features do not | ||
| 212 : | nest. They are simply an inclusive "manifest" of the plug-ins, fragments | ||
| 213 : | and other files that make up that feature. If features are logically made | ||
| 214 : | up of plug-ins from "sub-features", the top-level feature "manifest" must | ||
| 215 : | be fully resolved at packaging time. <li> <b>default feature archive format</b></li> | ||
| 216 : | <br> | ||
| 217 : | R1.0 components were packaged as a single Java .jar containing the | ||
| 218 : | component manifest as well as the actual plug-in files. The problem with | ||
| 219 : | this approach is lack of granularity at download time. In R2.0, the feature | ||
| 220 : | archive consists of multiple separate .jars - one .jar per plug-in and | ||
| 221 : | fragment, plus one .jar for the actual feature information. The Installation | ||
| 222 : | and Update support selectively downloads only those jars required for the | ||
| 223 : | installation. <li> <b>site map</b></li> | ||
| 224 : | <br> | ||
| 225 : | Default Eclipse update server must contain a <i>site map</i> file | ||
| 226 : | (site.xml). This is an evolution of the R1.0 install.index support. | ||
| 227 : | The rationale for using a structured site defined by the map rather than | ||
| 228 : | a "free form" web site, is the ability to present a consistent installation | ||
| 229 : | experience for the user. Also, this provides the necessary structure for | ||
| 230 : | discovery of available updates. Additional support for "free form" browsing | ||
| 231 : | may be considered in future work. <li> <b>using native install/ uninstall</b></li> | ||
| 232 : | <br> | ||
| 233 : | The primary mechanism for installing and updating Eclipse features | ||
| 234 : | is the built-in installation and update support. Some products may instead | ||
| 235 : | choose to use native installer technology (eg. MSI, RPM, etc) to deliver | ||
| 236 : | Eclipse features. However, native installers do not implement the required | ||
| 237 : | support for understanding the Eclipse installation structure. In particular, | ||
| 238 : | the native uninstallers will, by default, remove plug-in files that were | ||
| 239 : | installed using the native installer without regard to these plug-ins being | ||
| 240 : | needed by other features. As a result, features installed using native installers | ||
| 241 : | must be written into private product-specific installation location and | ||
| 242 : | not the shared Eclipse installation location. The shared Eclipse is made | ||
| 243 : | aware of the produce-specific location via an installed "link file". <li> | ||
| 244 : | <b>custom install handling</b></li> | ||
| 245 : | <br> | ||
| 246 : | In many cases the standard installation handling supplied by Eclipse | ||
| 247 : | is not be sufficient to handle various custom requirements. To accommodate | ||
| 248 : | this, R2.0 Eclipse supports custom install handlers packaged as part | ||
| 249 : | of the feature and executed during the feature installation. <li> <b>path | ||
| 250 : | naming conventions</b></li> | ||
| 251 : | <br> | ||
| 252 : | R1.0 mandated the use of the various identifiers and versions inside | ||
| 253 : | the packaged archives (eg. directory path names for plug-ins). This approach | ||
| 254 : | has proven to be ackward and error prone. In 2.0, the packaging requirements | ||
| 255 : | no longer mandate that path names of packaged files precisely reflect | ||
| 256 : | the contained identifiers and versions. The properly identified install | ||
| 257 : | subdirectories are created by the Eclipse support during the installation | ||
| 258 : | and update process based on the archive content (rather than explicit | ||
| 259 : | jar path structure set up at packaging time) | ||
| 260 : | celek | 1.7 | </ul> |
| 261 : | celek | 1.14 | |
| 262 : | celek | 1.9 | <h3> <a name="Concepts"></a> Concepts</h3> |
| 263 : | celek | 1.14 | <b>Plug-in</b> <br> |
| 264 : | Eclipse developers build plug-ins. Plug-ins are the base units of | ||
| 265 : | execution recognized by the Eclipse runtime environment. In general, | ||
| 266 : | plug-ins are not exposed to users that select function during installation | ||
| 267 : | or update. The reason is that plug-in boundaries are established by developers | ||
| 268 : | for development reasons (like function reuse) and present the wrong level | ||
| 269 : | of granularity in terms of what the user sees as the unit of function. | ||
| 270 : | |||
| 271 : | celek | 1.13 | <p>While plug-ins are being developed (ie. are frequently being changed), |
| 272 : | celek | 1.14 | their internal file structure will reflect what is convenient to the |
| 273 : | developer. This will generally depend on the particular development tool | ||
| 274 : | being used. Typically, however, the developer will likely setup the plug-in | ||
| 275 : | to execute from a directory tree containing exposed .class files, rather | ||
| 276 : | than executing from a .jar (requires an extra step to create the .jar | ||
| 277 : | and we all know developers hate extra steps). Also, at this stage the developer | ||
| 278 : | does not pay particular attention to plug-in versioning information, because | ||
| 279 : | the plug-in is continually changing. </p> | ||
| 280 : | |||
| 281 : | celek | 1.13 | <p>However, when the plug-in is ready to be packaged, it needs to be converted |
| 282 : | celek | 1.14 | to a form suitable for packaging and installation. Typically it means |
| 283 : | creation of the runtime .jar(s) and removing any development-time files | ||
| 284 : | (source, exposed .class files, etc). It also means updating the plugin.xml | ||
| 285 : | manifest with the formal plug-in version and reflecting the version in | ||
| 286 : | the plug-in directory name (see "Concurrent Plug-In Version Support" for | ||
| 287 : | details). </p> | ||
| 288 : | |||
| 289 : | celek | 1.7 | <p><b>Plug-in Fragment</b> <br> |
| 290 : | celek | 1.14 | Plug-in Fragments (or simply Fragments) allow independent packaging |
| 291 : | of certain aspects of the base plug-in. This includes (but may not be | ||
| 292 : | limited to) translated resources for the plug-in, OS-specific or windowing-system-specific | ||
| 293 : | code. At runtime, fragments are logically merged into the base plug-in. | ||
| 294 : | From a packaging point of view, the install and update support does not | ||
| 295 : | really differentiate between plug-ins and their related fragments. </p> | ||
| 296 : | |||
| 297 : | celek | 1.7 | <p><b>Feature</b> <br> |
| 298 : | celek | 1.14 | A feature is an installation packaging mechanism used to define |
| 299 : | a group of versioned plug-ins and/or plug-in fragments plus non-plug-in | ||
| 300 : | files that is used to deliver some user function. A feature can also include | ||
| 301 : | other features. Features are exposed to users as part of the packaging | ||
| 302 : | and installation process, because they represent a unit of function selection. | ||
| 303 : | Features also represent a unit of installation. Features carry a version | ||
| 304 : | identifier.</p> | ||
| 305 : | |||
| 306 : | celek | 1.13 | <p>Features are packaged as a feature archive, referencing the required plug-ins, |
| 307 : | celek | 1.14 | plug-in fragments and optional non-plug-in files. The feature archives |
| 308 : | are placed on an update server for download and installation by the Eclipse | ||
| 309 : | update manager, or they can be used as the input into a formal packaging | ||
| 310 : | process using one of the "traditional" installer technologies. The format | ||
| 311 : | of the feature archive is described later. </p> | ||
| 312 : | |||
| 313 : | celek | 1.9 | <h3> <a name="Framework"></a> Framework</h3> |
| 314 : | celek | 1.14 | The 2.0 installation and update support is provided as a framework |
| 315 : | that allows custom implementations to be supplied for its key elements. | ||
| 316 : | In particular, the following can be supplied: | ||
| 317 : | vlad | 1.1 | <ul> |
| 318 : | celek | 1.14 | <li> concrete implementations of feature (IFeature interface) that |
| 319 : | can be used to support alternate packaging schemes. New concrete feature | ||
| 320 : | types are registere via the "org.eclipse.update.featureTypes" extension | ||
| 321 : | point.</li> | ||
| 322 : | <li> concrete implementations of site (ISite interface) that can | ||
| 323 : | be used to support alternate site layout, or site behavior. New concrete | ||
| 324 : | site types are registered via the "org.eclipse.update.siteTypes" extension | ||
| 325 : | point.</li> | ||
| 326 : | <li> each feature can specify a custom install handler as part | ||
| 327 : | of its feature manifest. Install handlers (IInstallHandler interface) | ||
| 328 : | are dynamically invoked as part of the installation process to handle non-plugin | ||
| 329 : | data, plus perform other custom processing allowed by the framework.</li> | ||
| 330 : | |||
| 331 : | celek | 1.7 | </ul> |
| 332 : | celek | 1.14 | Eclipse provides default implementations of feature and site. These |
| 333 : | are described in the rest of this document. <br> | ||
| 334 : | | ||
| 335 : | celek | 1.7 | <table border="1" cols="1" width="100%"> |
| 336 : | celek | 1.14 | <tbody> |
| 337 : | <tr> | ||
| 338 : | <td><b>Note: <i>The reminder of this document describes the default | ||
| 339 : | concrete implementation of the framework delivered with Eclipse. It specifies | ||
| 340 : | the structure of the default feature implementation, as well as the default | ||
| 341 : | site implementation, plus the corresponding xml files (feature.xml and | ||
| 342 : | site.xml). Providers of alternate concrete implementations can extend | ||
| 343 : | parts or all of the default Eclipse implementation. This includes providing | ||
| 344 : | a mechanism for dynamic computation of the site map (site.xml)</i></b></td> | ||
| 345 : | </tr> | ||
| 346 : | |||
| 347 : | </tbody> | ||
| 348 : | vlad | 1.1 | </table> |
| 349 : | celek | 1.14 | |
| 350 : | celek | 1.9 | <h2> <a name="Packaging_Conventions"></a> Packaging Conventions</h2> |
| 351 : | celek | 1.14 | Default feature packages consist of several related files: |
| 352 : | |||
| 353 : | celek | 1.7 | <ul> |
| 354 : | celek | 1.14 | <li> exactly one jar containing the feature manifest and related |
| 355 : | files. This one is refered to as the "<b>feature archive</b>"</li> | ||
| 356 : | <li> zero or more jars containing the feature plug-ins. These | ||
| 357 : | are refered to as the "<b>plug-in archives</b>"</li> | ||
| 358 : | <li> zero or more non-plug-in files associated with the feature. | ||
| 359 : | They are used by feature custom install handlers and contain data not interpreted | ||
| 360 : | by Eclipse</li> | ||
| 361 : | |||
| 362 : | celek | 1.9 | </ul> |
| 363 : | celek | 1.14 | |
| 364 : | celek | 1.9 | <h3> <a name="Feature_Archive"></a> Feature Archive</h3> |
| 365 : | celek | 1.14 | The feature packaging information is placed into a separate Java |
| 366 : | .jar. Standard Java jar facilities are used for constructing feature | ||
| 367 : | archives. Feature archives reference separately packaged plug-in archives | ||
| 368 : | (see next section) and non-plug-in files. | ||
| 369 : | celek | 1.13 | <p>Features are identified using a structured identifier based on the provider |
| 370 : | celek | 1.14 | internet domain name. For example, organization eclipse.org may produce |
| 371 : | feature org.eclipse.javatooling. The character set used for feature identifiers | ||
| 372 : | is as specified for plug-in identifiers (see reference information describing | ||
| 373 : | the plug-in manifest). </p> | ||
| 374 : | |||
| 375 : | celek | 1.7 | <p>The recommended convention for naming the feature archives is <br> |
| 376 : | celek | 1.14 | <tt><id>_<version>.jar</tt> </p> |
| 377 : | |||
| 378 : | celek | 1.13 | <p>Where <tt><id></tt> is the feature identifier and <tt><version></tt> |
| 379 : | celek | 1.14 | is the full version identifier contained in the respective feature.xml. |
| 380 : | Note that this is a recommended convention that minimizes chance of collisions, | ||
| 381 : | but is not required by the Eclipse architecture. For example, the following | ||
| 382 : | are valid feature archive names </p> | ||
| 383 : | |||
| 384 : | celek | 1.7 | <p><tt>org.eclipse.javatooling_1.0.3.jar</tt> <br> |
| 385 : | celek | 1.14 | <tt>org.eclipse.pde_2.0.jar</tt> <br> |
| 386 : | <tt>my_feature.jar</tt> </p> | ||
| 387 : | |||
| 388 : | celek | 1.13 | <p>Internally, each feature archive is packaged relative to its feature directory |
| 389 : | celek | 1.14 | (but not including the directory path element). The archive has the following |
| 390 : | structure </p> | ||
| 391 : | |||
| 392 : | celek | 1.7 | <p><tt>feature.xml</tt> <br> |
| 393 : | celek | 1.14 | <tt>feature<_locale>.properties (see "Translated Feature Information")</tt> |
| 394 : | <br> | ||
| 395 : | <tt>other feature files and subdirectories (TBD)</tt> <br> | ||
| 396 : | <tt>META-INF/</tt> <br> | ||
| 397 : | <tt> Java jar manifest and security files</tt> | ||
| 398 : | </p> | ||
| 399 : | |||
| 400 : | celek | 1.7 | <p>The feature install.xml format is defined by the following dtd: </p> |
| 401 : | celek | 1.14 | |
| 402 : | celek | 1.7 | <p><tt><?xml encoding="ISO-8859-1"?></tt> </p> |
| 403 : | celek | 1.14 | |
| 404 : | celek | 1.13 | <p><tt><!ELEMENT feature (install-handler?, description?, copyright?, |
| 405 : | license?, url?, includes*, requires?, plugin*, data*)></tt> <br> | ||
| 406 : | celek | 1.14 | <tt><!ATTLIST feature</tt> <br> |
| 407 : | <tt> id | ||
| 408 : | CDATA #REQUIRED</tt> <br> | ||
| 409 : | <tt> version | ||
| 410 : | CDATA #REQUIRED</tt> <br> | ||
| 411 : | <tt> label | ||
| 412 : | CDATA #IMPLIED</tt> <br> | ||
| 413 : | <tt> provider-name CDATA #IMPLIED</tt> <br> | ||
| 414 : | <tt> image | ||
| 415 : | CDATA #IMPLIED</tt> <br> | ||
| 416 : | <tt> os | ||
| 417 : | CDATA #IMPLIED</tt> <br> | ||
| 418 : | <tt> arch | ||
| 419 : | CDATA #IMPLIED</tt> <br> | ||
| 420 : | <tt> ws | ||
| 421 : | CDATA #IMPLIED</tt> <br> | ||
| 422 : | <tt> nl | ||
| 423 : | CDATA #IMPLIED</tt> <br> | ||
| 424 : | <tt> colocation-affinity</tt> <br> | ||
| 425 : | <tt> | ||
| 426 : | CDATA #IMPLIED</tt> <br> | ||
| 427 : | <tt> primary | ||
| 428 : | (true | false) "false"</tt> <br> | ||
| 429 : | <tt> application CDATA #IMPLIED</tt> | ||
| 430 : | <br> | ||
| 431 : | <tt>></tt> </p> | ||
| 432 : | |||
| 433 : | celek | 1.7 | <p><tt><!ELEMENT install-handler EMPTY></tt> <br> |
| 434 : | celek | 1.14 | <tt><!ATTLIST install-handler</tt> <br> |
| 435 : | <tt> library | ||
| 436 : | CDATA #IMPLIED</tt> <br> | ||
| 437 : | <tt> handler | ||
| 438 : | CDATA #IMPLIED</tt> <br> | ||
| 439 : | <tt>></tt> </p> | ||
| 440 : | |||
| 441 : | celek | 1.7 | <p><tt><!ELEMENT description (#PCDATA)></tt> <br> |
| 442 : | celek | 1.14 | <tt><!ATTLIST description</tt> <br> |
| 443 : | <tt> url | ||
| 444 : | CDATA #IMPLIED</tt> <br> | ||
| 445 : | <tt>></tt> </p> | ||
| 446 : | |||
| 447 : | celek | 1.7 | <p><tt><!ELEMENT copyright (#PCDATA)></tt> <br> |
| 448 : | celek | 1.14 | <tt><!ATTLIST copyright</tt> <br> |
| 449 : | <tt> url | ||
| 450 : | CDATA #IMPLIED</tt> <br> | ||
| 451 : | <tt>></tt> </p> | ||
| 452 : | |||
| 453 : | celek | 1.7 | <p><tt><!ELEMENT license (#PCDATA)></tt> <br> |
| 454 : | celek | 1.14 | <tt><!ATTLIST license</tt> <br> |
| 455 : | <tt> url | ||
| 456 : | CDATA #IMPLIED</tt> <br> | ||
| 457 : | <tt>></tt> </p> | ||
| 458 : | |||
| 459 : | celek | 1.7 | <p><tt><!ELEMENT url (update?, discovery*)></tt> </p> |
| 460 : | celek | 1.14 | |
| 461 : | celek | 1.7 | <p><tt><!ELEMENT update EMPTY></tt> <br> |
| 462 : | celek | 1.14 | <tt><!ATTLIST update</tt> <br> |
| 463 : | <tt> url | ||
| 464 : | CDATA #REQUIRED</tt> <br> | ||
| 465 : | <tt> label | ||
| 466 : | CDATA #IMPLIED</tt> <br> | ||
| 467 : | <tt>></tt> </p> | ||
| 468 : | |||
| 469 : | celek | 1.7 | <p><tt><!ELEMENT discovery EMPTY></tt> <br> |
| 470 : | celek | 1.14 | <tt><!ATTLIST discovery</tt> <br> |
| 471 : | <tt> url | ||
| 472 : | CDATA #REQUIRED</tt> <br> | ||
| 473 : | <tt> label | ||
| 474 : | CDATA #IMPLIED</tt> <br> | ||
| 475 : | <tt>></tt> </p> | ||
| 476 : | |||
| 477 : | celek | 1.7 | <p><tt><!ELEMENT includes EMPTY></tt> <br> |
| 478 : | celek | 1.14 | <tt><!ATTLIST includes</tt> <br> |
| 479 : | <tt> id | ||
| 480 : | CDATA #REQUIRED</tt> <br> | ||
| 481 : | <tt> version | ||
| 482 : | CDATA #REQUIRED</tt> <br> | ||
| 483 : | <tt> name | ||
| 484 : | CDATA #IMPLIED</tt> <br> | ||
| 485 : | <tt> optional </tt><tt> | ||
| 486 : | (true | false) "false"</tt><tt> <br> | ||
| 487 : | </tt><tt> match | ||
| 488 : | (perfect | equivalent | compatible | greaterOrEqual) | ||
| 489 : | "compatible"</tt><tt> </tt><br> | ||
| 490 : | <tt> search_location </tt><tt>(</tt><font | ||
| 491 : | celek | 1.9 | color="#000000"><tt> root | self | both) "root"</tt></font><br> |
| 492 : | celek | 1.14 | <tt>></tt> </p> |
| 493 : | |||
| 494 : | celek | 1.7 | <p><tt><!ELEMENT requires (import+)></tt> </p> |
| 495 : | celek | 1.14 | |
| 496 : | celek | 1.7 | <p><tt><!ELEMENT import EMPTY></tt> <br> |
| 497 : | celek | 1.14 | <tt><!ATTLIST import</tt> <br> |
| 498 : | <tt> plugin | ||
| 499 : | CDATA #IMPLIED</tt><br> | ||
| 500 : | <tt> feature CDATA | ||
| 501 : | #IMPLIED</tt><br> | ||
| 502 : | <tt> version | ||
| 503 : | CDATA #IMPLIED</tt> <br> | ||
| 504 : | <tt> match | ||
| 505 : | (perfect | equivalent | compatible | greaterOrEqual) "compatible"</tt> <br> | ||
| 506 : | <tt> patch </tt><tt> | ||
| 507 : | (true | false) "false"</tt><tt> </tt><tt><br> | ||
| 508 : | ></tt><br> | ||
| 509 : | </p> | ||
| 510 : | |||
| 511 : | celek | 1.7 | <p><tt><!ELEMENT plugin EMPTY></tt> <br> |
| 512 : | celek | 1.14 | <tt><!ATTLIST plugin</tt> <br> |
| 513 : | <tt> id | ||
| 514 : | CDATA #REQUIRED</tt> <br> | ||
| 515 : | <tt> version | ||
| 516 : | CDATA #REQUIRED</tt> <br> | ||
| 517 : | <tt> fragment (true | ||
| 518 : | | false) "false"</tt> <br> | ||
| 519 : | <tt> os | ||
| 520 : | CDATA #IMPLIED</tt> <br> | ||
| 521 : | <tt> arch | ||
| 522 : | CDATA #IMPLIED</tt> <br> | ||
| 523 : | <tt> ws | ||
| 524 : | CDATA #IMPLIED</tt> <br> | ||
| 525 : | <tt> nl | ||
| 526 : | CDATA #IMPLIED</tt> <br> | ||
| 527 : | <tt> download-size CDATA #IMPLIED</tt> <br> | ||
| 528 : | <tt> install-size CDATA #IMPLIED</tt> <br> | ||
| 529 : | <tt>></tt> </p> | ||
| 530 : | |||
| 531 : | celek | 1.7 | <p><tt><!ELEMENT data EMPTY></tt> <br> |
| 532 : | celek | 1.14 | <tt><!ATTLIST data</tt> <br> |
| 533 : | <tt> id | ||
| 534 : | CDATA #REQUIRED</tt> <br> | ||
| 535 : | <tt> os | ||
| 536 : | CDATA #IMPLIED</tt> <br> | ||
| 537 : | <tt> arch | ||
| 538 : | CDATA #IMPLIED</tt> <br> | ||
| 539 : | <tt> ws | ||
| 540 : | CDATA #IMPLIED</tt> <br> | ||
| 541 : | <tt> nl | ||
| 542 : | CDATA #IMPLIED</tt> <br> | ||
| 543 : | <tt> download-size CDATA #IMPLIED</tt> <br> | ||
| 544 : | <tt> install-size CDATA #IMPLIED</tt> <br> | ||
| 545 : | <tt>></tt> </p> | ||
| 546 : | |||
| 547 : | celek | 1.7 | <p>The element and attribute definitions are as follows: </p> |
| 548 : | celek | 1.14 | |
| 549 : | celek | 1.7 | <ul> |
| 550 : | celek | 1.14 | <li> <feature> - defines the feature</li> |
| 551 : | |||
| 552 : | celek | 1.7 | <ul> |
| 553 : | celek | 1.14 | <li> id - required feature identifier (eg. com.xyz.myfeature)</li> |
| 554 : | <li> version - required component version (eg. 1.0.3)</li> | ||
| 555 : | <li> label - optional displayable label (name). Intended to be | ||
| 556 : | translated.</li> | ||
| 557 : | <li> provider-name - optional display label identifying the organization | ||
| 558 : | providing this component. Intended to be translated.</li> | ||
| 559 : | <li> image - optional image to use when displaying information | ||
| 560 : | about the feature. Specified relative to the feature.xml.</li> | ||
| 561 : | <li> os - optional operating system specification. A comma-separated | ||
| 562 : | list of os designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt> | ||
| 563 : | . Indicates this feature should only be installed on one of the specified | ||
| 564 : | os systems. If this attribute is not specified, the feature can be installed | ||
| 565 : | on all systems (portable implementation). This information is used as | ||
| 566 : | a hint by the installation and update support (user can force installation | ||
| 567 : | of feature regardless of this setting).</li> | ||
| 568 : | <li> arch - optional machine architecture specification. A comma-separated | ||
| 569 : | list of architecture designators defined by Eclipse (see Javadoc for | ||
| 570 : | <tt> org.eclipse.core.boot.BootLoader)</tt>. Indicates this feature | ||
| 571 : | should only be installed on one of the specified systems. If this attribute | ||
| 572 : | is not specified, the feature can be installed on all systems (portable | ||
| 573 : | implementation). This information is used as a hint by the installation | ||
| 574 : | and update support (user can force installation of feature regardless of | ||
| 575 : | this setting).</li> | ||
| 576 : | <li> ws - optional windowing system specification. A comma-separated | ||
| 577 : | list of ws designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt> | ||
| 578 : | . Indicates this feature should only be installed on one of the specified | ||
| 579 : | ws systems. If this attribute is not specified, the feature can be installed | ||
| 580 : | on all systems (portable implementation). This information is used as | ||
| 581 : | a hint by the installation and update support (user can force installation | ||
| 582 : | of feature regardless of this setting).</li> | ||
| 583 : | <li> nl - optional locale specification. A comma-separated list | ||
| 584 : | of locale designators defined by Java. Indicates this feature should | ||
| 585 : | only be installed on a system running with a compatible locale (using | ||
| 586 : | Java locale-matching rules). If this attribute is not specified, the feature | ||
| 587 : | can be installed on all systems (language-neutral implementation). This | ||
| 588 : | information is used as a hint by the installation and update support (user | ||
| 589 : | can force installation of feature regardless of this setting).</li> | ||
| 590 : | <li> colocation-affinity - optional reference to another feature | ||
| 591 : | identifier used to select the default installation location for this feature. | ||
| 592 : | When this feature is being installed as a new feature (no other versions | ||
| 593 : | of it are installed), an attempt is made to install this feature in the | ||
| 594 : | same installation location as the referenced feature.</li> | ||
| 595 : | <li> primary - optional indication specifying whether this feature | ||
| 596 : | can be used as a <a href="#Dominant_Feature">primary feature</a> . Default | ||
| 597 : | if <i>false</i> (not a primary feature).</li> | ||
| 598 : | <li> application - optional identifier of the Eclipse application | ||
| 599 : | that is to be used during startup when the declaring feature is the <a | ||
| 600 : | celek | 1.13 | href="#Dominant_Feature"> primary feature</a> . The application identifier |
| 601 : | celek | 1.14 | must represent a valid application registered in the <tt>org.eclipse.core.runtime.applications</tt> |
| 602 : | extension point. Default is <tt>org.eclipse.ui.workbench</tt>.</li> | ||
| 603 : | |||
| 604 : | </ul> | ||
| 605 : | <li> <install-handler></li> | ||
| 606 : | |||
| 607 : | <ul> | ||
| 608 : | <li> library - optional .jar library containing the install handler | ||
| 609 : | classes. If specified, the referenced .jar must be contained in the feature | ||
| 610 : | archive. It is specified as a path within the feature archive, relative | ||
| 611 : | to the feature.xml entry. If not specified, the feature archive itself | ||
| 612 : | is used to load the install handler classes. This attribute is only interpreted | ||
| 613 : | if <i>class</i> attribute is also specified</li> | ||
| 614 : | <li> handler - optional identifier of the install handler. The | ||
| 615 : | value is interpreted depending on the value of the <i>library</i> attribute. | ||
| 616 : | If <i> library</i> is specified, the value is interpreted as | ||
| 617 : | a fully qualified name of a class contained in the specified <i>library</i>. | ||
| 618 : | If <i>library</i> is not specified, the value is is interpreted | ||
| 619 : | as an extension identifier of an extension registered in the <i>org.eclipse.update.installHandlers</i> | ||
| 620 : | extension point. In either case, the resulting class must implement the | ||
| 621 : | <i> IInstallHandler</i> interface. The class is dynamically loaded | ||
| 622 : | and called at specific points during feature processing. The handler has | ||
| 623 : | visibility to the API classes from the update plug-in, and Eclipse plug-ins | ||
| 624 : | required by the update plugin.</li> | ||
| 625 : | |||
| 626 : | </ul> | ||
| 627 : | <li> <description> - brief component description as simple | ||
| 628 : | text. Intended to be translated.</li> | ||
| 629 : | |||
| 630 : | <ul> | ||
| 631 : | <li> url - optional URL for the full description as HTML. The URL | ||
| 632 : | can be specified as absolute of relative. If relative, it is assumed to | ||
| 633 : | be relative to (and packaged in) the feature archive. Note, that for NL | ||
| 634 : | handling the URL value should be separated to allow alternate URLs to be | ||
| 635 : | specified for each national language. URL support keywords $os$,$ws$,$arch$ | ||
| 636 : | and $nl$ that will be replaced by the appropriate operating system, windowing | ||
| 637 : | system, operating architecture or national language value.</li> | ||
| 638 : | |||
| 639 : | </ul> | ||
| 640 : | <li> <copyright> - feature copyright as simple text. Intended | ||
| 641 : | to be translated.</li> | ||
| 642 : | |||
| 643 : | <ul> | ||
| 644 : | <li> url - optional URL for the full description as HTML. The URL | ||
| 645 : | can be specified as absolute of relative. If relative, it is assumed to | ||
| 646 : | be relative to (and packaged in) the feature archive. Note, that for NL | ||
| 647 : | handling the URL value should be separated to allow alternate URLs to be | ||
| 648 : | specified for each national language. URL support keywords $os$,$ws$,$arch$ | ||
| 649 : | and $nl$ that will be replaced by the appropriate operating system, windowing | ||
| 650 : | system, operating architecture or national language value.</li> | ||
| 651 : | |||
| 652 : | </ul> | ||
| 653 : | <li> <license> - feature "click-through" license as simple | ||
| 654 : | text. Intended to be translated. It is displayed in a standard dialog | ||
| 655 : | with [Accept] [Reject] actions during the download/ installation process. | ||
| 656 : | Note, that click-through license must be specified for any feature that | ||
| 657 : | will be selected for installation or update using the Eclipse update manager. | ||
| 658 : | When using nested features, only the nesting parent (ie. the feature selected | ||
| 659 : | for installation or update) must have click-through license text defined. | ||
| 660 : | The license text is required even if the optional <i>url</i> attribute is | ||
| 661 : | specified.</li> | ||
| 662 : | |||
| 663 : | <ul> | ||
| 664 : | <li> url - optional URL for the full description as HTML. The URL | ||
| 665 : | can be specified as absolute of relative. If relative, it is assumed to | ||
| 666 : | be relative to (and packaged in) the feature archive. Note, that for NL | ||
| 667 : | handling the URL value should be separated to allow alternate URLs to be | ||
| 668 : | specified for each national language. Note, that the "content" of this URL | ||
| 669 : | is <b>not</b> what is presented as the click-through license during installation | ||
| 670 : | processing. The click-through license is the actual value of the <i><license></i> | ||
| 671 : | element (eg. <tt><license>click through text</license></tt>). URL | ||
| 672 : | support keywords $os$,$ws$,$arch$ and $nl$ that will be replaced by the appropriate | ||
| 673 : | operating system, windowing system, operating architecture or national language | ||
| 674 : | value.</li> | ||
| 675 : | |||
| 676 : | </ul> | ||
| 677 : | <li> <url> - optional URL specifying site(s) contain feature | ||
| 678 : | updates, or new features</li> | ||
| 679 : | |||
| 680 : | celek | 1.13 | <ul> |
| 681 : | celek | 1.14 | <li> <update> - URL to go to for updates to this feature</li> |
| 682 : | |||
| 683 : | celek | 1.7 | <ul> |
| 684 : | celek | 1.14 | <li> url - actual URL</li> |
| 685 : | <li> label - displayable label (name) for the referenced site</li> | ||
| 686 : | |||
| 687 : | celek | 1.7 | </ul> |
| 688 : | celek | 1.14 | <li> <discovery> - URL to go to for new features. In general, |
| 689 : | a provider can use this element to reference its own site(s), or site(s) | ||
| 690 : | of partners that offer complementary features. Eclipse uses this element | ||
| 691 : | simply as a way to distribute new site URLs to the clients</li> | ||
| 692 : | |||
| 693 : | celek | 1.7 | <ul> |
| 694 : | celek | 1.14 | <li> url - actual URL</li> |
| 695 : | <li> label - displayable label (name) for the referenced site</li> | ||
| 696 : | |||
| 697 : | celek | 1.11 | </ul> |
| 698 : | celek | 1.14 | |
| 699 : | celek | 1.7 | </ul> |
| 700 : | celek | 1.14 | <li> <includes> - optional reference to a nested feature |
| 701 : | that is considered to be part of this feature. Nested features must be | ||
| 702 : | located on the same update site as this feature</li> | ||
| 703 : | |||
| 704 : | <ul> | ||
| 705 : | <li> id - required nested feature identifier</li> | ||
| 706 : | <li> version - required nested feature version</li> | ||
| 707 : | <li> name- optional displayable label (name). Intended to be | ||
| 708 : | translated.</li> | ||
| 709 : | <li>optional - optional specification indicating if this included | ||
| 710 : | feature can be optionally installed. Default is "false"<br> | ||
| 711 : | </li> | ||
| 712 : | <li>match - optional rule that will be applied when resolving | ||
| 713 : | the feature reference. A <samp>perfect</samp> match (the default that | ||
| 714 : | matches the 2.0.1 behavior) requires that the feature has exactly the | ||
| 715 : | version specified by the version attribute. Other choices progressively | ||
| 716 : | relax the rule (<samp> equivalent</samp> allows only service part of the | ||
| 717 : | version to be more recent, <samp>compatible</samp> also allows minor | ||
| 718 : | part to be included in the consideration, while <samp>greaterOrEqual</samp> | ||
| 719 : | simply allows any version that is more recent or identical to the one specified).</li> | ||
| 720 : | <li>search_location - optional. Indicates whether the | ||
| 721 : | "New Updates" action should search the update location determined by | ||
| 722 : | the nesting root feature (<tt>root</tt>, is the default), or the location | ||
| 723 : | defined by the nested feature (<tt>self</tt>), or search both (<tt>both</tt>) | ||
| 724 : | in that order (root first, self if nothing is found).</li> | ||
| 725 : | |||
| 726 : | </ul> | ||
| 727 : | <li> <requires> - optional feature dependency information. | ||
| 728 : | Is expressed in terms of plug-in dependencies. If specified, is enforced | ||
| 729 : | by the installation and update support at the time of installation</li> | ||
| 730 : | |||
| 731 : | <ul> | ||
| 732 : | <li> <import> - dependency entry. Specification and processing | ||
| 733 : | is a subset of the <import> specification in plugin.xml</li> | ||
| 734 : | |||
| 735 : | celek | 1.7 | <ul> |
| 736 : | celek | 1.14 | <li> plugin - identifier of dependent plug-in.</li> |
| 737 : | <li> feature - identifier of dependent feature. If plugin | ||
| 738 : | and feature are specified, plugin takes precedence upon feature. Feature | ||
| 739 : | or plugin must be specified.</li> | ||
| 740 : | <li> version - optional plug-in/feature version specification</li> | ||
| 741 : | <li>patch - optional specification indicating if this feature | ||
| 742 : | is a patch of the dependant feature. Default is "false". If patch is | ||
| 743 : | true, version must be specified. If patch is true, only feature must be | ||
| 744 : | specified. If patch is true, and match is specified, it must be 'perfect'.<br> | ||
| 745 : | </li> | ||
| 746 : | <li> match - optional matching rule. Valid values and processing | ||
| 747 : | are as follows:</li> | ||
| 748 : | |||
| 749 : | |||
| 750 : | celek | 1.7 | <ul> |
| 751 : | celek | 1.14 | <li> if version attribute is not specified, the match attribute |
| 752 : | (if specified) is ignored.</li> | ||
| 753 : | <li>if version is specified, match defaults to compatible.<br> | ||
| 754 : | </li> | ||
| 755 : | <li>if patch is true, and match is not specified, match | ||
| 756 : | defaults to perfect.<br> | ||
| 757 : | </li> | ||
| 758 : | <li> <b><i>perfect</i></b> - dependent plug-in version must match | ||
| 759 : | exactly the specified version.</li> | ||
| 760 : | <li> <b><i>equivalent</i></b> - dependent plug-in version must | ||
| 761 : | be at least at the version specified, or at a higher service level (major | ||
| 762 : | and minor version levels must equal the specified version).</li> | ||
| 763 : | <li> <b><i>compatible</i></b> - dependent plug-in version must | ||
| 764 : | be at least at the version specified, or at a higher service level or minor | ||
| 765 : | level (major version level must equal the specified version).</li> | ||
| 766 : | <li> <b><i>greaterOrEqual</i></b> - dependent plug-in version | ||
| 767 : | must be at least at the version specified, or at a higher service, minor | ||
| 768 : | or major level.</li> | ||
| 769 : | |||
| 770 : | celek | 1.12 | </ul> |
| 771 : | celek | 1.14 | |
| 772 : | celek | 1.11 | </ul> |
| 773 : | celek | 1.14 | |
| 774 : | celek | 1.7 | </ul> |
| 775 : | celek | 1.14 | <li> <plugin> - identifies referenced plug-in</li> |
| 776 : | |||
| 777 : | celek | 1.7 | <ul> |
| 778 : | celek | 1.14 | <li> id - required plug-in identifier (from plugin.xml)</li> |
| 779 : | <li> version - required plug-in version (from plugin.xml)</li> | ||
| 780 : | <li> fragment - optional specification indicating if this entry | ||
| 781 : | is a plug-in fragment. Default is "false"</li> | ||
| 782 : | <li> os - optional operating system specification. A comma-separated | ||
| 783 : | list of os designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt> | ||
| 784 : | . Indicates this entry should only be installed on one of the specified | ||
| 785 : | os systems. If this attribute is not specified, the entry can be installed | ||
| 786 : | on all systems (portable implementation). This information is used as | ||
| 787 : | a hint by the installation and update support (user can force installation | ||
| 788 : | of entry regardless of this setting).</li> | ||
| 789 : | <li> arch - optional machine architecture specification. A comma-separated | ||
| 790 : | list of architecture designators defined by Eclipse (see Javadoc for | ||
| 791 : | <tt> org.eclipse.core.boot.BootLoader)</tt>. Indicates this feature | ||
| 792 : | should only be installed on one of the specified systems. If this attribute | ||
| 793 : | is not specified, the feature can be installed on all systems (portable | ||
| 794 : | implementation). This information is used as a hint by the installation | ||
| 795 : | and update support (user can force installation of feature regardless of | ||
| 796 : | this setting).</li> | ||
| 797 : | <li> ws - optional windowing system specification. A comma-separated | ||
| 798 : | list of ws designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt> | ||
| 799 : | . Indicates this entry should only be installed on one of the specified | ||
| 800 : | ws systems. If this attribute is not specified, the entry can be installed | ||
| 801 : | on all systems (portable implementation). This information is used as | ||
| 802 : | a hint by the installation and update support (user can force installation | ||
| 803 : | of entry regardless of this setting).</li> | ||
| 804 : | <li> nl - optional locale specification. A comma-separated list | ||
| 805 : | of locale designators defined by Java. Indicates this entry should only | ||
| 806 : | be installed on a system running with a compatible locale (using Java | ||
| 807 : | locale-matching rules). If this attribute is not specified, the entry can | ||
| 808 : | be installed on all systems (language-neutral implementation). This information | ||
| 809 : | is used as a hint by the installation and update support (user can force | ||
| 810 : | installation of entry regardless of this setting).</li> | ||
| 811 : | <li> download-size - optional hint supplied by the feature packager, | ||
| 812 : | indicating the download size in KBytes of the referenced plug-in archive. | ||
| 813 : | If not specified, the download size is not known (<b>Implementation Note:</b> | ||
| 814 : | the implementation needs to distinguish between "not known" and 0 size)</li> | ||
| 815 : | <li> install-size - optional hint supplied by the feature packager, | ||
| 816 : | indicating the install size in KBytes of the referenced plug-in archive. | ||
| 817 : | If not specified, the install size is not known (<b>Implementation Note:</b> | ||
| 818 : | the implementation needs to distinguish between "not known" and 0 size)</li> | ||
| 819 : | |||
| 820 : | celek | 1.13 | </ul> |
| 821 : | celek | 1.14 | <li> <data> - identifies non-plugin and non-feature data |
| 822 : | that is part of the feature. Generally, data are post-install processed using | ||
| 823 : | celek | 1.13 | feature Install handler. Feature files like feature.properties are not considered |
| 824 : | celek | 1.14 | data.</li> |
| 825 : | |||
| 826 : | celek | 1.13 | <ul> |
| 827 : | celek | 1.14 | <li> id - required data identifier in the form of a relative path.</li> |
| 828 : | <li> os - optional operating system specification. A comma-separated | ||
| 829 : | list of os designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt> | ||
| 830 : | . Indicates this entry should only be installed on one of the specified | ||
| 831 : | os systems. If this attribute is not specified, the entry can be installed | ||
| 832 : | on all systems (portable implementation). This information is used as | ||
| 833 : | a hint by the installation and update support (user can force installation | ||
| 834 : | of entry regardless of this setting).</li> | ||
| 835 : | <li> arch - optional machine architecture specification. A comma-separated | ||
| 836 : | list of architecture designators defined by Eclipse (see Javadoc for | ||
| 837 : | <tt> org.eclipse.core.boot.BootLoader)</tt>. Indicates this feature | ||
| 838 : | should only be installed on one of the specified systems. If this attribute | ||
| 839 : | is not specified, the feature can be installed on all systems (portable | ||
| 840 : | implementation). This information is used as a hint by the installation | ||
| 841 : | and update support (user can force installation of feature regardless of | ||
| 842 : | this setting).</li> | ||
| 843 : | <li> ws - optional windowing system specification. A comma-separated | ||
| 844 : | list of ws designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt> | ||
| 845 : | . Indicates this entry should only be installed on one of the specified | ||
| 846 : | ws systems. If this attribute is not specified, the entry can be installed | ||
| 847 : | on all systems (portable implementation). This information is used as | ||
| 848 : | a hint by the installation and update support (user can force installation | ||
| 849 : | of entry regardless of this setting).</li> | ||
| 850 : | <li> nl - optional locale specification. A comma-separated list | ||
| 851 : | of locale designators defined by Java. Indicates this entry should only | ||
| 852 : | be installed on a system running with a compatible locale (using Java | ||
| 853 : | locale-matching rules). If this attribute is not specified, the entry can | ||
| 854 : | be installed on all systems (language-neutral implementation). This information | ||
| 855 : | is used as a hint by the installation and update support (user can force | ||
| 856 : | installation of entry regardless of this setting).</li> | ||
| 857 : | <li> download-size - optional hint supplied by the feature packager, | ||
| 858 : | indicating the download size in KBytes of the referenced data archive. | ||
| 859 : | If not specified, the download size is not known (<b>Implementation Note:</b> | ||
| 860 : | the implementation needs to distinguish between "not known" and 0 size)</li> | ||
| 861 : | <li> install-size - optional hint supplied by the feature packager, | ||
| 862 : | indicating the install size in KBytes of the referenced data archive. | ||
| 863 : | If not specified, the install size is not known (<b>Implementation Note:</b> | ||
| 864 : | the implementation needs to distinguish between "not known" and 0 size)</li> | ||
| 865 : | |||
| 866 : | celek | 1.10 | </ul> |
| 867 : | celek | 1.14 | |
| 868 : | celek | 1.9 | </ul> |
| 869 : | celek | 1.14 | <a name="Feature_Archive_Mapping_Id_To_Path"></a> When interacting |
| 870 : | with the update site, the feature implementation maps the <tt><plugin></tt> | ||
| 871 : | and <tt><data></tt> elements into path identifiers used by the | ||
| 872 : | site to determine the actual files to download and install. The default | ||
| 873 : | feature implementation supplied by Eclipse constructs the path identifiers | ||
| 874 : | as follows: | ||
| 875 : | celek | 1.7 | <ul> |
| 876 : | celek | 1.14 | <li> <tt><plugin></tt> element results in a path entry in |
| 877 : | the form "<tt>plugins/<pluginId>_<pluginVersion>.jar</tt>" | ||
| 878 : | (for example, "<tt>plugins/org.eclipse.core.boot_1.0.3.jar</tt>")</li> | ||
| 879 : | <li> <tt><data></tt> element results in a path entry in | ||
| 880 : | the form "<tt>features/<featureId>_<featureVersion>/<dataId></tt> | ||
| 881 : | " (for example, "f<tt>eatures/com.xyz.tools_2.3.1/examples.zip</tt>")</li> | ||
| 882 : | |||
| 883 : | celek | 1.7 | </ul> |
| 884 : | celek | 1.14 | Note, that in general the feature.xml manifest documents |
| 885 : | should specify UTF-8 encoding. For example | ||
| 886 : | celek | 1.7 | <p><tt><?xml version="1.0" encoding="UTF-8"?></tt> </p> |
| 887 : | celek | 1.14 | |
| 888 : | celek | 1.13 | <p>Translatable text contained in the feature.xml can be separated into feature<_locale>.properties |
| 889 : | celek | 1.14 | files using Java property bundle conventions. Note that the translated |
| 890 : | strings are used at installation time (ie. do not employ the plug-in fragment | ||
| 891 : | runtime mechanism). </p> | ||
| 892 : | |||
| 893 : | celek | 1.9 | <h3> <a name="Plug-In_Archive"></a> Plug-In Archive</h3> |
| 894 : | celek | 1.14 | Plug-ins and plug-in fragments are individually packaged as separate |
| 895 : | Java .jars. Standard Java jar facilities are used for constructing plug-in | ||
| 896 : | archives. There is no distinction made between a plug-in archive containing | ||
| 897 : | a plug-in and one containing a plug-in fragment. | ||
| 898 : | celek | 1.7 | <p>The recommended convention for naming the plug-in archives is <br> |
| 899 : | celek | 1.14 | <tt><id>_<version>.jar</tt> </p> |
| 900 : | |||
| 901 : | celek | 1.13 | <p>Where <tt><id></tt> is the plug-in or fragment identifier and <tt> |
| 902 : | celek | 1.14 | <version></tt> is the full version identifier contained in the respective |
| 903 : | plugin.xml or fragment.xml. Note that this is a recommended convention | ||
| 904 : | that minimizes chance of collisions, but is not required by the Eclipse | ||
| 905 : | architecture. For example, the following are valid plug-in archive names | ||
| 906 : | </p> | ||
| 907 : | |||
| 908 : | celek | 1.7 | <p><tt>org.eclipse.platform_1.0.3.jar</tt> <br> |
| 909 : | celek | 1.14 | <tt>org.eclipse.ui.nl_2.0.jar</tt> <br> |
| 910 : | <tt>my_plugin.jar</tt> </p> | ||
| 911 : | |||
| 912 : | celek | 1.13 | <p>Internally, each plug-in archive packages all the relevant plug-in or |
| 913 : | fragment files relative to its plug-in or fragment directory (but not including | ||
| 914 : | the directory path element). The archive has the following structure </p> | ||
| 915 : | celek | 1.14 | |
| 916 : | celek | 1.7 | <p><tt>plugin.xml *OR* fragment.xml</tt> <br> |
| 917 : | celek | 1.14 | <tt>other plug-in or feature files and subdirectories</tt> <br> |
| 918 : | <tt>META-INF/</tt> <br> | ||
| 919 : | <tt> Java jar manifest and security files</tt> | ||
| 920 : | </p> | ||
| 921 : | |||
| 922 : | celek | 1.9 | <h3> <a name="Packaging_NL"></a> Packaging NL</h3> |
| 923 : | celek | 1.14 | In Eclipse, translated plug-in information is packaged either together |
| 924 : | with the base plug-in, or as a plug-in fragment. At runtime, Eclipse | ||
| 925 : | locates the translations for the required locale. The use of fragments | ||
| 926 : | allows translations to be added to the runtime without the need to repackage | ||
| 927 : | the base plug-ins. | ||
| 928 : | celek | 1.13 | <p>This mechanism cannot be used for translating the actual packaging information |
| 929 : | celek | 1.14 | that is part of the installation xml files. Consequently the standard |
| 930 : | Java translation conventions are used for the packaging information, | ||
| 931 : | and all necessary translations must be available at the time the feature | ||
| 932 : | is packaged. </p> | ||
| 933 : | |||
| 934 : | celek | 1.9 | <h4> <a name="Translated_Feature_Information"></a> Translated Feature Information</h4> |
| 935 : | celek | 1.14 | <b>Note:</b> This section describes the conventions used for translating |
| 936 : | the information contained within the feature manifest. It allows for | ||
| 937 : | the update client to select the correctly localized strings from the update | ||
| 938 : | server. This section specifically does not describe localization of individual | ||
| 939 : | plug-ins. | ||
| 940 : | celek | 1.13 | <p>Several of the attributes within the feature manifest are strings intended |
| 941 : | celek | 1.14 | for display through user interfaces. To facilitate translation, these |
| 942 : | attribute values use the convention defined for translatable attributes | ||
| 943 : | of plugin.xml. Strings beginning with % up to the first space are treated | ||
| 944 : | as resource identifier keys (without the %) and looked up in a properties | ||
| 945 : | file. For example </p> | ||
| 946 : | |||
| 947 : | celek | 1.7 | <p><tt>label="%cfg Tool Feature for Linux"</tt> </p> |
| 948 : | celek | 1.14 | |
| 949 : | celek | 1.13 | <p>results in a resource lookup in the correct property file with key "cfg". |
| 950 : | celek | 1.14 | If no property files are supplied, or the key is not found the default |
| 951 : | string value (following the %key) is used. </p> | ||
| 952 : | |||
| 953 : | celek | 1.13 | <p>The property files are named as feature_<locale>.properties using |
| 954 : | celek | 1.14 | the Java resource bundle naming conventions. Within the feature archive |
| 955 : | .jar they are placed in the same directory as their corresponding feature.xml | ||
| 956 : | file. </p> | ||
| 957 : | |||
| 958 : | celek | 1.13 | <p><b>Implementation Note</b>: When accessing the resource bundles the Eclipse |
| 959 : | celek | 1.14 | installation and update code should create a class loader for accessing |
| 960 : | the translated string. This way, the standard locale lookup algorithm implemented | ||
| 961 : | by Java is automatically used. </p> | ||
| 962 : | |||
| 963 : | celek | 1.7 | <p><tt>ResourceBundle b;</tt> <br> |
| 964 : | celek | 1.14 | <tt>ClassLoader l;</tt> <br> |
| 965 : | <tt>l = new URLClassLoader(new URL[] {<targetDirectoryURL>}, | ||
| 966 : | null);</tt> <br> | ||
| 967 : | <tt>b = ResourceBundle.getBundle("feature",Locale.getDefault(),l);</tt> | ||
| 968 : | </p> | ||
| 969 : | |||
| 970 : | celek | 1.13 | <p>The resulting resource bundle can be used in <tt>IPluginDescriptor.getResourceString(String,ResourceBundle)</tt> |
| 971 : | celek | 1.14 | to actually return the correct translated string for the manifest attribute. |
| 972 : | </p> | ||
| 973 : | |||
| 974 : | celek | 1.9 | <h4> <a name="Translated_Plug-In_Information"></a> Translated Plug-In Information</h4> |
| 975 : | celek | 1.14 | No change from 1.0. Translated plug-in information should be packaged |
| 976 : | as plug-in fragments. | ||
| 977 : | celek | 1.13 | <h3> <a name="Packaging_Target-Specific_Support"></a> Packaging Target-Specific |
| 978 : | celek | 1.14 | Support</h3> |
| 979 : | No change from 1.0. Target-specific plug-in support (os, ws) should | ||
| 980 : | be packaged as plug-in fragments. | ||
| 981 : | celek | 1.13 | <h3> <a name="Packaging_Attribution_Information"></a> Packaging Attribution |
| 982 : | celek | 1.14 | Information</h3> |
| 983 : | This topic is covered in separate documents available on the eclipse.org | ||
| 984 : | development resources page of the Update component. | ||
| 985 : | celek | 1.9 | <h3> <a name="Packaging_Non_Plug_In_Files"></a> Packaging Non-Plug-In Files</h3> |
| 986 : | celek | 1.14 | Arbitrary non-plug-in files can be included as part of the feature |
| 987 : | definition using the <tt><data></tt> elements. Non-plug-in files | ||
| 988 : | typically also requires specification of a custom install handler. In | ||
| 989 : | general, the Eclipse support only downloads the referenced non-plug-in | ||
| 990 : | files and calls the custom install handler to perform any actual installation | ||
| 991 : | steps. | ||
| 992 : | celek | 1.7 | <p>Eclipse does not specify the format of the non-plug-in files. </p> |
| 993 : | celek | 1.14 | |
| 994 : | celek | 1.9 | <h3> <a name="Custom_Install_Handling"></a> Custom Install Handling</h3> |
| 995 : | celek | 1.14 | Custom install handlers are written as a Java class and are packaged |
| 996 : | as part of the <a href="#Feature_Archive">feature archive</a> . The installer | ||
| 997 : | must implement the <tt>IInstallHandler</tt> interface (in most cases | ||
| 998 : | will extend the <tt>BaseInstallHandler</tt> abstract helper class which | ||
| 999 : | implements <tt>IInstallHandler</tt>). When required, the install handler | ||
| 1000 : | is dynamically loaded by the installation and update code, and is called | ||
| 1001 : | at specific points during its processing. The install handler code has | ||
| 1002 : | visibility to classes from the installation and update support plug-in, | ||
| 1003 : | and its prerequisite plug-ins. | ||
| 1004 : | celek | 1.13 | <p><b>Implementation Note:</b> the detailed list of visible prerequisite |
| 1005 : | plug-ins is still evolving. It is expected to include <tt>org.eclipse.core.boot | ||
| 1006 : | </tt> and <tt>org.eclipse.core.runtime</tt> in all cases, plus <tt>org.eclipse.ui</tt> | ||
| 1007 : | celek | 1.14 | and <tt>org.eclipse.swt</tt> when running with full workbench (ie. not |
| 1008 : | "headless mode"). Also, it would be useful to always expose <tt>org.eclipse.core.ant</tt> | ||
| 1009 : | so that build scripts can be used as part of the install handler implementation. | ||
| 1010 : | </p> | ||
| 1011 : | |||
| 1012 : | celek | 1.13 | <p>The IInstallHandler interface supports the following methods [<b>Implementation |
| 1013 : | celek | 1.14 | Note:</b> the detailed definition of the IInstallHandler interface is |
| 1014 : | still evolving. The description below is not an API specification (simply | ||
| 1015 : | a functional description)]: </p> | ||
| 1016 : | |||
| 1017 : | celek | 1.7 | <ul> |
| 1018 : | celek | 1.14 | <li> install-initiated - the install handler is called after a |
| 1019 : | feature was selected for installation, but before any files were downloaded. | ||
| 1020 : | It is intended to implement any custom click-through or user registration | ||
| 1021 : | dialogs. The base implementation of this method supplied with the abstract | ||
| 1022 : | class <tt>BaseInstallHandler </tt>performs the default click-through | ||
| 1023 : | processing using the license text supplied as part of the feature manifest. | ||
| 1024 : | On return this method indicates success (installation continues) of failure | ||
| 1025 : | (installation is aborted).</li> | ||
| 1026 : | <li> install-downloaded - the install handler is called after | ||
| 1027 : | all the required feature files were downloaded (feature, plugins, data) | ||
| 1028 : | but before the actual installation is performed. The install handler | ||
| 1029 : | is expected to perform verification of the non-plug-in data files (eg. | ||
| 1030 : | security), or any other pre-install processing. On return this method | ||
| 1031 : | indicates success (installation continues) or failure (installation is | ||
| 1032 : | aborted).</li> | ||
| 1033 : | <li> install-completion - the install handler is called after | ||
| 1034 : | the feature information and the plug-ins were installed. It is expected | ||
| 1035 : | to complete the installation of any non-plug-in data that was part of the | ||
| 1036 : | feature. On return this method indicates success (returns custom install | ||
| 1037 : | log) or failure (installation is aborted). On failure, the install handler | ||
| 1038 : | is expected to perform any required cleanup.</li> | ||
| 1039 : | <li> uninstall-initiated - the install handler is called when | ||
| 1040 : | a feature is selected for removal, but before any of the standard uninstall | ||
| 1041 : | processing has taken place. It is passed the custom install log created | ||
| 1042 : | by the install handler install-completion step.</li> | ||
| 1043 : | <li> uninstall-completion - the install handler is called on completion | ||
| 1044 : | of the standard uninstall steps. It is passed the custom install log created | ||
| 1045 : | by the install handler install-completion step.</li> | ||
| 1046 : | |||
| 1047 : | celek | 1.7 | </ul> |
| 1048 : | celek | 1.14 | Note, that as a general practice, install handlers should be provided |
| 1049 : | in their own jars (even though they could be just exposed in the feature | ||
| 1050 : | archive jar). The jar should be signed, and sealed. | ||
| 1051 : | celek | 1.9 | <h3> <a name="Security_Considerations"></a> Security Considerations</h3> |
| 1052 : | celek | 1.14 | The general approach is to use base Java jar signing for the feature |
| 1053 : | and plug-in archive .jars. | ||
| 1054 : | celek | 1.7 | <p>Features are verified as follows: </p> |
| 1055 : | celek | 1.14 | |
| 1056 : | celek | 1.7 | <ul> |
| 1057 : | celek | 1.14 | <li> download and verify the feature archive (use base Java jar |
| 1058 : | verification)</li> | ||
| 1059 : | <li> for each plug-in archive</li> | ||
| 1060 : | |||
| 1061 : | <ul> | ||
| 1062 : | <li> verify the archive jar content (use base Java jar verification)</li> | ||
| 1063 : | <li> verify plug-in id and version from <tt><plugin></tt> | ||
| 1064 : | entry in feature manifest matches downloaded plugin.xml</li> | ||
| 1065 : | |||
| 1066 : | celek | 1.7 | </ul> |
| 1067 : | celek | 1.14 | <li> for each non-plugin file</li> |
| 1068 : | |||
| 1069 : | celek | 1.7 | <ul> |
| 1070 : | celek | 1.14 | <li> call install handler to verify file</li> |
| 1071 : | |||
| 1072 : | celek | 1.10 | </ul> |
| 1073 : | celek | 1.14 | |
| 1074 : | celek | 1.9 | </ul> |
| 1075 : | celek | 1.14 | In general, when processing signed jars, the user will be prompted |
| 1076 : | for each unrecognized certificate. The response choices will include | ||
| 1077 : | aborting the installation (originator is not trusted), continuing the | ||
| 1078 : | installation (originator is trusted for this installation). | ||
| 1079 : | celek | 1.9 | <h2> <a name="Update_Server"></a> Update Server</h2> |
| 1080 : | celek | 1.14 | The default Eclipse update server is any URL-accessible server. |
| 1081 : | The default implementation assumes a fixed-layout server. The content | ||
| 1082 : | of the server (in terms of available features and plug-ins) is described | ||
| 1083 : | in a site map file, <i>site.xml</i>. This file can be manually maintained, | ||
| 1084 : | or can be dynamically computed by the server. | ||
| 1085 : | celek | 1.9 | <h3> <a name="Site_Map"></a> Site Map</h3> |
| 1086 : | celek | 1.14 | The update server URL can be specified as a full URL to the site |
| 1087 : | map file, or a URL of a directory path containing the site map file | ||
| 1088 : | (similar to index.html processing). The site map site.xml format is | ||
| 1089 : | defined by the following dtd: | ||
| 1090 : | celek | 1.7 | <p><tt><?xml encoding="ISO-8859-1"?></tt> </p> |
| 1091 : | celek | 1.14 | |
| 1092 : | celek | 1.13 | <p><tt><!ELEMENT site (description?, feature*, archive*, category-def*)></tt> |
| 1093 : | celek | 1.14 | <br> |
| 1094 : | <tt><!ATTLIST site</tt> <br> | ||
| 1095 : | <tt> type | ||
| 1096 : | CDATA #IMPLIED</tt> <br> | ||
| 1097 : | <tt> url | ||
| 1098 : | CDATA #IMPLIED</tt> <br> | ||
| 1099 : | <tt>></tt> </p> | ||
| 1100 : | |||
| 1101 : | celek | 1.7 | <p><tt><!ELEMENT description (#PCDATA)></tt> <br> |
| 1102 : | celek | 1.14 | <tt><!ATTLIST description</tt> <br> |
| 1103 : | <tt> url | ||
| 1104 : | CDATA #IMPLIED</tt> <br> | ||
| 1105 : | <tt>></tt> </p> | ||
| 1106 : | |||
| 1107 : | celek | 1.7 | <p><tt><!ELEMENT feature (category*)></tt> <br> |
| 1108 : | celek | 1.14 | <tt><!ATTLIST feature</tt> <br> |
| 1109 : | <tt> type | ||
| 1110 : | CDATA #IMPLIED</tt> <br> | ||
| 1111 : | <tt> id | ||
| 1112 : | CDATA #IMPLIED</tt> <br> | ||
| 1113 : | <tt> version | ||
| 1114 : | CDATA #IMPLIED</tt> <br> | ||
| 1115 : | <tt> url | ||
| 1116 : | CDATA #REQUIRED<br> | ||
| 1117 : | label CDATA | ||
| 1118 : | #IMPLIED<br> | ||
| 1119 : | </tt><tt> os | ||
| 1120 : | CDATA #IMPLIED</tt> <br> | ||
| 1121 : | <tt> arch | ||
| 1122 : | CDATA #IMPLIED</tt> <br> | ||
| 1123 : | <tt> ws | ||
| 1124 : | CDATA #IMPLIED</tt> <br> | ||
| 1125 : | <tt> nl | ||
| 1126 : | CDATA #IMPLIED</tt><br> | ||
| 1127 : | <tt> patch </tt><tt> | ||
| 1128 : | (true | false) "false"</tt><br> | ||
| 1129 : | <tt> ></tt> </p> | ||
| 1130 : | |||
| 1131 : | celek | 1.7 | <p><tt><!ELEMENT archive EMPTY></tt> <br> |
| 1132 : | celek | 1.14 | <tt><!ATTLIST archive</tt> <br> |
| 1133 : | <tt> path | ||
| 1134 : | CDATA #REQUIRED</tt> <br> | ||
| 1135 : | <tt> url | ||
| 1136 : | CDATA #REQUIRED</tt> <br> | ||
| 1137 : | <tt>></tt> </p> | ||
| 1138 : | |||
| 1139 : | celek | 1.7 | <p><tt><!ELEMENT category EMPTY></tt> <br> |
| 1140 : | celek | 1.14 | <tt><!ATTLIST category</tt> <br> |
| 1141 : | <tt> name | ||
| 1142 : | CDATA #REQUIRED</tt> <br> | ||
| 1143 : | <tt>></tt> </p> | ||
| 1144 : | |||
| 1145 : | celek | 1.7 | <p><tt><!ELEMENT category-def (description?)></tt> <br> |
| 1146 : | celek | 1.14 | <tt><!ATTLIST category-def</tt> <br> |
| 1147 : | <tt> name | ||
| 1148 : | CDATA #REQUIRED</tt> <br> | ||
| 1149 : | <tt> label | ||
| 1150 : | CDATA #REQUIRED</tt> <br> | ||
| 1151 : | <tt>></tt> </p> | ||
| 1152 : | |||
| 1153 : | celek | 1.7 | <p>The element and attribute definitions are as follows: </p> |
| 1154 : | celek | 1.14 | |
| 1155 : | celek | 1.7 | <ul> |
| 1156 : | celek | 1.14 | <li> <site> - defines the site map</li> |
| 1157 : | |||
| 1158 : | celek | 1.7 | <ul> |
| 1159 : | celek | 1.14 | <li> type - optional site type specification. The value refers |
| 1160 : | to a type string registered via the <a href="#Framework">install framework</a> | ||
| 1161 : | extension point. If not specified, the type is assumed to be the default | ||
| 1162 : | Eclipse site type (as specified in this document).</li> | ||
| 1163 : | <li> url - optional URL defining the update site baseline URL | ||
| 1164 : | (used to determine individual <feature> and <archive> location). | ||
| 1165 : | Can be relative or absolute. If relative, is relative to site.xml. If | ||
| 1166 : | not specified, the default is the URL location of the site.xml file.</li> | ||
| 1167 : | |||
| 1168 : | </ul> | ||
| 1169 : | <li> <description> - brief description as simple text. Intended | ||
| 1170 : | to be translated.</li> | ||
| 1171 : | |||
| 1172 : | <ul> | ||
| 1173 : | <li> url - optional URL for the full description as HTML. The URL | ||
| 1174 : | can be specified as absolute of relative. If relative, If relative, is | ||
| 1175 : | relative to site.xml.</li> | ||
| 1176 : | <br> | ||
| 1177 : | Note, that for NL handling the URL value should be separated to | ||
| 1178 : | allow alternate URLs to be specified for each national language. | ||
| 1179 : | |||
| 1180 : | </ul> | ||
| 1181 : | <li> <feature> - identifies referenced feature archive</li> | ||
| 1182 : | |||
| 1183 : | <ul> | ||
| 1184 : | <li> type - optional feature type specification. The value refers | ||
| 1185 : | to a type string registered via the <a href="#Framework">install framework</a> | ||
| 1186 : | extension point. If not specified, the type is assumed to be the default | ||
| 1187 : | feature type for the site. If the site type is the default Eclipse site | ||
| 1188 : | type, the default feature type is the packaged feature type (as specified | ||
| 1189 : | in this document).</li> | ||
| 1190 : | <li> id - optional feature identifier. The information is used | ||
| 1191 : | as a performance optimization to speed up searches for features. Must | ||
| 1192 : | match the identifier specified in the feature.xml of the referenced archive | ||
| 1193 : | (the url attribute). If specified, the version attribute must also be | ||
| 1194 : | specified.</li> | ||
| 1195 : | <li> version - optional feature version. The information is used | ||
| 1196 : | as a performance optimization to speed up searches for features. Must | ||
| 1197 : | match the version specified in the feature.xml of the referenced archive | ||
| 1198 : | (the url attribute). If specified, the id attribute must also be specified.</li> | ||
| 1199 : | <li> url - required URL reference to the feature archive. Can | ||
| 1200 : | be relative or absolute. If relative, it is relative to the location | ||
| 1201 : | of the site.xml file. <b>Note</b>: the default site implementation | ||
| 1202 : | allows features to be accessed without being explicitly declared using a | ||
| 1203 : | <feature> entry. By default, an undeclared features reference is interpreted | ||
| 1204 : | as "features/<id>_<version>.jar"</li> | ||
| 1205 : | <li>label - optional feature label. The value is used for optimization | ||
| 1206 : | when browsing the site from the update manager. Intended to be translated.<br> | ||
| 1207 : | </li> | ||
| 1208 : | <li> os - optional operating system specification. A comma-separated | ||
| 1209 : | list of os designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt> | ||
| 1210 : | . Indicates this feature should only be installed on one of the specified | ||
| 1211 : | os systems. If this attribute is "*", the feature can be installed | ||
| 1212 : | on all systems (portable implementation). This information is used as | ||
| 1213 : | a hint by the installation and update support (user can force installation | ||
| 1214 : | of feature regardless of this setting).</li> | ||
| 1215 : | <li> arch - optional machine architecture specification. A comma-separated | ||
| 1216 : | list of architecture designators defined by Eclipse (see Javadoc for | ||
| 1217 : | <tt> org.eclipse.core.boot.BootLoader)</tt>. Indicates this feature | ||
| 1218 : | should only be installed on one of the specified systems. If this attribute is | ||
| 1219 : | "*", the feature can be installed on all systems (portable implementation). | ||
| 1220 : | This information is used as a hint by the installation and update support | ||
| 1221 : | (user can force installation of feature regardless of this setting).</li> | ||
| 1222 : | <li> ws - optional windowing system specification. A comma-separated | ||
| 1223 : | list of ws designators defined by Eclipse (see Javadoc for <tt>org.eclipse.core.boot.BootLoader)</tt> | ||
| 1224 : | . Indicates this feature should only be installed on one of the specified | ||
| 1225 : | ws systems. If this attribute is "*", the feature can be installed | ||
| 1226 : | on all systems (portable implementation). This information is used as | ||
| 1227 : | a hint by the installation and update support (user can force installation | ||
| 1228 : | of feature regardless of this setting).</li> | ||
| 1229 : | <li> nl - optional locale specification. A comma-separated list | ||
| 1230 : | of locale designators defined by Java. Indicates this feature should | ||
| 1231 : | only be installed on a system running with a compatible locale (using | ||
| 1232 : | Java locale-matching rules). If this attribute is "*", the feature | ||
| 1233 : | can be installed on all systems (language-neutral implementation). This | ||
| 1234 : | information is used as a hint by the installation and update support (user | ||
| 1235 : | can force installation of feature regardless of this setting).</li> | ||
| 1236 : | <li>patch - optional specification indicating if this feature | ||
| 1237 : | is a patch. Default is "false". </li> | ||
| 1238 : | |||
| 1239 : | celek | 1.7 | </ul> |
| 1240 : | celek | 1.14 | <li> <archive> - identifies referenced "storage" archive |
| 1241 : | (the actual files referenced via the <tt><plugin></tt> or <tt><data></tt> | ||
| 1242 : | elements in the feature manifest). The site simply manages archives as | ||
| 1243 : | a path-to-URL map. The default Eclipse site implementation does not require | ||
| 1244 : | the <archive> section to be included in the site map (site.xml). | ||
| 1245 : | Any archive reference not explicitly defined as part of an <archive> | ||
| 1246 : | section is assumed to be mapped to a url in the form "<archivePath>" | ||
| 1247 : | relative to the location of the site.xml file.</li> | ||
| 1248 : | |||
| 1249 : | <ul> | ||
| 1250 : | <li> path - required archive path identifier. This is a string | ||
| 1251 : | that is determined by the <a | ||
| 1252 : | href="#Feature_Archive_Mapping_Id_To_Path">feature</a> referencing | ||
| 1253 : | this archive and is not otherwise interpreted by the site (other than | ||
| 1254 : | as a lookup token).</li> | ||
| 1255 : | <li> url - required URL reference to the archive. Can be relative | ||
| 1256 : | or absolute. If relative, it is relative to the location of the site.xml | ||
| 1257 : | file.</li> | ||
| 1258 : | |||
| 1259 : | </ul> | ||
| 1260 : | <li> <category-def> - an optional definition of a category | ||
| 1261 : | that can be used by installation and update support to hierarchicaly organize | ||
| 1262 : | features</li> | ||
| 1263 : | |||
| 1264 : | <ul> | ||
| 1265 : | <li> name - category name. Is specified as a path of name tokens | ||
| 1266 : | separated by /</li> | ||
| 1267 : | <li> label - displayable label. Intended to be translated.</li> | ||
| 1268 : | |||
| 1269 : | </ul> | ||
| 1270 : | <li> <category> - actual category specification for a feature | ||
| 1271 : | entry</li> | ||
| 1272 : | |||
| 1273 : | celek | 1.9 | <ul> |
| 1274 : | celek | 1.14 | name - category name |
| 1275 : | celek | 1.13 | </ul> |
| 1276 : | celek | 1.14 | |
| 1277 : | celek | 1.7 | </ul> |
| 1278 : | celek | 1.14 | Note, that in general the feature.xml manifest documents |
| 1279 : | should specify UTF-8 encoding. For example | ||
| 1280 : | celek | 1.7 | <p><tt><?xml version="1.0" encoding="UTF-8"?></tt> </p> |
| 1281 : | celek | 1.14 | |
| 1282 : | celek | 1.13 | <p>Translatable text contained in the site.xml can be separated into site<_locale>.properties |
| 1283 : | celek | 1.14 | files using Java property bundle conventions. Note that the translated |
| 1284 : | strings are used at installation time (ie. do not employ the plug-in fragment | ||
| 1285 : | runtime mechanism). The property bundles are located relative to the site.xml | ||
| 1286 : | location. </p> | ||
| 1287 : | |||
| 1288 : | celek | 1.9 | <h3> <a name="Default_Site_Layout"></a> Default Site Layout</h3> |
| 1289 : | celek | 1.14 | <tt><site root>/</tt> <br> |
| 1290 : | <tt> site.xml</tt> <br> | ||
| 1291 : | <tt> features/</tt> <br> | ||
| 1292 : | <tt> feature archives | ||
| 1293 : | (eg. org.eclipse.javatools_1.0.1.jar)</tt> <br> | ||
| 1294 : | <tt> <featureId>_<featureVersion>/ | ||
| 1295 : | (optional)</tt> <br> | ||
| 1296 : | <tt> | ||
| 1297 : | non-plug-in files for feature</tt> <br> | ||
| 1298 : | <tt> plugins/</tt> <br> | ||
| 1299 : | <tt> plug-in argives | ||
| 1300 : | (eg. org.eclipse.ui_1.0.3.jar)</tt> | ||
| 1301 : | celek | 1.9 | <h3> <a name="Controlling_Access"></a> Controlling Access</h3> |
| 1302 : | celek | 1.14 | The default Eclipse site implementation provides support for http |
| 1303 : | access with basic user authentication (userid and password). | ||
| 1304 : | |||
| 1305 : | celek | 1.13 | <p>Custom access control mechanisms can be added to base Eclipse in one of |
| 1306 : | celek | 1.14 | 2 ways: </p> |
| 1307 : | |||
| 1308 : | celek | 1.7 | <ul> |
| 1309 : | celek | 1.14 | <li> by supplying server-side logic on the update server (eg. implementing |
| 1310 : | servlets that compute the site.xml map, and control access to individual | ||
| 1311 : | archives based on some user criteria)</li> | ||
| 1312 : | <li> by supplying a custom concrete implementation of the site | ||
| 1313 : | object (installed on the client machine, update server specified <tt><site | ||
| 1314 : | type=""></tt> ). The custom concrete site implementation, together | ||
| 1315 : | with any server-side logic support the required control mechanisms.</li> | ||
| 1316 : | |||
| 1317 : | vlad | 1.1 | </ul> |
| 1318 : | celek | 1.14 | Eclipse provides an example demonstrating an implementation of |
| 1319 : | an access mechanism based on feature key files. | ||
| 1320 : | celek | 1.9 | <h2> <a name="Eclipse_Install"></a> Eclipse Install</h2> |
| 1321 : | celek | 1.14 | |
| 1322 : | celek | 1.9 | <h3> <a name="Default_Install_Layout"></a> Default Install Layout</h3> |
| 1323 : | celek | 1.14 | <tt><install root>/</tt> <br> |
| 1324 : | <tt> install/</tt> <br> | ||
| 1325 : | <tt> features/</tt> <br> | ||
| 1326 : | <tt> | ||
| 1327 : | <featureId>_<version>/</tt> <br> | ||
| 1328 : | <tt> | ||
| 1329 : | feature.xml</tt> <br> | ||
| 1330 : | <tt> | ||
| 1331 : | other feature files</tt> <br> | ||
| 1332 : | <tt> | ||
| 1333 : | META-INF/</tt> <br> | ||
| 1334 : | <tt> | ||
| 1335 : | META-INF-ECLIPSE/</tt> | ||
| 1336 : | celek | 1.7 | <p><tt> plugins/</tt> <br> |
| 1337 : | celek | 1.14 | <tt> <pluginORfragmentId>_<version>/</tt> |
| 1338 : | <br> | ||
| 1339 : | <tt> | ||
| 1340 : | plugin.xml or fragment.xml</tt> <br> | ||
| 1341 : | <tt> | ||
| 1342 : | other plugin or fragment files</tt> <br> | ||
| 1343 : | <tt> | ||
| 1344 : | META_INF/</tt> </p> | ||
| 1345 : | |||
| 1346 : | celek | 1.13 | <p><b>Implementation Note:</b> we will go back to the original design of |
| 1347 : | not splitting out fragments (ie. plugin and fragments go into the same install | ||
| 1348 : | celek | 1.14 | location) </p> |
| 1349 : | |||
| 1350 : | celek | 1.9 | <h3> <a name="Unmanaged_Plugins"></a> "Unmanaged" Plug-Ins</h3> |
| 1351 : | celek | 1.14 | Eclipse supports a concept of "unmanaged" plug-ins. These are plug-ins |
| 1352 : | that were directly installed into the Eclipse file tree without being | ||
| 1353 : | part of a feature (eg. developer unzipping plug-in archive directly into | ||
| 1354 : | the Eclipse file tree). | ||
| 1355 : | celek | 1.13 | <p>Eclipse runtime recognizes these plugins during startup and loads the |
| 1356 : | plug-in information into the runtime registry following the standard plug-in | ||
| 1357 : | binding rules. The update support also recognizes the presence of this new | ||
| 1358 : | plug-in, but since this plug-in is not part of any feature it cannot be updated | ||
| 1359 : | using the update support (hence "unmanaged"). Unmanaged plug-in that become | ||
| 1360 : | referenced by a feature as a result of some future installation or update | ||
| 1361 : | action become "managed" (can be updated as part of the feature). </p> | ||
| 1362 : | celek | 1.14 | |
| 1363 : | celek | 1.13 | <p>Unmanaged plug-ins are not displayed as part of the installation and update |
| 1364 : | celek | 1.14 | UI. </p> |
| 1365 : | |||
| 1366 : | celek | 1.13 | <h3> <a name="Using_Native_Platform_Installers"></a> Using Native Platform |
| 1367 : | celek | 1.14 | Installers</h3> |
| 1368 : | The Eclipse installation contains plugins that can be shared across | ||
| 1369 : | multiple features. When installing and uninstalling features using the | ||
| 1370 : | Eclipse installation and update support, these relationship are correctly | ||
| 1371 : | maintained. Only one copy of any version of a plug-in is used. | ||
| 1372 : | |||
| 1373 : | celek | 1.13 | <p>However, when using native platform installers, performing native uninstall |
| 1374 : | celek | 1.14 | creates problems because plug-ins would be removed without regard to |
| 1375 : | any sharing relationships. As a result, Eclipse <b>does not allow</b> | ||
| 1376 : | plug-ins to be installed using native installers into the shared installation | ||
| 1377 : | tree. Instead, native installers must establish their own installation | ||
| 1378 : | root directory. The subdirectory structure is the same as defined for | ||
| 1379 : | base Eclipse. The private root directory is logically linked into the shared | ||
| 1380 : | Eclipse installation via a link file installed by the native installer. | ||
| 1381 : | The file path for the link file is <tt><configRoot>/links/</tt>. | ||
| 1382 : | The <tt><configRoot> </tt> location is computed by Eclipse relative | ||
| 1383 : | to the launch <a href="#Multiple%20Launch%20Points"> configuration file</a> | ||
| 1384 : | . By default, this is the <tt>install/</tt> directory in the shared Eclipse | ||
| 1385 : | installation tree. </p> | ||
| 1386 : | |||
| 1387 : | celek | 1.13 | <p>The name of the link file is not specified by Eclipse. The name is determined |
| 1388 : | celek | 1.14 | by the native installer. To minimize the potential for naming collisions, |
| 1389 : | it is recommended that the file name contain the identifier and version | ||
| 1390 : | of the feature being installed by the native installer. For example, <tt><featureId>_<featureVersion>.properties</tt> | ||
| 1391 : | . The file content is in the form of a Java properties file, with the | ||
| 1392 : | following properties defined: </p> | ||
| 1393 : | |||
| 1394 : | celek | 1.7 | <p><tt>path=[r|rw] install-path[,[r|rw] install-path]*</tt> </p> |
| 1395 : | celek | 1.14 | |
| 1396 : | celek | 1.13 | <p>The property <tt>path</tt> is a comma-separated list of optionally annotated |
| 1397 : | celek | 1.14 | install paths. The property value <tt>install-path</tt> is a full file |
| 1398 : | path to the installation directory root, specified in local OS format. | ||
| 1399 : | The optional annotation <tt>r</tt> or <tt>rw</tt> indicates whether Eclipse | ||
| 1400 : | update support should allow the specified location to be used for updates. | ||
| 1401 : | Default is to allow updates (w). </p> | ||
| 1402 : | |||
| 1403 : | celek | 1.13 | <p>Eclipse does not manage the linked directories in any way. It simply detects |
| 1404 : | celek | 1.14 | their existence by the presence of the link files, and includes the linked |
| 1405 : | plug-ins during the platform startup. The native installer is responsible | ||
| 1406 : | for uninstalling the link when the corresponding directory is removed. | ||
| 1407 : | Eclipse runtime ignores any links that cannot be resolved. <br> | ||
| 1408 : | </p> | ||
| 1409 : | <br> | ||
| 1410 : | <br> | ||
| 1411 : | <br> | ||
| 1412 : | <br> | ||
| 1413 : | celek | 1.13 | <br> |
| 1414 : | celek | 1.12 | <br> |
| 1415 : | celek | 1.14 | |
| 1416 : | vlad | 1.1 | </body> |
| 1417 : | </html> |
| help@eclipse.org | ViewVC Help |
| Powered by ViewVC 1.0.3 |