Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "ECF API Refactoring"
(Formatting) |
(→Pending Items: Adding 'API Review') |
||
| Line 30: | Line 30: | ||
Will be: I<whatever>ContainerAdapter | Will be: I<whatever>ContainerAdapter | ||
| − | This way, it should be more obvious which interface in a given API | + | This way, it should be more obvious which interface in a given API plug-in is the container adapter that should be used for the call to IContainer.getAdapter(Class). |
| − | container adapter that should be | + | |
| + | ===API Review=== | ||
| + | An overwhelming number of classes in ECF at the moment are not being marked as internal packages. Whilst this may be the actual intent of the plug-ins, many of these non-internal classes are completely undocumented but are generated along with the published javadocs on the ECF website. | ||
| + | |||
| + | For this review, ECF code needs to clearly mark provisional APIs as being provisional, interfaces that should not be implemented by clients should have that stated clearly in the class level documentation, classes needs to be moved to internal packages (such as Trace, classes extending Plugin or AbstractUIPlugin, any others that are found during this review etc.), everything that has been approved as being public API needs to be marked with @since 1.0 when ECF 1.0 is released, and many others. | ||
| + | |||
| + | See [[API Central]] for further information Eclipse conventions and best practices for API development. | ||
==Items In Progress== | ==Items In Progress== | ||
Revision as of 04:05, 18 October 2006
Prior to 1.0, ECF will be going through a concerted API and exemplary applications refactoring and restructuring effort.
Pending Items
Add Bulletin Board API to ECF Plugins and Features (Major)
Add Bulletin Board API. Remove EE 1.5 dependencies.
See: Bug #150756
Add 'removeListener' methods
Add removeListener methods in IChatRoomContainer (and in IPresenceContainer). Also check other listener add and check for availability of remove methods.
See: Bug #160968
Streamline ClientSOContainer
Streamline handling of creating/passing in connect data for new kind of authentication.
See: Bug #150398
Move IInvitationListener
Move (in presence API) access to IInvitationListener to IChatRoomManager rather than IPresenceContainer.
See: Bug #160137
Introduce Convention for Container Adapters
Change all occurrences of I<whatever>Container that are intended to be used as adapters off of IContainer (via IContainer.getAdapter(I<whatever>Container) to have the following naming convention:
Was: I<whatever>Container Will be: I<whatever>ContainerAdapter
This way, it should be more obvious which interface in a given API plug-in is the container adapter that should be used for the call to IContainer.getAdapter(Class).
API Review
An overwhelming number of classes in ECF at the moment are not being marked as internal packages. Whilst this may be the actual intent of the plug-ins, many of these non-internal classes are completely undocumented but are generated along with the published javadocs on the ECF website.
For this review, ECF code needs to clearly mark provisional APIs as being provisional, interfaces that should not be implemented by clients should have that stated clearly in the class level documentation, classes needs to be moved to internal packages (such as Trace, classes extending Plugin or AbstractUIPlugin, any others that are found during this review etc.), everything that has been approved as being public API needs to be marked with @since 1.0 when ECF 1.0 is released, and many others.
See API Central for further information Eclipse conventions and best practices for API development.
Items In Progress
Split org.eclipse.ecf Core Plugin into 2 or 3 Plugins (Major)
Refactor org.eclipse.ecf plugin into 2 or 3 plugins. This is a large refactoring effort. See discussion thread on mailing list: http://dev.eclipse.org/mhonarc/lists/ecf-dev/msg00399.html
Status: Started by SBL
Remove org.eclipse.ecf.fileshare API packages and classes.
Create a new plugin: org.eclipse.ecf.filetransfer.
Status: Started by SBL
Completed Items
'Low-end' Execution Environment Support
See: Bug #149024
Problem: Dependency on javax.security.auth.callback.* classes. These classes are not available in Framework 1.1 (they are part of the JAAS classes that are optional for F1.1)
Removed ECF core and all provider references to classes
javax.security.auth.callback.Callback; javax.security.auth.callback.CallbackHandler; javax.security.auth.callback.NameCallback; javax.security.auth.callback.UnsupportedCallbackException;
Explanation: Added new classes and changed existing references to above classes to classes in ECF org.eclipse.ecf.core.security package:
org.eclipse.ecf.core.security.Callback; org.eclipse.ecf.core.security.CallbackHandler; org.eclipse.ecf.core.security.NameCallback; org.eclipse.ecf.core.security.UnsupportedCallbackException;
Assure JRE1.4 as EE for All Core Plug-ins
See: Bug #160805
Deferred Items
None.