Jump to: navigation, search

Difference between revisions of "COSMOS API Cleanup"

(Open Questions/Concerns)
(COSMOS API Cleanup - Housecleaning)
Line 3: Line 3:
 
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:
 
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:
 
<br/><br/>
 
<br/><br/>
# <b>Internal</b> - Indicated by having a package name that contains the keyword 'internal' (e.g. org.eclipse.cosmos.dc.cmdbf.services.internal)
+
# <b>Internal</b> - Indicated by having a package name that contains the keyword <b>'internal'</b> (e.g. org.eclipse.cosmos.dc.cmdbf.services.internal)
# <b>Provisional</b> - Indicated by having the annotation '@provisional' included in the class comment
+
# <b>Provisional</b> - Indicated by having a package name that contains the keyword <b>'provisional'</b> (e.g. org.eclipse.cosmos.dc.cmdbf.services.provisional.metadata.transform)
 
# <b>Public</b> - Any API that does not fall under (1) or (2)
 
# <b>Public</b> - Any API that does not fall under (1) or (2)
 
<br/><br/>
 
<br/><br/>
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 <font color="orange">orange</font> and expected internal APIs are indicated by <font color="red">red</font>.  The final verdict of what should be internal or provisional is made by the component owner.
+
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 <font color="orange">orange</font> and expected internal APIs are indicated by <font color="red">red</font>.  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.
  
 
<br/><br/>
 
<br/><br/>
Line 17: Line 19:
 
<th>Assignee</th>
 
<th>Assignee</th>
 
<th>Complete</th>
 
<th>Complete</th>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.aperi.mdr.ws
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="red">org.eclipse.cosmos.aperi.mdr.ws</font></li>
 +
<li><font color="red">org.eclipse.cosmos.aperi.mdr.ws.db</font></li>
 +
</ul>
 +
</td>
 +
<td>Hubert Leung</td>
 +
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 33: Line 48:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.birt.helper<br/><b>This should reside under 'data-reporting' instead of 'data-collection'</b>
+
org.eclipse.cosmos.dc.birt.helper<br/><b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td><ul><li><font color="orange">org.eclipse.cosmos.dc.birt.helper</font></li>
 
<td><ul><li><font color="orange">org.eclipse.cosmos.dc.birt.helper</font></li>
Line 46: Line 61:
 
<td>
 
<td>
 
 
org.eclipse.cosmos.dc.broker</td>
+
org.eclipse.cosmos.dc.broker<br/><b>This will need to be moved to the 'archive' module</b>
 +
                        </td>
 
<td>
 
<td>
  
Line 63: Line 79:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.broker.client
+
org.eclipse.cosmos.dc.broker.client<br/><b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 76: Line 92:
 
</td>
 
</td>
 
<td>Hubert Leung</td>
 
<td>Hubert Leung</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.broker.core
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="orange">org.eclipse.cosmos.dc.broker.ws</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.broker.ws.persistence</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.broker.ws.client</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.broker.ws.datamodel</font></li>
 +
</ul>
 +
</td>
 +
<td>Hubert Leung</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.cmdbf.services
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.cmdbfservice</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.common</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.transform</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.transform.artifacts</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.metadata.transform</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.metadata.transform.input.artifacts</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.query.transform</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.query.transform.artifacts</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.query.transform.input.artifacts</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.query.service</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.query.service.impl</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.deregistration.transform</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.deregistration.transform.input.artifacts</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.deregistration.transform.output.artifacts</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.registration.transform</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.registration.transform.input.artifacts</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.registration.transform.output.artifacts</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.common</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.deregistration.service</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.deregistration.service.impl</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.registration.service</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.services.registration.service.impl</font></li>
 +
</ul>
 +
</td>
 +
<td>Ali Mehregani</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.cmdbf.ws
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.exception</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.query.client</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.query.ws</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.receiver</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.registration.client</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.cmdbf.registration.ws</font></li>
 +
</ul>
 +
</td>
 +
<td>Joel Hawkins</td>
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
Line 103: Line 185:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.dataManager
+
org.eclipse.cosmos.dc.dataManager<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 116: Line 198:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.dataManager.client
+
org.eclipse.cosmos.dc.dataManager.client<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 132: Line 214:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.dataManager.common
+
org.eclipse.cosmos.dc.dataManager.common<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 146: Line 228:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.local.domain
+
org.eclipse.cosmos.dc.datamanager.ws
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="orange">org.eclipse.cosmos.dc.datamanager.ws</font></li>
 +
</ul>
 +
</td>
 +
<td>Hubert Leung</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.local.domain<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 158: Line 252:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.local.registry
+
org.eclipse.cosmos.dc.local.registry<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 170: Line 264:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.logging.datamgr (Is this necessary?)
+
org.eclipse.cosmos.dc.logging.datamgr<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 182: Line 276:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.logging.datamgr.client
+
org.eclipse.cosmos.dc.logging.datamgr.client<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 195: Line 289:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.logging.datamgr.common
+
org.eclipse.cosmos.dc.logging.datamgr.common<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 209: Line 303:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.logging.datamgr.web
+
org.eclipse.cosmos.dc.logging.datamgr.web<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 220: Line 314:
 
</tr>
 
</tr>
 
 
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.logging.datamgr.ws
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="orange">org.eclipse.cosmos.dc.logging.datamgr.axis</font></li>
 +
</ul>
 +
</td>
 +
<td>Hubert Leung</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.logging.datamgr.ws.client
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="orange">org.eclipse.cosmos.dc.logging.datamgr.ws.client</font></li>
 +
</ul>
 +
</td>
 +
<td>Hubert Leung</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.management.domain
+
org.eclipse.cosmos.dc.management.domain<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 240: Line 358:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.management.domain.client
+
org.eclipse.cosmos.dc.management.domain.client<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 303: Line 421:
 
 
 
<tr>
 
<tr>
<td>
+
<td>
org.eclipse.cosmos.dc.mgmt.common (Is this necessary?)
+
org.eclipse.cosmos.dc.mdr.registration
 
</td>
 
</td>
 
<td>
 
<td>
 
<ul>
 
<ul>
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.annotations</font></li>
+
<li><font color="orange">org.eclipse.cosmos.dc.mdr.registration</font></li>
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.api</font></li>
+
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.binding</font></li>
+
<li><font color="red">org.eclipse.cosmos.dc.mgmt.common</font></li>
+
<li><font color="red">org.eclipse.cosmos.dc.mgmt.common.util</font></li>
+
<li><font color="red">org.eclipse.cosmos.dc.mgmt.osgi</font></li>
+
 
</ul>
 
</ul>
 
</td>
 
</td>
<td>Joel Hawkins</td>
+
<td>Ali Mehregani</td>
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
 
 
<tr>
 
<tr>
<td>
+
<td>
org.eclipse.cosmos.dc.mgmt.wsdm (Is this necessary?)
+
org.eclipse.cosmos.dc.mdr.registration.client
 
</td>
 
</td>
 
<td>
 
<td>
 
<ul>
 
<ul>
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.provisional.wsdm.capabilities</font></li>
+
<li><font color="orange">org.eclipse.cosmos.dc.mdr.registration.client</font></li>
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.provisional.wsdm.impl</font></li>
+
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.provisional.wsdm.impl.info</font></li>
+
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.provisional.wsdm.persistence</font></li>
+
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.provisional.wsdm.util</font></li>
+
<li><font color="red">org.eclipse.cosmos.dc.mgmt.serializer</font></li>
+
<li><font color="red">org.eclipse.cosmos.dc.mgmt.wsdm.osgi</font></li>
+
 
</ul>
 
</ul>
 
</td>
 
</td>
<td>Joel Hawkins</td>
+
<td>Ali Mehregani</td>
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
+
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.mdr.registration.common
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="orange">org.eclipse.cosmos.dc.mdr.registration.common</font></li>
 +
</ul>
 +
</td>
 +
<td>Ali Mehregani</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
 
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.remote.wsdm (Is this necessary?)
+
org.eclipse.cosmos.dc.remote.wsdm<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 355: Line 473:
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
 
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.sample.components
+
org.eclipse.cosmos.dc.sample.components<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 378: Line 495:
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
 
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.sample.configurations (Is this necessary?)
+
org.eclipse.cosmos.dc.sample.configurations<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 391: Line 507:
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
 
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.sample.jpa (Is this necessary?)
+
org.eclipse.cosmos.dc.sample.jpa<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 409: Line 524:
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.service.finder
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="orange">org.eclipse.cosmos.dc.service.finder</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.service.finder.datamodel</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.service.finder.client</font></li>
 +
</ul>
 +
</td>
 +
<td>Joel Hawkins</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
 
 
 
<tr>
 
<tr>
Line 427: Line 557:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.stat.datamgr (Is this necessary?)
+
org.eclipse.cosmos.dc.stat.datamgr<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 434: Line 564:
 
</ul>
 
</ul>
 
</td>
 
</td>
<td>Hubert Leung</td>
+
<td>John Todd</td>
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
Line 440: Line 570:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.stat.datamgr.client
+
org.eclipse.cosmos.dc.stat.datamgr.client<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 447: Line 577:
 
</ul>
 
</ul>
 
</td>
 
</td>
<td>Hubert Leung</td>
+
<td>John Todd</td>
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
Line 453: Line 583:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.stat.datamgr.common
+
org.eclipse.cosmos.dc.stat.datamgr.common<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 461: Line 591:
 
</ul>
 
</ul>
 
</td>
 
</td>
<td>Hubert Leung</td>
+
<td>John Todd</td>
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
Line 467: Line 597:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.dc.stat.datamgr.web
+
org.eclipse.cosmos.dc.stat.datamgr.web<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
Line 474: Line 604:
 
</ul>
 
</ul>
 
</td>
 
</td>
<td>Hubert Leung</td>
+
<td>John Todd</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.stat.datamgr.ws
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="red">org.eclipse.cosmos.dc.stat.datamgr.axis</font></li>
 +
</ul>
 +
</td>
 +
<td>John Todd</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.stat.datamgr.ws.client
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="red">org.eclipse.cosmos.dc.stat.datamgr.ws.client</font></li>
 +
</ul>
 +
</td>
 +
<td>John Todd</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.dc.stat.datamgr.ws.common
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="red">org.eclipse.cosmos.dc.stat.datamgr.ws.common</font></li>
 +
</ul>
 +
</td>
 +
<td>John Todd</td>
 
<td><b><font color="red">No</font></b></td>
 
<td><b><font color="red">No</font></b></td>
 
</tr>
 
</tr>
Line 512: Line 678:
 
<tr>
 
<tr>
 
<td>
 
<td>
org.eclipse.cosmos.example.mdr.web<br/><b>This should reside in the 'Example' module instead of 'data-collection'</b>
+
org.eclipse.cosmos.example.mdr.web<b>This will need to be moved to the 'archive' module</b>
 
</td>
 
</td>
 
<td>
 
<td>
 
<ul>
 
<ul>
 
<li><font color="red">org.eclipse.cosmos.example.mdr.web</font></li>
 
<li><font color="red">org.eclipse.cosmos.example.mdr.web</font></li>
 +
                                </ul>
 +
</td>
 +
<td>Hubert Leung</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.management.common
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.annotations</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.api</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.binding</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.common</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.common.util</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.osgi</font></li>
 +
                                </ul>
 +
</td>
 +
<td>Hubert Leung</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.management.wsdm
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.serializer</font></li>
 +
<li><font color="orange">org.eclipse.cosmos.dc.mgmt.wsdm.osgi</font></li>
 +
                                </ul>
 +
</td>
 +
<td>Hubert Leung</td>
 +
<td><b><font color="red">No</font></b></td>
 +
</tr>
 +
<tr>
 +
<td>
 +
org.eclipse.cosmos.tptp.dependencies
 +
</td>
 +
<td>
 +
<ul>
 +
<li><font color="red">org.eclipse.cosmos.tptp.dependencies</font></li>
 
                                 </ul>
 
                                 </ul>
 
</td>
 
</td>

Revision as of 11:15, 17 April 2008

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:

  1. Internal - Indicated by having a package name that contains the keyword 'internal' (e.g. org.eclipse.cosmos.dc.cmdbf.services.internal)
  2. Provisional - Indicated by having a package name that contains the keyword 'provisional' (e.g. org.eclipse.cosmos.dc.cmdbf.services.provisional.metadata.transform)
  3. 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

  • org.eclipse.cosmos.aperi.mdr.ws
  • org.eclipse.cosmos.aperi.mdr.ws.db
Hubert Leung No

org.eclipse.cosmos.common

  • org.eclipse.cosmos.common
  • org.eclipse.cosmos.common.exceptions
Hubert Leung No

org.eclipse.cosmos.dc.birt.helper
This will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.birt.helper
Sheldon Lee-Loy No

org.eclipse.cosmos.dc.broker
This will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.broker
    • Broker.java
    • CustomSimpleServiceGroup.java
    • IBroker.java
Hubert Leung No

org.eclipse.cosmos.dc.broker.client
This will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.broker.client
    • Activator.java
    • BrokerClient.java
    • IBrokerClient.java
Hubert Leung No

org.eclipse.cosmos.dc.broker.core

  • org.eclipse.cosmos.dc.broker.ws
  • org.eclipse.cosmos.dc.broker.ws.persistence
  • org.eclipse.cosmos.dc.broker.ws.client
  • org.eclipse.cosmos.dc.broker.ws.datamodel
Hubert Leung No

org.eclipse.cosmos.dc.cmdbf.services

  • org.eclipse.cosmos.dc.cmdbf.services.cmdbfservice
  • org.eclipse.cosmos.dc.cmdbf.services.common
  • org.eclipse.cosmos.dc.cmdbf.services.transform
  • org.eclipse.cosmos.dc.cmdbf.services.transform.artifacts
  • org.eclipse.cosmos.dc.cmdbf.services.metadata.transform
  • org.eclipse.cosmos.dc.cmdbf.services.metadata.transform.input.artifacts
  • org.eclipse.cosmos.dc.cmdbf.services.query.transform
  • org.eclipse.cosmos.dc.cmdbf.services.query.transform.artifacts
  • org.eclipse.cosmos.dc.cmdbf.services.query.transform.input.artifacts
  • org.eclipse.cosmos.dc.cmdbf.services.query.transform.response.artifacts
  • org.eclipse.cosmos.dc.cmdbf.services.query.service
  • org.eclipse.cosmos.dc.cmdbf.services.query.service.impl
  • org.eclipse.cosmos.dc.cmdbf.services.deregistration.transform
  • org.eclipse.cosmos.dc.cmdbf.services.deregistration.transform.input.artifacts
  • org.eclipse.cosmos.dc.cmdbf.services.deregistration.transform.output.artifacts
  • org.eclipse.cosmos.dc.cmdbf.services.registration.transform
  • org.eclipse.cosmos.dc.cmdbf.services.registration.transform.input.artifacts
  • org.eclipse.cosmos.dc.cmdbf.services.registration.transform.output.artifacts
  • org.eclipse.cosmos.dc.cmdbf.services.common
  • org.eclipse.cosmos.dc.cmdbf.services.deregistration.service
  • org.eclipse.cosmos.dc.cmdbf.services.deregistration.service.impl
  • org.eclipse.cosmos.dc.cmdbf.services.registration.service
  • org.eclipse.cosmos.dc.cmdbf.services.registration.service.impl
Ali Mehregani No

org.eclipse.cosmos.dc.cmdbf.ws

  • org.eclipse.cosmos.dc.cmdbf.exception
  • org.eclipse.cosmos.dc.cmdbf.query.client
  • org.eclipse.cosmos.dc.cmdbf.query.ws
  • org.eclipse.cosmos.dc.cmdbf.receiver
  • org.eclipse.cosmos.dc.cmdbf.registration.client
  • org.eclipse.cosmos.dc.cmdbf.registration.ws
Joel Hawkins No

org.eclipse.cosmos.dc.common

  • org.eclipse.cosmos.dc.common
  • org.eclipse.cosmos.dc.common.api
  • org.eclipse.cosmos.dc.common.api.impl
  • org.eclipse.cosmos.dc.common.domain
  • org.eclipse.cosmos.dc.common.registry
  • org.eclipse.cosmos.dc.common.registry.impl
  • org.eclipse.cosmos.dc.common.registry.impl
  • org.eclipse.cosmos.dc.common.spi
  • org.eclipse.cosmos.dc.common.spi.descriptor
  • org.eclipse.cosmos.dc.common.spi.impl
  • org.eclipse.cosmos.dc.runtime
  • org.eclipse.cosmos.dc.runtime.osgi
Joel Hawkins No

org.eclipse.cosmos.dc.dataManagerThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.dataManager
  • org.eclipse.cosmos.dc.dataManager.impl
Hubert Leung No

org.eclipse.cosmos.dc.dataManager.clientThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.dataManager.client
    • Activator.java
    • DataManagerClient.java
Hubert Leung No

org.eclipse.cosmos.dc.dataManager.commonThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.dataManager.api
  • org.eclipse.cosmos.dc.dataManager.common
  • org.eclipse.cosmos.dc.dataManager.exception
Hubert Leung No

org.eclipse.cosmos.dc.datamanager.ws

  • org.eclipse.cosmos.dc.datamanager.ws
Hubert Leung No

org.eclipse.cosmos.dc.local.domainThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.local.domain
Joel Hawkins No

org.eclipse.cosmos.dc.local.registryThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.local.registry
Joel Hawkins No

org.eclipse.cosmos.dc.logging.datamgrThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.logging.datamgr
Hubert Leung No

org.eclipse.cosmos.dc.logging.datamgr.clientThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.logging.datamgr.client
Hubert Leung No

org.eclipse.cosmos.dc.logging.datamgr.commonThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.logging.datamgr.api
  • org.eclipse.cosmos.dc.logging.datamgr.common
Hubert Leung No

org.eclipse.cosmos.dc.logging.datamgr.webThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.logging.datamgr
Hubert Leung No

org.eclipse.cosmos.dc.logging.datamgr.ws

  • org.eclipse.cosmos.dc.logging.datamgr.axis
Hubert Leung No

org.eclipse.cosmos.dc.logging.datamgr.ws.client

  • org.eclipse.cosmos.dc.logging.datamgr.ws.client
Hubert Leung No

org.eclipse.cosmos.dc.management.domainThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.management.domain
    • IManagementDomain.java
    • ManagementDomain.java
    • ManagementDomainRegistry.java
Hubert Leung No

org.eclipse.cosmos.dc.management.domain.clientThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.management.domain.client
    • Activator.java
    • IManagementDomainClient.java
    • ManagementDomainClient.java
Hubert Leung No

org.eclipse.cosmos.dc.mdr

  • org.eclipse.cosmos.dc.mdr
  • org.eclipse.cosmos.dc.mdr.impl
Hubert Leung No

org.eclipse.cosmos.dc.mdr.client

  • org.eclipse.cosmos.dc.mdr.client
    • Activator.java
    • MdrClient.java
Hubert Leung No

org.eclipse.cosmos.dc.mdr.common

  • org.eclipse.cosmos.dc.mdr.api
  • org.eclipse.cosmos.dc.mdr.common
  • org.eclipse.cosmos.dc.mdr.exception
Hubert Leung No

org.eclipse.cosmos.dc.mdr.registration

  • org.eclipse.cosmos.dc.mdr.registration
Ali Mehregani No

org.eclipse.cosmos.dc.mdr.registration.client

  • org.eclipse.cosmos.dc.mdr.registration.client
Ali Mehregani No

org.eclipse.cosmos.dc.mdr.registration.common

  • org.eclipse.cosmos.dc.mdr.registration.common
Ali Mehregani No

org.eclipse.cosmos.dc.remote.wsdmThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.remote.wsdm
  • org.eclipse.cosmos.dc.remote.wsdm.api
  • org.eclipse.cosmos.dc.remote.wsdm.registry
  • org.eclipse.cosmos.dc.remote.wsdm.spec
  • org.eclipse.cosmos.dc.remote.wsdm.spi
Joel Hawkins No

org.eclipse.cosmos.dc.sample.componentsThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.sample.components
  • org.eclipse.cosmos.dc.sample.components.filter
  • org.eclipse.cosmos.dc.sample.components.persistence.sql
  • org.eclipse.cosmos.dc.sample.components.query
  • org.eclipse.cosmos.dc.sample.components.sink
  • org.eclipse.cosmos.dc.sample.components.sink.cbe
  • org.eclipse.cosmos.dc.sample.components.sink.cbe.wrapper
  • org.eclipse.cosmos.dc.sample.components.source
  • org.eclipse.cosmos.dc.sample.persistence.impl
  • org.eclipse.cosmos.dc.sample.types
Joel Hawkins No

org.eclipse.cosmos.dc.sample.configurationsThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.sample.configurations
Joel Hawkins No

org.eclipse.cosmos.dc.sample.jpaThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.sample.jpa
  • org.eclipse.cosmos.dc.sample.jpa.cbe.entity
  • org.eclipse.cosmos.dc.sample.jpa.query
  • org.eclipse.cosmos.dc.sample.jpa.sink
  • org.eclipse.cosmos.dc.sample.jpa.stat.entity
  • org.eclipse.cosmos.dc.sample.jpa.wef.entity
Joel Hawkins No

org.eclipse.cosmos.dc.service.finder

  • org.eclipse.cosmos.dc.service.finder
  • org.eclipse.cosmos.dc.service.finder.datamodel
  • org.eclipse.cosmos.dc.service.finder.client
Joel Hawkins No

org.eclipse.cosmos.dc.spec

  • org.eclipse.cosmos.dc.spec
  • org.eclipse.cosmos.dc.spec.capabilitiy
  • org.eclipse.cosmos.dc.spec.types
Joel Hawkins No

org.eclipse.cosmos.dc.stat.datamgrThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.stat.datamgr
John Todd No

org.eclipse.cosmos.dc.stat.datamgr.clientThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.stat.datamgr.client
John Todd No

org.eclipse.cosmos.dc.stat.datamgr.commonThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.stat.datamgr.api
  • org.eclipse.cosmos.dc.stat.datamgr.common
John Todd No

org.eclipse.cosmos.dc.stat.datamgr.webThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.dc.stat.datamgr
John Todd No

org.eclipse.cosmos.dc.stat.datamgr.ws

  • org.eclipse.cosmos.dc.stat.datamgr.axis
John Todd No

org.eclipse.cosmos.dc.stat.datamgr.ws.client

  • org.eclipse.cosmos.dc.stat.datamgr.ws.client
John Todd No

org.eclipse.cosmos.dc.stat.datamgr.ws.common

  • org.eclipse.cosmos.dc.stat.datamgr.ws.common
John Todd No

org.eclipse.cosmos.dc.tptp.agentcontroller

  • org.eclipse.cosmos.dc.tptp.agent
  • org.eclipse.cosmos.dc.tptp.agent.component
  • org.eclipse.cosmos.dc.tptp.agentcontroller
  • org.eclipse.cosmos.dc.tptp.agentcontroller.internal
  • org.eclipse.cosmos.dc.tptp.console
Hubert Leung No

org.eclipse.cosmos.dc.tptp.gla.components

  • org.eclipse.cosmos.dc.tptp.gla.components
  • org.eclipse.cosmos.dc.tptp.gla.components.source
  • org.eclipse.cosmos.dc.tptp.gla.components.transform
Hubert Leung No

org.eclipse.cosmos.example.mdr.webThis will need to be moved to the 'archive' module

  • org.eclipse.cosmos.example.mdr.web
Hubert Leung No

org.eclipse.cosmos.management.common

  • org.eclipse.cosmos.dc.mgmt.annotations
  • org.eclipse.cosmos.dc.mgmt.api
  • org.eclipse.cosmos.dc.mgmt.binding
  • org.eclipse.cosmos.dc.mgmt.common
  • org.eclipse.cosmos.dc.mgmt.common.util
  • org.eclipse.cosmos.dc.mgmt.osgi
Hubert Leung No

org.eclipse.cosmos.management.wsdm

  • org.eclipse.cosmos.dc.mgmt.serializer
  • org.eclipse.cosmos.dc.mgmt.wsdm.osgi
Hubert Leung No

org.eclipse.cosmos.tptp.dependencies

  • 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

  • org.eclipse.cosmos.provisional.dr.drs.service.handler.cmdbf
  • org.eclipse.cosmos.provisional.dr.drs.service.handler.common
Sheldon Lee-Loy No

org.eclipse.cosmos.dr.ps.common

  • org.eclipse.cosmos.provisional.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

  • org.eclipse.cosmos.me.dmtoolkit.common
  • org.eclipse.jface.snippets.viewers (was this copied from JFace?)
David Whiteman No

org.eclipse.cosmos.me.dmtoolkit.j2ee

  • org.eclipse.cosmos.me.dmtoolkit.j2ee
  • org.eclipse.cosmos.me.dmtoolkit.j2ee.delegates
  • org.eclipse.cosmos.me.dmtoolkit.j2ee.factory
  • org.eclipse.cosmos.me.dmtoolkit.j2ee.ui
  • org.eclipse.cosmos.me.dmtoolkit.j2ee.util
David Whiteman No

org.eclipse.cosmos.me.management.common

  • org.eclipse.cosmos.me.management.annotations
  • org.eclipse.cosmos.me.management.api
  • org.eclipse.cosmos.me.management.binding
  • org.eclipse.cosmos.me.management.common
  • org.eclipse.cosmos.me.management.common.info
  • org.eclipse.cosmos.me.management.common.util
  • org.eclipse.cosmos.me.management.osgi
  • org.eclipse.cosmos.me.management.web
Joel Hawkins No

org.eclipse.cosmos.me.management.wsdm

  • org.eclipse.cosmos.me.management.provisional.wsdm
  • org.eclipse.cosmos.me.management.provisional.wsdm.annotations
  • org.eclipse.cosmos.me.management.provisional.wsdm.capabilities
  • org.eclipse.cosmos.me.management.provisional.wsdm.capabilities.impl
  • org.eclipse.cosmos.me.management.provisional.wsdm.faults
  • org.eclipse.cosmos.me.management.provisional.wsdm.impl
  • org.eclipse.cosmos.me.management.provisional.wsdm.impl.info
  • org.eclipse.cosmos.me.management.provisional.wsdm.persistence
  • org.eclipse.cosmos.me.management.provisional.wsdm.util
  • org.eclipse.cosmos.me.management.provisional.wsrf.capabilities
  • org.eclipse.cosmos.me.management.provisional.wsrf.capabilities.impl
  • org.eclipse.cosmos.me.management.provisional.wsrf.faults
  • org.eclipse.cosmos.me.management.wsdm.osgi
  • org.eclipse.cosmos.me.management.wsdm.web
Joel Hawkins No

Resource Modeling

Violating Plug-ins Packages/Classes Assignee Complete

org.eclipse.cosmos.rm.sml.mdr (Is this necessary?)

  • org.eclipse.cosmos.rm.sml.mdr
  • org.eclipse.cosmos.rm.sml.mdr.impl
Hubert Leung No

org.eclipse.cosmos.rm.sml.mdr.web

  • org.eclipse.cosmos.rm.sml.mdr
  • org.eclipse.cosmos.rm.sml.mdr.impl
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

  1. 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
  2. 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