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 "Eclipse Communication Framework Project"
(→Project Planning Documents) |
(→Introductory Materials) |
||
| (36 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | [[Image:container.png|right]] | |
| − | + | ||
| − | + | ||
| − | | | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| + | =Documentation (for consumers)= | ||
==OSGi Remote Services== | ==OSGi Remote Services== | ||
| − | ===Introductory=== | + | ===Introductory Materials=== |
[[Tutorial: Building your first OSGi Remote Service]] | [[Tutorial: Building your first OSGi Remote Service]] | ||
| + | |||
| + | NEW 3.8.1: [[Tutorial: Building your first Asynchronous OSGi Remote Service]] | ||
[[Getting Started with ECF's OSGi Remote Services Implementation]] | [[Getting Started with ECF's OSGi Remote Services Implementation]] | ||
| Line 27: | Line 19: | ||
[[EIG:Add to Target Platform|How to Add Remote Services/RSA to Your Target Platform]] | [[EIG:Add to Target Platform|How to Add Remote Services/RSA to Your Target Platform]] | ||
| + | |||
| + | NEW 3.8: [[EIG:Install into Apache Karaf|Apache Karaf Install of ECF RS SDK]] | ||
| + | |||
| + | NEW 3.8: [[EIG:Install Timeline Example into Apache Karaf|Install and run Timeline Tutorial in Apache Karaf]] | ||
===More Advanced Usage of OSGi Remote Services=== | ===More Advanced Usage of OSGi Remote Services=== | ||
| Line 32: | Line 28: | ||
[[Asynchronous Proxies for Remote Services]] | [[Asynchronous Proxies for Remote Services]] | ||
| − | [ | + | [http://eclipseecf.blogspot.com/2010/02/osgi-remote-services-and-sync-vs-async.html OSGi Remote Services and Sync vs. Async Remote Procedure Call] |
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]] | [[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]] | ||
| Line 40: | Line 36: | ||
[[Tracing Options for Remote Services]] | [[Tracing Options for Remote Services]] | ||
| − | [ | + | ===Remote Service Admin=== |
| + | |||
| + | [[Remote Services Admin|OSGi Remote Service Admin (RSA) Management Agent]] | ||
===Customization of ECF Remote Services (new Discovery and/or Distribution providers)=== | ===Customization of ECF Remote Services (new Discovery and/or Distribution providers)=== | ||
| Line 56: | Line 54: | ||
[[EIG:Configuration_Properties | Discovery and Distribution Configuration Properties]] | [[EIG:Configuration_Properties | Discovery and Distribution Configuration Properties]] | ||
| − | == | + | ==[http://eclipseecf.blogspot.com/ ECF Blog]== |
| − | ECF | + | ==ECF Documentation Project== |
| − | + | We know we have a problem with insufficient and disorganized documentation. We are working on it. We would appreciate any help that anyone is willing to provide, so if you would like to contribute to ECF by editing and/or creating documentation, please get a hold of us via the ]https://dev.eclipse.org/mailman/listinfo/ecf-dev ecf-dev mailing list] | |
| − | + | * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=329124 Documentation project enhancement request (bug 329124)] | |
| + | * [[EUG:Users Guide|Users Guide (work in progress)]] | ||
| + | * [[EIG:Integrators Guide|Integrators Guide (work in progress)]] | ||
| + | * [[EUG:How to Contribute|How to Contribute]] | ||
| + | * [[ECF Documentation Priorities]] | ||
| − | + | ==Additional Documentation== | |
| − | + | *[[ECF Servers|Servers]] | |
| + | *[[ECF Providers|Providers]] | ||
| + | *[[ECF Connection Creation and Management | ECF Container/Connection Creation and Management]] | ||
| + | *[[DocShare Plugin|Real-Time Shared Editing]] | ||
| + | *[[Extending Real-Time Shared Editing for Use with Other Editors]] | ||
| − | == | + | ==Recent Presentations== |
| − | *[[ | + | *[http://www.lemmster.de/publications/Discover_Remote_Services_-_Democamp_HH_2013_-_Markus_Alexander_Kuppe.pdf Democamp presentation by Markus Kuppe] |
| + | *[http://www.eclipsecon.org/europe2013/discover-remote-osgi-services Discover Remote OSGi Services] | ||
| + | *[http://vimeo.com/14247502 Fun with remote services] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | ====Notes from | + | =Development (for contributors & committers)= |
| + | |||
| + | ==ECF Calls and Meetings== | ||
| + | |||
| + | ECF has open bi-weekly Google Hangouts to discuss current and future issues on our roadmap. '''Anyone interested is welcome to join us (Consumers too)'''. We typically share the Hangout URL on the [https://dev.eclipse.org/mailman/listinfo/ecf-dev ecf-dev mailing list] shortly before the hangout begins...so please [https://dev.eclipse.org/mailman/listinfo/ecf-dev join the ecf-dev mailing list] | ||
| + | |||
| + | ===Next Hangout (proposed): Tuesday, January 14, 2013 - 1700 UTC/09:00am pacific=== | ||
| + | |||
| + | *[[ECF_Conference_Call_01.14.2013|Proposed agenda for next meeting]] | ||
| + | |||
| + | ===Notes from Recent Meetings=== | ||
| + | *[[ECF_Conference_Call_01.07.2013|1.07.2014 Call Agenda and Notes]] | ||
| + | |||
| + | ====Archive Notes==== | ||
*[[ECF Meeting Notes|Notes from Previous Meetings]] | *[[ECF Meeting Notes|Notes from Previous Meetings]] | ||
| Line 86: | Line 102: | ||
*IRC (public): <b>irc.freenode.net</b> channel: <b>#eclipse-ecf</b> ECF URL <b>[irc://irc.freenode.net/#eclipse-ecf irc://<user>@irc.freenode.net/#eclipse-ecf]</b><br> | *IRC (public): <b>irc.freenode.net</b> channel: <b>#eclipse-ecf</b> ECF URL <b>[irc://irc.freenode.net/#eclipse-ecf irc://<user>@irc.freenode.net/#eclipse-ecf]</b><br> | ||
| − | ==Project Planning | + | ==Project Planning== |
[[Planning for ECF 3.8 | Plan for ECF 3.8]] | [[Planning for ECF 3.8 | Plan for ECF 3.8]] | ||
| Line 92: | Line 108: | ||
[[ECF 4.0 ToDos]] | [[ECF 4.0 ToDos]] | ||
| − | ==Source Code== | + | ==Access to Source Code== |
[http://git.eclipse.org/c/ecf/org.eclipse.ecf.git source code repository] | [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git source code repository] | ||
| + | |||
[http://git.eclipse.org/c/ecf/ecf.git/ web documentation repository] | [http://git.eclipse.org/c/ecf/ecf.git/ web documentation repository] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Coding Conventions== | ==Coding Conventions== | ||
| Line 135: | Line 119: | ||
source code formatter to use in Eclipse to easily enforce these conventions. | source code formatter to use in Eclipse to easily enforce these conventions. | ||
| − | == | + | ==Builds== |
| − | + | ECF has nightly and continuous builds with automated integration testing. We use Jenkins and Buckminster and is hosted at the Oregon State University Open Source Lab. See [https://build.ecf-project.org/jenkins/ here]. | |
| − | + | ||
| − | + | ||
| − | == | + | Both Maven and p2 repositories are available from nightly builds [http://download.ecf-project.org/ here]. |
| + | |||
| + | ==Appendix== | ||
| − | + | [[ECF/Adopters|ECF Adopters List (please add yourself if you are using ECF)]] | |
| − | + | ||
| − | + | ||
| − | + | ||
{{ECF}} | {{ECF}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 18:10, 17 April 2014
Contents
Documentation (for consumers)
OSGi Remote Services
Introductory Materials
Tutorial: Building your first OSGi Remote Service
NEW 3.8.1: Tutorial: Building your first Asynchronous OSGi Remote Service
Getting Started with ECF's OSGi Remote Services Implementation
Download and Install
Download ECF Remote Services/RSA Implementation
How to Add Remote Services/RSA to Your Target Platform
NEW 3.8: Apache Karaf Install of ECF RS SDK
NEW 3.8: Install and run Timeline Tutorial in Apache Karaf
More Advanced Usage of OSGi Remote Services
Asynchronous Proxies for Remote Services
OSGi Remote Services and Sync vs. Async Remote Procedure Call
Static File-based Discovery of Remote Service Endpoints
Distributed EventAdmin Service
Tracing Options for Remote Services
Remote Service Admin
OSGi Remote Service Admin (RSA) Management Agent
Customization of ECF Remote Services (new Discovery and/or Distribution providers)
Tutorial: Creating a RESTful Remote Service Provider
REST-style Remote Services Providers
SOAP-based Remote Services Providers
Technical Comparison of Discovery and Distribution Providers
Discovery and Distribution Configuration Properties
ECF Blog
ECF Documentation Project
We know we have a problem with insufficient and disorganized documentation. We are working on it. We would appreciate any help that anyone is willing to provide, so if you would like to contribute to ECF by editing and/or creating documentation, please get a hold of us via the ]https://dev.eclipse.org/mailman/listinfo/ecf-dev ecf-dev mailing list]
- Documentation project enhancement request (bug 329124)
- Users Guide (work in progress)
- Integrators Guide (work in progress)
- How to Contribute
- ECF Documentation Priorities
Additional Documentation
- Servers
- Providers
- ECF Container/Connection Creation and Management
- Real-Time Shared Editing
- Extending Real-Time Shared Editing for Use with Other Editors
Recent Presentations
Development (for contributors & committers)
ECF Calls and Meetings
ECF has open bi-weekly Google Hangouts to discuss current and future issues on our roadmap. Anyone interested is welcome to join us (Consumers too). We typically share the Hangout URL on the ecf-dev mailing list shortly before the hangout begins...so please join the ecf-dev mailing list
Next Hangout (proposed): Tuesday, January 14, 2013 - 1700 UTC/09:00am pacific
Notes from Recent Meetings
Archive Notes
IRC
- IRC (public): irc.freenode.net channel: #eclipse-ecf ECF URL irc://<user>@irc.freenode.net/#eclipse-ecf
Project Planning
Access to Source Code
Coding Conventions
ECF has decided to use the Equinox Coding Conventions. Also on this page are links to java source code formatter to use in Eclipse to easily enforce these conventions.
Builds
ECF has nightly and continuous builds with automated integration testing. We use Jenkins and Buckminster and is hosted at the Oregon State University Open Source Lab. See here.
Both Maven and p2 repositories are available from nightly builds here.
Appendix
ECF Adopters List (please add yourself if you are using ECF)
| Eclipse Communication Framework |
| API |
| API Documentation • Javadoc • Providers |
| Development |
| Development Guidelines • Integrators Guide |