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.
Difference between revisions of "COSMOS API Cleanup"
(→COSMOS API Cleanup - Housecleaning) |
|||
Line 185: | Line 185: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.dataManager<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.dataManager<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 198: | Line 198: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.dataManager.client<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.dataManager.client<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 214: | Line 214: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.dataManager.common<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.dataManager.common<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 240: | Line 240: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.local.domain<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.local.domain<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 252: | Line 252: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.local.registry<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.local.registry<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 264: | Line 264: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.logging.datamgr<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.logging.datamgr<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 276: | Line 276: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.logging.datamgr.client<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.logging.datamgr.client<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 289: | Line 289: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.logging.datamgr.common<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.logging.datamgr.common<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 303: | Line 303: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.logging.datamgr.web<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.logging.datamgr.web<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 340: | Line 340: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.management.domain<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.management.domain<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 358: | Line 358: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.management.domain.client<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.management.domain.client<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 459: | Line 459: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.remote.wsdm<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.remote.wsdm<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 475: | Line 475: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.sample.components<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.sample.components<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 497: | Line 497: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.sample.configurations<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.sample.configurations<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 509: | Line 509: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.sample.jpa<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.sample.jpa<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 557: | Line 557: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.stat.datamgr<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.stat.datamgr<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 570: | Line 570: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.stat.datamgr.client<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.stat.datamgr.client<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 583: | Line 583: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.stat.datamgr.common<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.stat.datamgr.common<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 597: | Line 597: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.dc.stat.datamgr.web<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.dc.stat.datamgr.web<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> | ||
Line 678: | Line 678: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | org.eclipse.cosmos.example.mdr.web<b>This will need to be moved to the 'archive' module</b> | + | org.eclipse.cosmos.example.mdr.web<br/><b>This will need to be moved to the 'archive' module</b> |
</td> | </td> | ||
<td> | <td> |
Revision as of 12:17, 17 April 2008
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 a package name that contains the keyword 'provisional' (e.g. org.eclipse.cosmos.dc.cmdbf.services.provisional.metadata.transform)
- 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 17, 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.
In i11, there will be a new module added to COSMOS' CVS called ('archive') that will contain all plug-ins that are no longer needed.
Data Collection
Violating Plug-ins | Packages/Classes | Assignee | Complete |
---|---|---|---|
org.eclipse.cosmos.aperi.mdr.ws |
|
Hubert Leung | No |
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.broker.core |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.cmdbf.services |
|
Ali Mehregani | No |
org.eclipse.cosmos.dc.cmdbf.ws |
|
Joel Hawkins | 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.datamanager.ws |
|
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 |
|
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.logging.datamgr.ws |
|
Hubert Leung | No |
org.eclipse.cosmos.dc.logging.datamgr.ws.client |
|
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.mdr.registration |
|
Ali Mehregani | No |
org.eclipse.cosmos.dc.mdr.registration.client |
|
Ali Mehregani | No |
org.eclipse.cosmos.dc.mdr.registration.common |
|
Ali Mehregani | No |
org.eclipse.cosmos.dc.remote.wsdm |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.sample.components |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.sample.configurations |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.sample.jpa |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.service.finder |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.spec |
|
Joel Hawkins | No |
org.eclipse.cosmos.dc.stat.datamgr |
|
John Todd | No |
org.eclipse.cosmos.dc.stat.datamgr.client |
|
John Todd | No |
org.eclipse.cosmos.dc.stat.datamgr.common |
|
John Todd | No |
org.eclipse.cosmos.dc.stat.datamgr.web |
|
John Todd | No |
org.eclipse.cosmos.dc.stat.datamgr.ws |
|
John Todd | No |
org.eclipse.cosmos.dc.stat.datamgr.ws.client |
|
John Todd | No |
org.eclipse.cosmos.dc.stat.datamgr.ws.common |
|
John Todd | 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 |
org.eclipse.cosmos.management.common |
|
Hubert Leung | No |
org.eclipse.cosmos.management.wsdm |
|
Hubert Leung | No |
org.eclipse.cosmos.tptp.dependencies |
|
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
Second question has already been raised by Harm and will be discussed during the next architecture call