Difference between revisions of "PDE/API Tools/Architecture"

From Eclipsepedia

< PDE‎ | API Tools
Jump to: navigation, search
(New page: == Goals == API tooling will assist developers in API maintenance by reporting API defects such as binary incompatibilities, incorrect plug-in version numbers, missing or incorrect @since...)
 
(Architecture)
Line 15: Line 15:
  
 
== Architecture ==
 
== Architecture ==
 +
 +
Similar to the way we develop and ship plug-ins (bundles), we want to be able to develop and ship API information. This information can then be used by the integrated API tooling or by the build process to report API defects. The developers of a plug-in will be responsible for maintaining associated API information. API tooling models APIs using the following abstractions.
 +
 +
* '''''API Component''''' - Describes the API of a software component. In our case a software component is a plug-in or bundle but the concept could be extended to other constructs such as a Java project. An API component has the following attributes:
 +
** '''Symbolic Name''' - For example, plug-in identifier.
 +
** '''Descriptive Name''' - A human readable name such as "Platform UI".
 +
** '''Version''' - Identifies the version of the component. For example, "3.3.0".
 +
** '''Class Files''' - Original class files (jars, folders, etc), or class file stubs (compressed version with same information).
 +
** '''Required Execution Environment''' - Defines the execution environment required by the component for building and running. Execution environments are defined by standard OSGi profiles such as J2SE-1.4, CDC-1.1/Foundation-1.1, etc.
 +
** '''Required API Components''' - Defines all components required by a component in terms of symbolic names and compatible version ranges.
 +
** '''API Description''' - Defines visibility of elements within the component as API, SPI, private, or private permissable. Defines restrictions of elements within the component as not to be subclassed, instantiated, implemented or referenced.
 +
 +
 +
* '''''API Profile''''' - A collection of related API components that can be compared with another profile. For example, all of the API components of the plug-ins in an Eclipse SDK. An API profile has the following attributes:
 +
** '''API Components''' - The components contained in the profile.
 +
** '''Execution Environment''' - The execution environment required by the profile for building and running.
 +
** '''Symbolic Name''' - For example, "eclipse.sdk"
 +
** '''Descriptive Name''' - For example, "Eurpoa"
 +
** '''Version''' - For example, "3.3.0"
 +
 +
API tooling provides the following engines, analyzers, and tools that operate on the API components.
 +
 +
* '''Converter''' - Generates class file stubs from original class files. The stubs contain all member signature information and may optionally contain all original reference and line information. Stubs are typically smaller than original class files intended to reduce download and analysis time.
 +
* '''Reference Scanner''' - Scans a class file compiling all references a class file makes to other class files.
 +
* '''Delta Engine''' - Compares two versions of the same class file building a hierarchical delta of the differences between to the two files.
 +
* '''Javadoc Scanner''' - Scans Java source for special javadoc restriction tags to annotate a component's API decription.

Revision as of 16:25, 26 October 2007

Goals

API tooling will assist developers in API maintenance by reporting API defects such as binary incompatibilities, incorrect plug-in version numbers, missing or incorrect @since tags, and usage of non-API code between plug-ins. The tooling will be integrated in the Eclipse SDK and will be used in the automated build process. Specifically, the tooling is designed to do the following:

  • Identify binary compatibility issues between two versions of a software component or product.
  • Update version numbers for plug-ins (bundles) based on the Eclipse versioning scheme.
  • Update @since tags for newly added classes, interfaces, methods, etc.
  • Provide new javadoc tags and code assist to annotate types with special restrictions:
    • @nosubclass - This class is not intended to be subclassed.
    • @noinstantiate - This class is not intended to be instantiated.
    • @noimplement - This interface is not intended to be implemented by clients.
    • @noreference - This type is not intended to be referenced by clients.
  • Leverage existing information (in MANIFEST.MF) to define the visibility of packages between bundles.
  • Identify usage of non-API code between plug-ins.

Architecture

Similar to the way we develop and ship plug-ins (bundles), we want to be able to develop and ship API information. This information can then be used by the integrated API tooling or by the build process to report API defects. The developers of a plug-in will be responsible for maintaining associated API information. API tooling models APIs using the following abstractions.

  • API Component - Describes the API of a software component. In our case a software component is a plug-in or bundle but the concept could be extended to other constructs such as a Java project. An API component has the following attributes:
    • Symbolic Name - For example, plug-in identifier.
    • Descriptive Name - A human readable name such as "Platform UI".
    • Version - Identifies the version of the component. For example, "3.3.0".
    • Class Files - Original class files (jars, folders, etc), or class file stubs (compressed version with same information).
    • Required Execution Environment - Defines the execution environment required by the component for building and running. Execution environments are defined by standard OSGi profiles such as J2SE-1.4, CDC-1.1/Foundation-1.1, etc.
    • Required API Components - Defines all components required by a component in terms of symbolic names and compatible version ranges.
    • API Description - Defines visibility of elements within the component as API, SPI, private, or private permissable. Defines restrictions of elements within the component as not to be subclassed, instantiated, implemented or referenced.


  • API Profile - A collection of related API components that can be compared with another profile. For example, all of the API components of the plug-ins in an Eclipse SDK. An API profile has the following attributes:
    • API Components - The components contained in the profile.
    • Execution Environment - The execution environment required by the profile for building and running.
    • Symbolic Name - For example, "eclipse.sdk"
    • Descriptive Name - For example, "Eurpoa"
    • Version - For example, "3.3.0"

API tooling provides the following engines, analyzers, and tools that operate on the API components.

  • Converter - Generates class file stubs from original class files. The stubs contain all member signature information and may optionally contain all original reference and line information. Stubs are typically smaller than original class files intended to reduce download and analysis time.
  • Reference Scanner - Scans a class file compiling all references a class file makes to other class files.
  • Delta Engine - Compares two versions of the same class file building a hierarchical delta of the differences between to the two files.
  • Javadoc Scanner - Scans Java source for special javadoc restriction tags to annotate a component's API decription.