Jump to: navigation, search

Difference between revisions of "API catalog"

(Overview)
 
(32 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
=Overview=
 
=Overview=
  
This page enumerates the catalog of API that will be released in JSF 1.0 (WTP 2.0).  The API is broken into three categories: graduating, provisional and obsolete.  Graduating API is framework that was considered provisional in previous releases and is now ready to graduate into full API status.  Provisional (new) API is framework which has not been shipped in a release before and so has not had adopter soak time, but which is ready for wider adoption and refinement before being moved fully API.  Obsolete API is framework that has been replaced by new framework or is being deprecated out of existence.
+
This page enumerates the catalog of API that will be released in WTP 3.0.  The API is divided into four categories: full, graduating, provisional and obsolete.  Full API is framework that was declared as full API in a release prior to WTP 3.0.  Graduating API is framework that was considered provisional in previous releases (or was only added in the current release) and is now ready to graduate into full API status.  Provisional (new) API is framework has not had enough adopter soak time, but which is ready for wider adoption and refinement before being moved fully API.  Obsolete API is framework that has been replaced by new framework or is being deprecated out of existence.
  
==Graduating API==
+
==Full API==
  
 
The following lists the API that will graduate from provisional to full in Europa:
 
The following lists the API that will graduate from provisional to full in Europa:
Line 9: Line 9:
 
===Design-Time Type Utilities===
 
===Design-Time Type Utilities===
  
Plugin: org.eclipse.jst.jsf.common
+
'''Plugin:''' org.eclipse.jst.jsf.common
Packages: org.eclipse.jst.jsf.common.internal.provisional.util
+
 
Purpose: Provides utility classes for manipulating JDT IType's, primarily as Java Beans.
+
'''Packages:''' org.eclipse.jst.jsf.common.util
 +
 
 +
'''Purpose:''' Provides utility classes for manipulating JDT IType's, primarily as Java Beans.
  
 
=== Model Context Framework===
 
=== Model Context Framework===
  
Plugin: org.eclipse.jst.jsf.common
+
'''Plugin:''' org.eclipse.jst.jsf.common
Packages: org.eclipse.jst.jsf.common.context (all internal.provisional sub-packages except context.symbols)
+
Purpose: Provides a generic way to describe specific instance contexts within an arbitrary model and derive orthogonal information about that context through related resolvers (for example, your context is an absolute position in an XML file.  What project are you in?  What is your owning element).
+
  
===EL Symbol Framework===
+
'''Packages:''' org.eclipse.jst.jsf.common.context (all except context.symbols and internals)
  
Plugin: org.eclipse.jst.jsf.common
+
'''Purpose:''' Provides a generic way to describe specific instance contexts within an arbitrary model and derive orthogonal information about that context through related resolvers (for example, your context is an absolute position in an XML file.  What project are you in?  What is your owning element).
Packages: org.eclipse.jst.jsf.common.context
+
Purpose: Provides a framework through which to describe EL symbols (model objects, methods, functions, EL variables) at design time in order to analyze EL expression for such purposes as validation and content assist.
+
  
 
===Design-Time Application Framework===
 
===Design-Time Application Framework===
  
Plugin: org.eclipse.jst.jsf.core
+
'''Plugin:''' org.eclipse.jst.jsf.core
Packages: org.eclipse.jst.jsf.core.designtime.internal.provisional.*
+
 
Purpose: Simulates certain (currently mainly EL variable/property resolution) JSF runtime behaviours and provides extensibility for adopters to extend this simulation to places where they extend it at runtime (i.e. custom VariableResolver).
+
'''Packages:''' org.eclipse.jst.jsf.core.designtime.*
 +
 
 +
'''Purpose:''' Simulates certain (currently mainly EL variable/property resolution) JSF runtime behaviours and provides extensibility for adopters to extend this simulation to places where they extend it at runtime (i.e. custom VariableResolver).
 +
 
 +
===Application Configuration Resource File ("faces-config.xml") Model===
 +
 
 +
'''Plugin:''' org.eclipse.jst.jsf.facesconfig
 +
 
 +
'''Packages:''' org.eclipse.jst.jsf.facesconfig.* (except org.eclipse.jst.jsf.facesconfig.internal.*)
 +
 
 +
'''Purpose:''' Provides programmatic access and manipulation of the standard JSF application configuration resource file (e.g. "faces-config.xml").
 +
 
 +
==Graduating API==
  
 
==Provisional API==
 
==Provisional API==
Line 35: Line 45:
 
The following lists the API that will graduate from internal to provisional API in Europa:
 
The following lists the API that will graduate from internal to provisional API in Europa:
  
 +
===Content Model Type System===
 +
 +
'''Plugin:''' org.eclipse.jst.jsf.core
 +
 +
'''Packages:''' org.eclipse.jst.jsf.core.metadataprocessors.*, org.eclipse.jst.jsf.core.taglibprocessing.*
 +
 +
'''Purpose:''' An entensible system for define expected types and valid value ranges on JSF tag attributes for use in end-user features like content assist and validation.
 +
 +
'''Code tagged as provisional:''' [[Image:Questionmark.gif]]
 +
 +
===EL Symbol Framework===
 +
 +
'''Plugin:''' org.eclipse.jst.jsf.common
 +
 +
'''Packages:''' org.eclipse.jst.jsf.common.context
 +
 +
'''Purpose:''' Provides a framework through which to describe EL symbols (model objects, methods, functions, EL variables) at design time in order to analyze EL expression for such purposes as validation and content assist.
 +
 +
'''Code tagged as provisional:''' [[Image:Checkmark.gif]]
  
 
===Designtime Meta-data Framework===
 
===Designtime Meta-data Framework===
  
Plugin: org.eclipse.jst.jsf.common
+
'''Plugin:''' org.eclipse.jst.jsf.common
Packages: org.eclipse.jst.jsf.common.metadata.internal.provisional.*, org.eclipse.jst.jsf.common.metadata.traittypes.traittypes.internal.provisional.*
+
 
Purpose: Provides a rich, user-extensible repository for design-time metadata.
+
'''Packages:''' org.eclipse.jst.jsf.common.metadata.internal.provisional.*, org.eclipse.jst.jsf.common.metadata.traittypes.traittypes.internal.provisional.*
 +
 
 +
'''Purpose:''' Provides a rich, user-extensible repository for design-time metadata.
 
Obsoletes: Meta-data framework for 0.5 as well as Sybase contributed metadata for pagedesigner.
 
Obsoletes: Meta-data framework for 0.5 as well as Sybase contributed metadata for pagedesigner.
 +
 +
'''Code tagged as provisional:''' [[Image:Questionmark.gif]]
  
 
=== Tag Identification ===
 
=== Tag Identification ===
TODO
+
 
 +
'''Plugins:''' org.eclipse.jst.jsf.common (possibly org.eclipse.jst.jsf.core)
 +
 
 +
'''Packages:''' org.eclipse.jst.jsf.common.dom (and possibly parts of org.eclipse.jst.jsf.core.internal.tld)
 +
 
 +
'''Purpose:''' TODO
 +
 
 +
'''Code tagged as provisional:''' [[Image:Checkmark.gif]]
  
 
=== Axiomatic Sets ===
 
=== Axiomatic Sets ===
  
Plugins: org.eclipse.jst.jsf.common, org.eclipse.jst.jsf.core
+
'''Plugins:''' org.eclipse.jst.jsf.common, org.eclipse.jst.jsf.core
Packages: org.eclipse.jst.jsf.common.sets.internal.provisional.*, org.eclipse.jst.jsf.core.sets.internal.provisional.*
+
 
Purpose: Extends java.util.Set to provide sets of objects that support mathematically axiomatic operations like union and intersection as well as broader operations like mappings (functions) and constraints.  JSF Core implements JSF tag specific sets and operations.
+
'''Packages:''' org.eclipse.jst.jsf.common.sets.internal.provisional.*, org.eclipse.jst.jsf.core.sets.internal.provisional.*
 +
 
 +
'''Purpose:''' Extends java.util.Set to provide sets of objects that support mathematically axiomatic operations like union and intersection as well as broader operations like mappings (functions) and constraints.  JSF Core implements JSF tag specific sets and operations.
 +
 
 +
'''Code tagged as provisional:''' [[Image:Checkmark.gif]]
 +
 
 +
===Tag Conversion Framework===
 +
 
 +
'''Plugins:''' org.eclipse.jst.pagedesigner
 +
 
 +
'''Packages:''' org.eclipse.jst.pagedesigner.dtmanager, including all non-"internal" sub-packages
 +
 
 +
'''Purpose:''' Allows tag developers to contribute information to the Web Page Designer so that custom components can be rendered more faithfully on the design canvas.
 +
 
 +
'''Code tagged as provisional:''' [[Image:Checkmark.gif]]
 +
 
 +
===Element Edit Framework===
 +
 
 +
'''Plugins:''' org.eclipse.jst.jsf.pagedesigner
 +
 
 +
'''Packages:''' org.eclipse.jst.pagedesigner.elementedit (but not "html" and "jsp" sub-packages)
 +
 
 +
'''Purpose:''' Allows third-party tag contributors to add custom end-user behaviour (i.e. context menus) to Web Page Editor specific to their component's requires.
 +
 
 +
'''Code tagged as provisional:''' [[Image:Questionmark.gif]]
 +
 
 +
===JSF Library Registry===
 +
 
 +
'''Plugins:''' org.eclipse.jst.jsf.core
 +
 
 +
'''Packages:''' org.eclipse.jst.jsf.core.jsflibraryregistry
 +
 
 +
'''Purpose:''' Allows the JSFDeveloper to define named sets of jars on the class and deploy paths.  Also allows ToolsDeveloper and ComponentDeveloper to add plugin-contributed named sets of jars.
 +
 
 +
'''Code tagged as provisional:''' [[Image:Checkmark.gif]]
 +
 
 +
===JSF Library Configuration===
 +
 
 +
'''Plugins:''' org.eclipse.jst.jsf.core
 +
 
 +
'''Packages:''' org.eclipse.jst.jsf.core.jsflibraryconfiguration
 +
 
 +
'''Purpose:''' Allows the ToolsDeveloper to check for JSF Library references on a project.
 +
 
 +
'''Code tagged as provisional:''' [[Image:Questionmark.gif]]
 +
 
 +
===Application Configuration Manager ===
 +
 
 +
'''Plugin:''' org.eclipse.jst.jsf.core
 +
 
 +
'''Packages:''' org.eclipse.jst.jsf.core.jsfappconfig
 +
 
 +
'''Purpose:''' Aggregates all application configuration models that can be detected as being in the classpath at designtime to provide a unified view of how the a JSF project will be configured at runtime.
 +
 
 +
'''Code tagged as provisional:''' [[Image:Checkmark.gif]]
 +
 
 +
=== WPE Taglib Properties Viewers===
 +
 
 +
'''Plugin:''' org.eclipse.jst.jsf.pagedesigner
 +
 
 +
'''Packages:''' org.eclipse.jst.pagedesigner.editors.properties, org.eclipse.jst.pagedesigner.editors.properties.quickedittabsections
 +
 
 +
'''Purpose:''' Provides means of displaying tag attributes and their values in the Web Page Editor.
 +
 
 +
'''Code tagged as provisional:''' [[Image:Checkmark.gif]]
  
 
==Obsolete API ==
 
==Obsolete API ==
Line 56: Line 160:
 
===Content Model Annotations===
 
===Content Model Annotations===
  
Plugin: org.eclipse.jst.jsf.common
+
'''Plugin:''' org.eclipse.jst.jsf.common
Packages: org.eclipse.jst.jsf.common.annotation.internal.provisional.*
+
 
Purpose: Provides content model annotation meta-data.
+
'''Packages:''' org.eclipse.jst.jsf.common.annotation.internal.provisional.*
Migration: Use the new Meta-Data Framework.
+
 
 +
'''Purpose:''' Provides content model annotation meta-data.
 +
 
 +
'''Migration:''' Use the new Meta-Data Framework.
 +
 
 +
[[Category:Eclipse Web Tools Platform Project]]

Latest revision as of 17:44, 20 May 2008

Overview

This page enumerates the catalog of API that will be released in WTP 3.0. The API is divided into four categories: full, graduating, provisional and obsolete. Full API is framework that was declared as full API in a release prior to WTP 3.0. Graduating API is framework that was considered provisional in previous releases (or was only added in the current release) and is now ready to graduate into full API status. Provisional (new) API is framework has not had enough adopter soak time, but which is ready for wider adoption and refinement before being moved fully API. Obsolete API is framework that has been replaced by new framework or is being deprecated out of existence.

Full API

The following lists the API that will graduate from provisional to full in Europa:

Design-Time Type Utilities

Plugin: org.eclipse.jst.jsf.common

Packages: org.eclipse.jst.jsf.common.util

Purpose: Provides utility classes for manipulating JDT IType's, primarily as Java Beans.

Model Context Framework

Plugin: org.eclipse.jst.jsf.common

Packages: org.eclipse.jst.jsf.common.context (all except context.symbols and internals)

Purpose: Provides a generic way to describe specific instance contexts within an arbitrary model and derive orthogonal information about that context through related resolvers (for example, your context is an absolute position in an XML file. What project are you in? What is your owning element).

Design-Time Application Framework

Plugin: org.eclipse.jst.jsf.core

Packages: org.eclipse.jst.jsf.core.designtime.*

Purpose: Simulates certain (currently mainly EL variable/property resolution) JSF runtime behaviours and provides extensibility for adopters to extend this simulation to places where they extend it at runtime (i.e. custom VariableResolver).

Application Configuration Resource File ("faces-config.xml") Model

Plugin: org.eclipse.jst.jsf.facesconfig

Packages: org.eclipse.jst.jsf.facesconfig.* (except org.eclipse.jst.jsf.facesconfig.internal.*)

Purpose: Provides programmatic access and manipulation of the standard JSF application configuration resource file (e.g. "faces-config.xml").

Graduating API

Provisional API

The following lists the API that will graduate from internal to provisional API in Europa:

Content Model Type System

Plugin: org.eclipse.jst.jsf.core

Packages: org.eclipse.jst.jsf.core.metadataprocessors.*, org.eclipse.jst.jsf.core.taglibprocessing.*

Purpose: An entensible system for define expected types and valid value ranges on JSF tag attributes for use in end-user features like content assist and validation.

Code tagged as provisional: Questionmark.gif

EL Symbol Framework

Plugin: org.eclipse.jst.jsf.common

Packages: org.eclipse.jst.jsf.common.context

Purpose: Provides a framework through which to describe EL symbols (model objects, methods, functions, EL variables) at design time in order to analyze EL expression for such purposes as validation and content assist.

Code tagged as provisional: Checkmark.gif

Designtime Meta-data Framework

Plugin: org.eclipse.jst.jsf.common

Packages: org.eclipse.jst.jsf.common.metadata.internal.provisional.*, org.eclipse.jst.jsf.common.metadata.traittypes.traittypes.internal.provisional.*

Purpose: Provides a rich, user-extensible repository for design-time metadata. Obsoletes: Meta-data framework for 0.5 as well as Sybase contributed metadata for pagedesigner.

Code tagged as provisional: Questionmark.gif

Tag Identification

Plugins: org.eclipse.jst.jsf.common (possibly org.eclipse.jst.jsf.core)

Packages: org.eclipse.jst.jsf.common.dom (and possibly parts of org.eclipse.jst.jsf.core.internal.tld)

Purpose: TODO

Code tagged as provisional: Checkmark.gif

Axiomatic Sets

Plugins: org.eclipse.jst.jsf.common, org.eclipse.jst.jsf.core

Packages: org.eclipse.jst.jsf.common.sets.internal.provisional.*, org.eclipse.jst.jsf.core.sets.internal.provisional.*

Purpose: Extends java.util.Set to provide sets of objects that support mathematically axiomatic operations like union and intersection as well as broader operations like mappings (functions) and constraints. JSF Core implements JSF tag specific sets and operations.

Code tagged as provisional: Checkmark.gif

Tag Conversion Framework

Plugins: org.eclipse.jst.pagedesigner

Packages: org.eclipse.jst.pagedesigner.dtmanager, including all non-"internal" sub-packages

Purpose: Allows tag developers to contribute information to the Web Page Designer so that custom components can be rendered more faithfully on the design canvas.

Code tagged as provisional: Checkmark.gif

Element Edit Framework

Plugins: org.eclipse.jst.jsf.pagedesigner

Packages: org.eclipse.jst.pagedesigner.elementedit (but not "html" and "jsp" sub-packages)

Purpose: Allows third-party tag contributors to add custom end-user behaviour (i.e. context menus) to Web Page Editor specific to their component's requires.

Code tagged as provisional: Questionmark.gif

JSF Library Registry

Plugins: org.eclipse.jst.jsf.core

Packages: org.eclipse.jst.jsf.core.jsflibraryregistry

Purpose: Allows the JSFDeveloper to define named sets of jars on the class and deploy paths. Also allows ToolsDeveloper and ComponentDeveloper to add plugin-contributed named sets of jars.

Code tagged as provisional: Checkmark.gif

JSF Library Configuration

Plugins: org.eclipse.jst.jsf.core

Packages: org.eclipse.jst.jsf.core.jsflibraryconfiguration

Purpose: Allows the ToolsDeveloper to check for JSF Library references on a project.

Code tagged as provisional: Questionmark.gif

Application Configuration Manager

Plugin: org.eclipse.jst.jsf.core

Packages: org.eclipse.jst.jsf.core.jsfappconfig

Purpose: Aggregates all application configuration models that can be detected as being in the classpath at designtime to provide a unified view of how the a JSF project will be configured at runtime.

Code tagged as provisional: Checkmark.gif

WPE Taglib Properties Viewers

Plugin: org.eclipse.jst.jsf.pagedesigner

Packages: org.eclipse.jst.pagedesigner.editors.properties, org.eclipse.jst.pagedesigner.editors.properties.quickedittabsections

Purpose: Provides means of displaying tag attributes and their values in the Web Page Editor.

Code tagged as provisional: Checkmark.gif

Obsolete API

Content Model Annotations

Plugin: org.eclipse.jst.jsf.common

Packages: org.eclipse.jst.jsf.common.annotation.internal.provisional.*

Purpose: Provides content model annotation meta-data.

Migration: Use the new Meta-Data Framework.