OSGi Frameworks

Identifier:

Since:

This extension point was moved from org.eclipse.pde.ui to org.eclipse.pde.launching in 3.6. However, its qualified name and visibility remains the same.

Description:

This extension point is used to register new OSGi frameworks. Each framework is associated with a launcher delegate that is called when the OSGi framework is selected in the OSGi Framework launch configuration.

Registered OSGi frameworks appear on the Plug-in Development > OSGi frameworks preference page, where a default framework can be set.

Configuration Markup:

<!ELEMENT extension (framework+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

<!ELEMENT framework EMPTY>

<!ATTLIST framework

id               CDATA #REQUIRED

name             CDATA #REQUIRED

launcherDelegate CDATA #REQUIRED

initializer      CDATA #IMPLIED>

• id - a unique identifier of the framework
• name - human-readable name of the OSGi framework
• launcherDelegate - a launch configuration delegate to launch the OSGi framework. The value of this attribute is the fully qualified name of the Java class that extends org.eclipse.pde.launching.AbstractPDELaunchConfiguration.
• initializer - initializes new OSGi Framework launch configurations with suitable defaults. The value of this attribute must be a fully-qualified name of a Java class that extends the default implementation org.eclipse.pde.launching.OSGiLaunchConfigurationInitializer. If not specified, the default initializer org.eclipse.pde.launching.OSGiLaunchConfigurationInitializer is instantiated.

Examples:

The following is an example of the extension point:

   <extension
         point="org.eclipse.pde.launching.osgiFrameworks">
      <framework
            launcherDelegate="org.eclipse.pde.launching.EquinoxLaunchConfiguration"
            id="org.eclipse.pde.ui.EquinoxFramework"
            name="%Equinox.shortcut.label" 
            initializer="org.eclipse.pde.internal.launching.launcher.EquinoxInitializer"/>
   </extension>

API Information:

The value of the attribute launcherDelegate must be a fully qualified name of a Java class that extends org.eclipse.pde.launching.AbstractPDELaunchConfiguration. If the launcher is to provide its own source lookup order, then the method setDefaultSourceLocator should be overridden.

The value of the attribute initializer must be a fully qualified name of a Java class that extends org.eclipse.pde.launching.OSGiLaunchConfigurationInitializer.

Supplied Implementation:

PDE supplies the Equinox OSGi Framework extension to launch Equinox frameworks.

Copyright (c) 2006, 2010 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0.