Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Eclipse Communication Framework Project"

(ECF Documentation Project)
(195 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Infobox
+
[[Image:container.png|right|300px]]  
| name = Eclipse Communication Framework
+
| download = http://www.eclipse.org/ecf/downloads.php
+
| website = http://www.eclipse.org/ecf
+
| list = ecf-dev
+
| newsgroup = eclipse.technology.ecf
+
| product = ECF
+
| irc = eclipse-ecf
+
| viewvc = org.eclipse.ecf/?root=RT_Project
+
| psf = http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/releng/org.eclipse.ecf.releng/projectSet-anonymous.psf?root=RT_Project&view=co
+
}}
+
[http://www.eclipse.org/ecf/dev_resources.php ECF Developer Resources (CVS access, newsgroup/mailing list access, etc.)]<br/>
+
  
==Conference Calls==
+
=Documentation (for consumers)=
 +
==OSGi Remote Services==
  
ECF has weekly conference calls to discuss current and future issues on our roadmap. Anyone is welcome to join us.
+
===Introductory Materials===
*International: +1-416-840-9801*
+
*Canada: 1-877-727-8553*
+
*U.S.: 1-866-394-4146*
+
*Germany: 0800 111 1193*
+
*U.K.: 0800 358 3473*
+
*France: 0800 94 0253*
+
*Finland: 0800 114 485*
+
*Sweden: 0200 125 713*
+
  
*Participant passcode: 428 029 063#
+
[[Tutorial: Building your first OSGi Remote Service]]
  
===Next Conference Call: Monday, May 17, 2010 - 1700 UTC/10:00am pacific===
+
NEW 3.8.1: [[Tutorial: Building your first Asynchronous OSGi Remote Service]]
  
[http://www.timeanddate.com/worldclock/fixedtime.html?year=2010&month=05&day=17&hour=17&min=00&sec=0 May 17, 2010, 1700 UTC/10:00am pacific time]
+
NEW 3.8.1: [[Tutorial: OSGi Remote Services for the Raspberry Pi]]
  
[[ECF Conference Call 5.17.2010|5.17.2010 Call Agenda/Notes]]
+
[[Getting Started with ECF's OSGi Remote Services Implementation]]
  
*[[ECF Meeting Notes|Notes from Previous Meetings]]
+
[[OSGi Remote Services and ECF]]
  
[http://www.google.com/calendar/embed?src=q0gpojsaatmup0uilkklpe409c%40group.calendar.google.com&ctz=America/Los_Angeles Google Calendar]
+
===Download and Install===
  
===Public and Private Chat Groups===
+
[http://www.eclipse.org/ecf Download and Install into Eclipse]
ECF also has ongoing public and private chat groups. Please join us!
+
  
*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>
+
[[EIG:Install into Apache Karaf|Apache Karaf Install of ECF RS SDK]]
*XMPP (private): <b><user>@ecf.eclipse.org</b> multi-user chat: <b>ecf</b><br>
+
*ECF Generic (public):  <b>ecftcp://ecf.eclipse.org:3282/server</b>
+
  
==Project Planning==
+
[[EIG:Install Timeline Example into Apache Karaf|Install and run Timeline Tutorial in Apache Karaf]]
  
[http://www.eclipse.org/projects/project-plan.php?projectid=rt.ecf Current Project Plan]
+
===More Advanced Usage of OSGi Remote Services===
  
[[ECF 4.0 ToDo collection]]
+
[[Asynchronous Proxies for Remote Services]]
  
==Builds==
+
[http://eclipseecf.blogspot.com/2010/02/osgi-remote-services-and-sync-vs-async.html OSGi Remote Services and Sync vs. Async Remote Procedure Call]
  
ECF has nightly builds as well as continuous builds on checkin and release builds.  Our builder currently uses Hudson and Buckminster and is hosted at the ECF OSU OSL server.  See [https://ecf2.osuosl.org/hudson/ here for the Hudson dashboard and access to all builds].
+
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
  
[[Building ECF Release 3.2]]
+
[[Distributed EventAdmin Service]]
  
*[[How to VNC to ecf2]]
+
[[Tracing Options for Remote Services]]
  
==New Stuff==
+
===Remote Service Admin===
  
===OSGi 4.2 Remote Services===
+
[[Remote Services Admin|OSGi Remote Service Admin (RSA) Management Agent]]
  
[[Asynchronous Proxies for Remote Services]]
+
===Customization of ECF Remote Services (new Discovery and/or Distribution providers)===
  
[[Getting Started with ECF's OSGi Remote Services Implementation]]
+
[[Tutorial:  Creating a RESTful Remote Service Provider]]
  
[[Using ECF Remote Services Bundles separate from the ECF SDK]]
+
[[iPopo Compatible Providers]]
  
[[Using Spring with ECF Remote Services]]
+
[[REST_abstraction_for_ECF|REST-style Remote Services Providers]]
  
[[OSGi 4.2 Remote Services and ECF]]
+
[[SOAP-based Providers|SOAP-based Remote Services Providers]]
  
[[Distributed EventAdmin Service]]
+
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]]
  
[[Customizing and Extending ECF Remote Services]]
+
[[EIG:Configuration_Properties | Discovery and Distribution Configuration Properties]]
  
[[Discovery and Distribution Listeners | Listeners for ECF's OSGi Remote Services Implementation]]
+
==[http://eclipseecf.blogspot.com/ ECF Blog]==
  
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
+
==ECF Documentation Project==
  
[[Discovery of Remote Services | Network Discovery of Remote Services]]
+
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]
  
[[REST_abstraction_for_ECF|REST-style Remote Services Providers]]
+
* [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 ]
  
[[SOAP-based Providers|SOAP-based Remote Services Providers]]
+
==Additional Documentation==
  
[[Load Balancing Remote Services]]
+
*[[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]]
  
[http://eclipseecf.blogspot.com/2010/02/osgi-remote-services-and-sync-vs-async.html OSGi Remote Services and Sync vs. Async Remote Procedure Call]
+
==Recent Presentations==
  
[[ECF Connection Creation and Management | ECF Container/Connection Creation and Management]]
+
*[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]
  
===Other Cool Stuff===
 
  
[https://bugs.eclipse.org/bugs/show_bug.cgi?id=280347 Google Wave Provider work (bug 280347)]
+
=Development (for contributors & committers)=
  
[[TweetHub]]
+
==ECF Calls and Meetings==
  
[[Newsreader|NNTP Protocol/Newsreader]]
+
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]
  
[[Google Summer of Code ECF Projects for 2009]]
+
===Next Hangout (proposed):  ===
  
[[DocShare Plugin|Real-Time Shared Editing]]
+
===Notes from Recent Meetings===
 +
*[[ECF_Conference_Call_01.07.2013|1.07.2014 Call Agenda and Notes]]
  
[[Extending Real-Time Shared Editing for Use with Other Editors]]
+
====Archive Notes====
  
[[RT Shared Editing - Next Steps]] ([http://www.hantsuki.org/screencasts/ecf-team.htm current progress], subset of relevant bugs are {{bug|237471}}, {{bug|238966}}, and {{bug|239048}})
+
*[[ECF Meeting Notes|Notes from Previous Meetings]]
  
[[Sharing Editor Selections]]
+
===IRC===
  
[[ECF Filetransfer Support for NTLMv2 Proxies]]
+
*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>
  
[[Comments on the Riena Project Goals and Relationship to ECF project]]
+
==Project Planning==
  
[[Remote_Eclipse_RCP_Management | Remote Eclipse RCP Management]]
+
[[Planning for ECF 3.8 | Plan for ECF 3.8]]
  
[[Storage/Retrieval of IDs, IContainers using Equinox Secure Preferences]]
+
[[ECF 4.0 ToDos]]
  
[[Screen Captures over IM]]
+
==Access to Source Code==
  
==ECF Adopters==
+
[http://git.eclipse.org/c/ecf/org.eclipse.ecf.git source code repository]
  
[[ECF/Adopters|ECF Adopters List (please add yourself if you are using ECF)]]
+
[http://git.eclipse.org/c/ecf/ecf.git/ web documentation repository]
  
 
==Coding Conventions==
 
==Coding Conventions==
Line 128: Line 118:
 
source code formatter to use in Eclipse to easily enforce these conventions.
 
source code formatter to use in Eclipse to easily enforce these conventions.
  
==EclipseCon 2009==
+
==Builds==
ECF was busy at EclipseCon 2009, giving a number of talks and tutorials. The photo shows Scott, Mustafa and Markus wrapping up the conference at the Hyatt Bar, which is adjacent to the Santa Clara Convention Center.
+
For your convenience, here is a short overview of ECF activities at EclipseCon 2009:
+
*[http://www.eclipsecon.org/2009/sessions?id=429 Cola: Real-Time Shared Editing with ECF - Striding towards the Future, Multiple Edits at a Time]
+
*[http://www.eclipsecon.org/2009/sessions?id=633 Best Practices for Distributed OSGi Services]
+
*[http://www.eclipsecon.org/2009/sessions?id=618 Distributed OSGi - the ECF way]
+
*[http://www.eclipsecon.org/2009/sessions?id=772 ECF BoF]
+
For those who couldn't make it, if the [http://search.twitter.com/search?q=%23eclipsecon busyness during the conference] is to serve as an indicator, you can expect a flurry of post-con blog posts and tweets to show up, giving you an idea of what EclipseCon 2009 was like.
+
  
<br><br><br><br>
+
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].
==Additional Documentation==
+
  
*[[ECF API Docs]]
+
Both Maven and p2 repositories are available from nightly builds [http://download.ecf-project.org/ here].
*[http://www.eclipse.org/ecf/org.eclipse.ecf.docs/api/ API javadocs]
+
*[[ECF Servers|Servers]]
+
*[[ECF Providers|Providers]]
+
*[[Bot Framework]]
+
  
==Current Projects==
+
==Appendix==
  
*[[TweetHub]]
+
[[ECF/Adopters|ECF Adopters List (please add yourself if you are using ECF)]]
*[[IPC|Inter-Process Communication]]
+
 
+
===Older Projects===
+
*[[Multi-User Sudoku]]
+
*[[Sharing objects over XMPP]]
+
  
 
{{ECF}}
 
{{ECF}}
[[Category:Eclipse Communication Framework]]
 
[[Category:EclipseRT]]
 
[[Category:Draft Documentation]]
 

Revision as of 09:46, 25 June 2014

Container.png

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

OSGi Remote Services and ECF

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

iPopo Compatible Providers

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]

Additional Documentation

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

Project Planning

Plan for ECF 3.8

ECF 4.0 ToDos

Access to Source Code

source code repository

web documentation repository

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 DocumentationJavadocProviders
Development
Development GuidelinesIntegrators Guide

Back to the top