Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
COSMOS API Cleanup
Contents
COSMOS API Cleanup - Housecleaning
This wiki page was constructed in response to https://bugs.eclipse.org/bugs/show_bug.cgi?id=218558. In preparation for releasing COSMOS 1.0, committers are required to ensure API guidelines are met. In COSMOS there are three types of APIs:
- Internal - Indicated by having a package name that contains the keyword 'internal' (e.g. org.eclipse.cosmos.dc.cmdbf.services.internal)
- Provisional - Indicated by having the annotation '@provisional' included in the class comment
- Public - Any API that does not fall under (1) or (2)
COSMOS 1.0 does not plan to release any public APIs. All classes are expected to fall under (1) or (2). Provisional classes MUST be thoroughly commented. A recent (April 4th, 2008) manual code scan revealed the following plug-ins to be in violation of the guideline. Package/classes expected to be provisional are indicated by orange and expected internal APIs are indicated by red. The final verdict of what should be internal or provisional is made by the component owner.
Data Collection
Violating Plug-ins | Packages/Classes | Assignee | Complete |
---|---|---|---|
org.eclipse.cosmos.common |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.birt.helper |
|
Sheldon Lee-Loy | No |
org.eclipse.cosmos.dc.broker |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.broker.client |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.common |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.dataManager |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.dataManager.client |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.dataManager.common |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.local.domain |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.local.registry |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.logging.datamgr (Is this necessary?) |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.logging.datamgr.client |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.logging.datamgr.common |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.logging.datamgr.web |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.management.domain |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.management.domain.client |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.mdr |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.mdr.client |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.mdr.common |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.mgmt.common (Is this necessary?) |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.mgmt.wsdm (Is this necessary?) |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.remote.wsdm (Is this necessary?) |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.sample.components |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.sample.configurations (Is this necessary?) |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.sample.jpa (Is this necessary?) |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.spec |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.stat.datamgr (Is this necessary?) |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.stat.datamgr.client |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.stat.datamgr.common |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.stat.datamgr.web |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.tptp.agentcontroller |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.tptp.gla.components |
|
Hubert Leung | No |
org.eclipse.cosmos.example.mdr.web |
|
Hubert Leung | No |
Note: Remove any bundles and code related to:
- DC assemblies
- The old annotations
Data Visualization
Violating Plug-ins | Packages/Classes | Assignee | Complete |
---|---|---|---|
org.eclipse.cosmos.dr.drs.service.handler |
|
Sheldon Lee-Loy | No |
org.eclipse.cosmos.dr.ps.common |
|
Sheldon Lee-Loy | No |
Note: The DV bundles are split between the data reporting and the examples/end2end directories. We need to move all required COSMOS bundles from the 'examples' module to 'data-reporting'
Management Enablement
Violating Plug-ins | Packages/Classes | Assignee | Complete |
---|---|---|---|
org.eclipse.cosmos.me.dmtoolkit.common |
|
David Whiteman | No |
org.eclipse.cosmos.me.dmtoolkit.j2ee |
|
David Whiteman | No |
org.eclipse.cosmos.me.management.common |
|
Joel Hawkins | No |
org.eclipse.cosmos.me.management.wsdm |
|
Joel Hawkins | No |
Resource Modeling
Violating Plug-ins | Packages/Classes | Assignee | Complete |
---|---|---|---|
org.eclipse.cosmos.rm.sml.mdr (Is this necessary?) |
|
Hubert Leung | No |
org.eclipse.cosmos.rm.sml.mdr.web |
|
Hubert Leung | No |
Open Questions/Concerns
Harm Sluiman:
It seems the package provisional idea is being skipped and that is the most common form of provisional in Eclipse. Note TPTP introduced the concept of javadoc provisional only as a transient state where api was stable but behavior was not and testing or documentation was not complete. If you only have one provisional state, I strongly suggest you use the package variant.
Will be discussed in the next architecture call
Ruth Lee
- Ali, can we look into Bill's bugzilla for this as well? He talks about deprecating any bundles and code that are no longer used, so we should identify those and delete them rather than comment them. 220776
- Question: Looks like COSMOS does not use experimental APIs in COSMOS. What are the COSMOS guidelines for using provisional vs experimental? Eclipse Quality Guidelines
Regarding bug 220776:
>1. Deprecate any bundles and code that are no longer used.
> a. DC assemblies
> b. the "old" annotations
Addressed
>2. Re-organize the directory structure to group logically related bundles together
> a. The Example MDR bundle for OSGI is in the Examples directory but the Example MDR for the web is in the DC directory. They should reside together.
Addressed
> b. All data managers should be grouped into a single directory.
Needs more discussion
> c. The BIRT helper bundle belongs in the data reporting (not in DC)
Addressed
> d. All the CMDBf components (CMDBf services, tooling, registration example, and the MDRs) belong in the same directory
Needs more discussion
> e. The DV bundles are split between the data reporting and the examples/end2end directories
Addressed
> f. We have a common tests directory with subdirectories for each subproject. Should we move each of these subdirectories into a tests directory under their respective subprojects?
Needs more discussion