# Installable Runtimes

###### Identifier:

org.eclipse.wst.server.core.installableRuntimes

###### Since:

This extension point is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

###### Description:

This extension point is used to install new runtimes (i.e. server installations) from a remote server. New users should use the 'runtime' element (which allows you to point to any zip file on any server) and not the original 'installableRuntime' element (which requires a remote update manager site).

###### Configuration Markup:

<!ELEMENT extension (installableRuntime* , runtime*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

- point - a fully qualified identifier of the target extension point
- id - an optional identifier of the extension instance
- name - an optional name of the extension instance

The installableRuntime element is deprecated

<!ELEMENT installableRuntime EMPTY>

<!ATTLIST installableRuntime

id CDATA #REQUIRED

featureId CDATA #REQUIRED

featureVersion CDATA #REQUIRED

featureSite CDATA #REQUIRED

bundleId CDATA #IMPLIED

bundleVersion CDATA #IMPLIED

path CDATA #IMPLIED>

- id - specifies a unique identifier for this extension point
- featureId - the id of the feature containing the runtime bundle
- featureVersion - the version of the feature containing the runtime bundle
- featureSite - the feature (update manager) site URL
- Deprecated bundleId - the id of the bundle in which the runtime zip is in
- Deprecated bundleVersion - the optional version of the bundle in which the runtime zip is in
- Deprecated path - if bundleId is specified then represents the relative path of the runtime zip inside the bundle, otherwise it assumes a relative path of the runtime archive inside the feature directory

<!ELEMENT runtime EMPTY>

<!ATTLIST runtime

id CDATA #REQUIRED

archiveUrl CDATA #REQUIRED

archivePath CDATA #IMPLIED

licenseUrl CDATA #IMPLIED

os CDATA #IMPLIED>

- id - specifies a unique identifier for this extension point
- archiveUrl - a URL to the runtime archive download
- archivePath - optional path within the archive to the root of the runtime
- licenseUrl - a URL to the runtime license
- os - optional operating system specification. A comma-separated list of operating system designators defined by Eclipse (see Javadoc for org.eclipse.core.runtime.Platform). Indicates this installable runtime should only be used on one of the specified OS systems. If this attribute is not specified, the feature can be installed on all systems (portable implementation)

###### Examples:

The following is an example of an installable runtime extension point:

       <extension
             point="org.eclipse.wst.server.core.installableRuntimes">
          <installableRuntime
                id="com.myruntime.id"
                featureVersion="1.0.0"
                featureId="com.myfeature"
                featureSite="xyz"
                bundleId="com.ibm.mybundle"
                path="/zips/myRuntime.zip"/>
       </extension>

The following is an example of using the installable runtime extension point but having the runtime archive as a data archive in the feature.

       <extension
             point="org.eclipse.wst.server.core.installableRuntimes">
          <installableRuntime
                id="com.myruntime.id"
                featureVersion="1.0.0"
                featureId="com.myfeature"
                featureSite="xyz"
                path="myRuntime-1.0.zip"/>
       </extension>

In the feature manifest and data entry should be entered for the runtime archive as well as an installhandler. The default install handler can be used which will install the data archive inside the feature. If the runtime archive is not packaged within the feature, then you need to map the archive path to a relative or absolute url to the site.xml

Copyright (c) 2005 IBM Corporation and others.
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 http://www.eclipse.org/legal/epl-v10.html