Skip to content

Commit

Permalink
Link to latest OSGi releases javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
akurtakov committed Oct 7, 2024
1 parent f43479a commit f58b66b
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion eclipse-platform-parent/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,7 @@
<use>true</use>
<links>
<link>https://docs.osgi.org/javadoc/osgi.core/8.0.0/</link>
<link>https://docs.osgi.org/javadoc/osgi.cmpn/8.0.0/</link>
<link>https://docs.osgi.org/javadoc/osgi.cmpn/8.1.0/</link>
<link>https://docs.osgi.org/javadoc/osgi.enterprise/7.0.0/</link>
</links>
<tags>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ <H1>
Http Service and JSP support</H1>
<p>
Equinox provides support for building and running OSGi based web applications both inside RCP and application server environments. In an OSGi web application use
of the <a href="https://docs.osgi.org/javadoc/osgi.cmpn/7.0.0/org/osgi/service/http/HttpService.html">OSGi Http Service</a> replaces the use of web.xml deployment file. The Http Service provides a means to register servlets and resources in a manner
of the <a href="https://docs.osgi.org/javadoc/osgi.cmpn/8.0.0/org/osgi/service/http/HttpService.html">OSGi Http Service</a> replaces the use of web.xml deployment file. The Http Service provides a means to register servlets and resources in a manner
more consistent with the dynamic environment in Eclipse where bundles can come and go.
</p>
<p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ <H2>
<p> If your plug-in has a dependency on the <b>org.eclipse.core.runtime</b> bundle, then it will continue to
run unchanged. However, if you would like to minimize the number of dependencies, then you are able to
pick only the runtime bundles that you use. Dependencies on the runtime bundles may be declared using
either the <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Constants.html#IMPORT_PACKAGE">Import-Package</a>
or <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Constants.html#REQUIRE_BUNDLE">Require-Bundle</a></p>
either the <a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/Constants.html#IMPORT_PACKAGE">Import-Package</a>
or <a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/Constants.html#REQUIRE_BUNDLE">Require-Bundle</a></p>
<p> If you would like to use Import-Package header (rather than Require-Bundle) then you should be
aware that the <b><a href="../reference/api/org/eclipse/core/runtime/package-summary.html">org.eclipse.core.runtime</a></b>
package is split across several bundles. The bundles that export a portion of the split package <b>org.eclipse.core.runtime</b>
use a <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Constants.html#MANDATORY_DIRECTIVE">mandatory</a>
use a <a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/Constants.html#MANDATORY_DIRECTIVE">mandatory</a>
directive. The <b>mandatory</b> directive requires importers to specify additional matching attributes in order to
successfully wire to the exported package.</p>
<p>For example, to import only the content of the package provided by
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h4>Plugin</h4>
is running in the platform. It is a convenient place to centralize the life-cycle aspects and overall
semantics of a plug-in. A plug-in can implement specialized functionality for the <b>start</b> and <b>stop</b>
aspects of its life-cycle. Each life-cycle method includes a reference to a
<b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html">BundleContext</a></b> which can supply
<b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/BundleContext.html">BundleContext</a></b> which can supply
additional information.</p>
<p>
The <b>start</b> portion of the life-cycle is worth particular discussion. We've seen already that information
Expand Down Expand Up @@ -55,45 +55,45 @@ <h4>Plugin</h4>
<h4>Bundle Context</h4>
<p>
Life-cycle management is where the OSGi &quot;bundle&quot; terminology and the platform's
&quot;plug-in&quot; terminology meet. When your plug-in is started, it is given a reference to a <b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html">
&quot;plug-in&quot; terminology meet. When your plug-in is started, it is given a reference to a <b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/BundleContext.html">
BundleContext</a></b> from which it can obtain information related to the plug-in. The
<b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html">BundleContext</a></b>
<b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/BundleContext.html">BundleContext</a></b>
can also be used to find out about other bundles/plug-ins in the system.
</p>
<p>
<b>BundleContext.getBundles()</b> can be used to obtain an array of all bundles in the system. Listeners for
<b>BundleEvent</b> can be registered so that your plug-in is aware when another bundle has a change
in its life-cycle status. See the javadoc for
<b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html">BundleContext</a></b> and
<b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleEvent.html">BundleEvent</a></b> for more information.
<b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/BundleContext.html">BundleContext</a></b> and
<b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/BundleEvent.html">BundleEvent</a></b> for more information.
</p>
<blockquote><i>
Prior to 3.0, a plug-in registry (<b>IPluginRegistry</b>) was provided to supply similar information. For example,
it could be queried for the plug-in descriptors of all plug-ins in the system. This registry is now deprecated and
<b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleContext.html">BundleContext</a></b> should be
<b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/BundleContext.html">BundleContext</a></b> should be
used for this purpose. The platform registry is now used exclusively for information about extensions
and extension points.
</i></blockquote>
<h4>Bundle Activator</h4>
<p>
The <b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleActivator.html">BundleActivator</a></b> interface defines
The <b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/BundleActivator.html">BundleActivator</a></b> interface defines
the start and stop behavior implemented in
<b><a href="../reference/api/org/eclipse/core/runtime/Plugin.html">Plugin</a></b>. Although the
<b><a href="../reference/api/org/eclipse/core/runtime/Plugin.html">Plugin</a></b> class is a convenient place
to implement this function, a plug-in developer has complete freedom to implement the interface for
<b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleActivator.html">BundleActivator</a></b> in any class
<b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/BundleActivator.html">BundleActivator</a></b> in any class
appropriate for the plug-in's design. In fact, your plug-in need not implement this interface at all if it
does not have specific life-cycle management needs. </p>
<h4>Bundles</h4>
<p>
Underneath every plug-in lies an OSGi bundle managed by the framework.
The <b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Bundle.html">Bundle</a></b> is the OSGi unit of modularity. Fundamentally, a
The <b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/Bundle.html">Bundle</a></b> is the OSGi unit of modularity. Fundamentally, a
bundle is just a collection of files (resources and code) installed in the
platform. Each bundle has its own Java
class loader, and includes protocol for starting, stopping, and uninstalling itself. From the Eclipse platform
point of view, <b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Bundle.html">Bundle</a></b> is merely an implementation
point of view, <b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/Bundle.html">Bundle</a></b> is merely an implementation
class. Plug-in developers do not extend the bundle class, but use <b><a href="../reference/api/org/eclipse/core/runtime/Plugin.html">Plugin</a></b>
or other <b><a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/BundleActivator.html">BundleActivator</a></b> implementations
or other <b><a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/BundleActivator.html">BundleActivator</a></b> implementations
to represent the plug-in.</p>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <H2>Secure Storage Architecture</H2>
and a keyring.</p>

<p>The front end is modeled in a fashion very similar to the
<a href="https://docs.osgi.org/javadoc/osgi.cmpn/7.0.0/org/osgi/service/prefs/Preferences.html" title="Preferences specification in org.osgi.service.prefs"><b>OSGi Preferences Service specification</b></a>.
<a href="https://docs.osgi.org/javadoc/osgi.cmpn/8.1.0/org/osgi/service/prefs/Preferences.html" title="Preferences specification in org.osgi.service.prefs"><b>OSGi Preferences Service specification</b></a>.
Secure storage is represented as a tree of nodes. Nodes provide context. For instance, a bundle
<i>&quot;com.abc&quot;</i> could use the node <i>&quot;abc&quot;</i> under the node <i>&quot;com&quot;</i> under
the root node. As in Preference's, the path to such node can be described as <i>&quot;/com/abc&quot;</i>.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h4>Central Classes and Interfaces</h4>
the behavior of this instance of secure storage.</p>

<p>The restrictions put on the node names are similar to the
<a href="https://docs.osgi.org/javadoc/osgi.cmpn/7.0.0/org/osgi/service/prefs/Preferences.html" title="Preferences specification in org.osgi.service.prefs"><b>OSGi Preferences</b></a>:
<a href="https://docs.osgi.org/javadoc/osgi.cmpn/8.1.0/org/osgi/service/prefs/Preferences.html" title="Preferences specification in org.osgi.service.prefs"><b>OSGi Preferences</b></a>:
no double forward slashes, no trailing forward slash. In addition, node names can only contain printable ASCII characters.
If you need to use a string that does not fit those restrictions, the
<a href="../reference/api/org/eclipse/equinox/security/storage/EncodingUtils.html">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ <h3>Property Testers Provided in the Workbench</h3>
</td>
<td colspan="2">

<p>Test the state of the bundle in the running environment. Use the 'args' attribute to pass in the bundle ID and the 'value' attribute to pass the state as defined in <a href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/org/osgi/framework/Bundle.html">Bundle</a>, e.g. "ACTIVE".
<p>Test the state of the bundle in the running environment. Use the 'args' attribute to pass in the bundle ID and the 'value' attribute to pass the state as defined in <a href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/org/osgi/framework/Bundle.html">Bundle</a>, e.g. "ACTIVE".
</p>
</td>
</tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -529,9 +529,9 @@

<topic label="OSGi Services Reference" href="reference/services/index.html"/>

<topic label="OSGi R7 Core API Reference" href="https://docs.osgi.org/javadoc/osgi.core/7.0.0/"/>
<topic label="OSGi R7 Compendium API Reference" href="https://docs.osgi.org/javadoc/osgi.cmpn/7.0.0/"/>
<topic label="OSGi R7 Enterprise API Reference" href="https://docs.osgi.org/javadoc/osgi.enterprise/7.0.0/"/>
<topic label="OSGi Core API Reference" href="https://docs.osgi.org/javadoc/osgi.core/8.0.0/"/>
<topic label="OSGi Compendium API Reference" href="https://docs.osgi.org/javadoc/osgi.cmpn/8.1.0/"/>
<topic label="OSGi Enterprise API Reference" href="https://docs.osgi.org/javadoc/osgi.enterprise/7.0.0/"/>

<topic label="Other reference information" href="reference/misc/index.html">
<topic label="Runtime options" href="reference/misc/runtime-options.html"/>
Expand Down

0 comments on commit f58b66b

Please sign in to comment.