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"
(→ECF Documentation Project) |
|||
| (221 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | [[Image:container.png|right|300px]] | |
| − | + | ||
| − | + | ||
| − | | | + | |
| − | | | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | == | + | =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]] | |
| − | + | NEW 3.8.1: [[Tutorial: OSGi Remote Services for the Raspberry Pi]] | |
| − | [ | + | [[Getting Started with ECF's OSGi Remote Services Implementation]] |
| − | [[ECF | + | [[OSGi Remote Services and ECF]] |
| − | + | ===Download and Install=== | |
| − | + | [http://www.eclipse.org/ecf Download and Install into Eclipse] | |
| − | + | ||
| − | + | [[EIG:Install into Apache Karaf|Apache Karaf Install of ECF RS SDK]] | |
| − | + | ||
| − | + | ||
| − | + | [[EIG:Install Timeline Example into Apache Karaf|Install and run Timeline Tutorial in Apache Karaf]] | |
| − | + | ===More Advanced Usage of OSGi 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]] | |
| − | [[ | + | [[Distributed EventAdmin Service]] |
| − | + | [[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)=== | |
| − | [[ | + | [[Tutorial: Creating a RESTful Remote Service Provider]] |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | [[ | + | [[iPopo Compatible Providers]] |
[[REST_abstraction_for_ECF|REST-style Remote Services Providers]] | [[REST_abstraction_for_ECF|REST-style Remote Services Providers]] | ||
| Line 75: | Line 50: | ||
[[SOAP-based Providers|SOAP-based Remote Services Providers]] | [[SOAP-based Providers|SOAP-based Remote Services Providers]] | ||
| − | [[ | + | [[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]] |
| − | [[ | + | [[EIG:Configuration_Properties | Discovery and Distribution Configuration Properties]] |
| − | [ | + | ==[http://eclipseecf.blogspot.com/ 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] | |
| − | [[ | + | * [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]] | ||
| + | * [http://download.eclipse.org/rt/ecf/3.8.1/javadoc/index.html ECF API Javadoc ] | ||
| − | + | ==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] | ||
| − | |||
| − | + | =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): === | |
| − | [[ | + | ===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]] | |
| − | + | ===IRC=== | |
| − | + | *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== | |
| − | + | ||
| − | + | [[Planning for ECF 3.8 | Plan for ECF 3.8]] | |
| − | [[ECF | + | [[ECF 4.0 ToDos]] |
| − | == | + | ==Access to Source Code== |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git source code repository] | |
| − | + | [http://git.eclipse.org/c/ecf/ecf.git/ web documentation repository] | |
| − | == | + | ==Coding Conventions== |
| − | + | ECF has decided to use the [http://www.eclipse.org/equinox/documents/coding.php Equinox Coding Conventions]. Also [http://www.eclipse.org/equinox/documents/coding.php 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 [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 09:46, 25 June 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
NEW 3.8.1: Tutorial: OSGi Remote Services for the Raspberry Pi
Getting Started with ECF's OSGi Remote Services Implementation
Download and Install
Download and Install into Eclipse
Apache Karaf Install of ECF RS SDK
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
- ECF API Javadoc
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):
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 |