Deprecated API removals

Often there is no sufficiently compelling reason to ever remove deprecated API, so the API may remain in place indefinitely after the release in which it was deprecated. However, there are situations where continuing to maintain the deprecated API creates too high a burden for both API developers and clients: the code bloat of keeping old implementations, the added complexity of multiple redundant APIs, etc. For this reason the Eclipse project has a policy to occasionally delete deprecated API after providing two years advance notice to clients. This section describes API removals that occurred in this release, and upcoming removals in future releases.

API removals in the Kepler (4.3) release:

  1. luceneSearchParticipants

API removals after June 2013:

  1. WorkspaceLock
  2. IncrementalProjectBuilder#getRule()

API removals after June 2014:

  1. Workbench presentation API
  2. Eclipse 2.0 runtime model and boot API
  3. Platform authorization API
  4. Composite Bundles
  5. Batch Bundle Event

API removals in this release

1. luceneSearchParticipants

The extension point org.eclipse.help.base.luceneSearchParticipants used API classes which exposed classes from Apache Lucene in their method parameters. This means that clients would be impacted with at least binary incompatibility if the Eclipse Help system switched from Lucene 1.x to 2.x or 3.x and has caused the help system to stay on an old version of Lucene. In the 3.6 release this extension point and the classes it requires were deprecated. The replacement extension point org.eclipse.help.base.searchParticipant should be used instead. The specific API being removed includes:

For further details or to provide feedback on this change, see bug 311931.

API removals after June 2013

1. WorkspaceLock

The WorkspaceLock API allowed a special client (usually platform UI) to hook into the locking protocols used by the workspace implementation. This hook was used to mitigate deadlocks due to interaction with synchronous SWT events, and was never intended to be used by other clients. In the 3.0 release this API was deprecated in favor of a more general API provided by the org.eclipse.core.jobs bundle. Invoking this API has had no effect since the 3.0 release. The specific API to be removed includes:

For further details or to provide feedback on this change, see bug 311240.

2. IncrementalProjectBuilder#getRule()

The IncrementalProjectBuilder#getRule() method returned a scheduling rule that was required for building the project by the builder. This method was intended to be used by the builder framework only. In the 3.6 release this method was deprecated in favor of a more general method IncrementalProjectBuilder#getRule(int, Map). The specific API to be removed includes:

For further details or to provide feedback on this change, see bug 310072.

API removals after June 2014

1. Workbench presentation API

The workbench presentation API allowed plug-ins to override certain aspects of the workbench appearance, such as the shape of view and editor tabs. This mechanism is fundamentally incompatible with the pluggable rendering and declarative styling systems in Eclipse 4.2, which offer applications complete control over all aspects of the workbench layout and style. The following API will be removed:

For further details or to provide feedback on this change, see bug 370248.

2. Eclipse 2.0 runtime model and boot API

When the Eclipse runtime transitioned to use OSGi as its implementation, some existing APIs for interacting with the old runtime were deprecated and moved to a compatibility fragment (org.eclipse.core.runtime.compatibility). All API that was still valid was moved elsewhere. These APIs have been non-functional since Eclipse 3.0 and will therefore be removed in the future. The following packages will be removed:

The compatibility fragment, org.eclipse.core.runtime.compatibility will also be removed.

For further details or to provide feedback on this change, see bug 370248.

3. Platform authorization API

Since Eclipse 1.0, the Eclipse Platform class provided API for storing and retrieving passwords in a keyring file. This API used an inherently insecure method for encrypting credentials, and used a custom encryption algorithm that made it difficult for some consumers to distribute and export Eclipse-based products. For these and other reasons, this API was deprecated and replaced in Eclipse 3.4 with a new Equinox secure storage API. In Eclipse 4.2 the implementation of the old authorization methods was removed, but the API left in place. This old API will be removed completely in a future release. The following API methods will be removed from org.eclipse.core.runtime.Platform:

For further details or to provide feedback on this change, see bug 370248.

4. Composite Bundles

In the Equinox 3.5 release an implementation of an OSGi provisional API was included for composite bundles. This API includes all classes from the org.osgi.service.framework package. This provisional OSGi API has never been considered API by Equinox and as such has always been marked as x-internal.

The OSGi Alliance has decided to reject this provisional API. It will never become a part of the official OSGi specification. Any users of the org.osgi.service.framework composite bundle API must migrate to using framework hooks to provide additional isolation within a single OSGi framework. See the sub-packages of org.osgi.framework.hooks for ways to control visibility and isolation for resolution, bundles and services. Equinox plans to remove the org.osgi.service.framework API and composite bundle implementation in the Summer of 2012 (after the 3.8 release).

Equinox also has a region digraph implementation that allows for the definition and configuration of regions that can be used to isolate bundles. The region digraph is built on top of the standard OSGi framework hooks. The specific API to be removed includes:

For further details or to provide feedback on this change, see bug 345790.

5. Batch Bundle Event

Since Eclipse 3.1, the Equinox Framework has provided API to allow bundle listeners to batch bundle events. This functionality never has been standardized with OSGi and the approach as several drawbacks that make the API difficult to use. For these and other reasons the API package org.eclipse.osgi.event will be removed.

For further details or to provide feedback on this change, see bug 407302.