Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Stardust/Knowledge Base/API/API Policy"
(→Stardust API Policy) |
|||
| Line 1: | Line 1: | ||
| − | = | + | = Introduction and Goal = |
| − | Project | + | Project Stardust exposes several Java interfaces to interact with teh system or customize its behaviour by implementing service provider interfaces (SPIs) or Extension Points. |
| − | Goal of this document is to define which interfaces are official contracts that will be kept stable and only changed after deprecation and which are not. | + | Goal of this document is to define which interfaces are official contracts that will be kept stable and only changed after deprecation and which are not. |
= Java API as Documented in Javadoc = | = Java API as Documented in Javadoc = | ||
Revision as of 09:37, 24 May 2013
Contents
Introduction and Goal
Project Stardust exposes several Java interfaces to interact with teh system or customize its behaviour by implementing service provider interfaces (SPIs) or Extension Points.
Goal of this document is to define which interfaces are official contracts that will be kept stable and only changed after deprecation and which are not.
Java API as Documented in Javadoc
All Java interfaces of the Stardust runtime and portals are listed in the Stardust API Documentation.
These interfaces and classes will not be removed or modified in any non backward-compatible way without prior deprecation. Semantics of method invocation will not be changed with the exception of fixing icorrect functionality if necessary.
Web Service API as Documented in Product Documentation
All Java interfaces of the Stardust runtime and portals are listed in the Stardust Web Service API Documentation.
These interfaces will not be removed or modified in any non backward-compatible way without prior deprecation. Invocation semantics will not be changed with the exception of fixing icorrect functionality if necessary.
Eclipse Extension Points
Some Stardsut eclipse plugins expose extension points that can be implemented in order to customize plugin behaviour. These interfaces will not be removed or modified in any non backward-compatible way without prior deprecation. Invocation semantics will not be changed with the exception of fixing icorrect functionality.
Other Classes and Interfaces
All other classes and interfaces are purely internal and subject to change at any time. Do not make any assumption on presence of any of these classes or their behaviour. Please contact us via the channels specified in http://wiki.eclipse.org/Stardust or open a Bugzilla ticket if you feel you need to rely on any internal classes to achieve your goal. We will review the request and try to find a stable and reliable solution.