Jump to: navigation, search

Difference between revisions of "Eclipse Communication Framework Project"

(Introductory Materials)
 
(90 intermediate revisions by 3 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
+
| source = http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/
+
| psf = None
+
}}
+
[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===
  
Participant conference extension: 707, then enter pin 46765
+
[http://www.eclipse.org/ecf/presentations/ese2014/How%20to%20Cook%20an%20Egg%20with%20the%20Eclipse%20Communication%20Framework.pdf NEW 3.9: How to Cook an Egg with ECF (Wim Jongman presentation at EclipseCon 2014)]
  
{{Asterisk/Numbers}}
+
[[Tutorial:  Building your first OSGi Remote Service]]
  
* SIP clients can call 420@asterisk.eclipse.org, then enter pin 8276.
+
NEW 3.9: [[Tutorial:  Raspberry Pi GPIO with OSGi Services]]
  
===Next Call:  Thursday, Jan 24 - 1700 UTC/9:00am pacific===
+
NEW 3.9: [[Tutorial:  OSGi Remote Services for Raspberry Pi GPIO]]
  
[http://www.timeanddate.com/worldclock/fixedtime.html?year=2013&month=01&day=24&hour=17&min=00&sec=0 Jan 24, 2013, 1700 UTC/9:00am pacific time]
+
NEW 3.9.1: [[ECF Remote Services for Raspberry Pi GPIO]]
  
[[ECF Conference Call 1.24.2013|1.24.2013 Call Agenda/Notes]]
+
NEW Luna: [[Tutorial:  Building your first Asynchronous OSGi Remote Service]]
  
*[[ECF Meeting Notes|Notes from Previous Meetings]]
+
NEW Luna: [[Tutorial:  OSGi Remote Services for the Raspberry Pi]]
  
===IRC===
+
[[Getting Started with ECF's OSGi Remote Services Implementation]]
  
*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>
+
New Luna: [[OSGi Remote Services and ECF|ECF Remote Services Architecture]]
  
==Project Planning==
+
===Download and Install===
  
[[Planning for ECF 3.6 | Plan for ECF 3.6]]
+
[http://www.eclipse.org/ecf Download and Install into Eclipse]
  
[[ECF 4.0 ToDos]]
+
[[EIG:Install into Apache Karaf|Apache Karaf Install of ECF RS SDK]]
  
==Where's the Source?==
+
[[EIG:Install Timeline Example into Apache Karaf|Install and run TimeService Tutorial in Apache Karaf]]
  
ECF is now using git...to make contributions easier.  The ECF git repository is [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git here] (git://git.eclipse.org/gitroot/ecf/org.eclipse.ecf.git).
+
===More Advanced Usage of OSGi Remote Services===
  
==Builds==
+
[[Asynchronous Proxies for Remote Services]]
  
ECF has nightly and continuous builds with automated testing.  It uses Jenkins and Buckminster and is hosted at the Oregon State University Open Source Lab.  See [https://build.ecf-project.org/jenkins/ here].
+
[http://eclipseecf.blogspot.com/2010/02/osgi-remote-services-and-sync-vs-async.html OSGi Remote Services and Sync vs. Async Remote Procedure Call]
  
Both Maven and p2 repositories are available from nightly builds [http://download.ecf-project.org/ here].
+
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
  
==New Stuff==
+
[[Distributed EventAdmin Service]]
  
===ECF Documentation Project===
+
[[Tracing Options for Remote Services]]
  
* [https://bugs.eclipse.org/bugs/show_bug.cgi?id=329124 Documentation project enhancement request (bug 329124)]
+
===Remote Service Admin===
* [[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]]
+
  
===OSGi Remote Services===
+
[[Remote Services Admin|OSGi Remote Service Admin (RSA) Management Agent]]
  
[[EIG:Download|Download]]
+
===Customization of ECF Remote Services (new Discovery and/or Distribution providers)===
  
[[EIG:Add to Target Platform|Add to Target Platform]]
+
[[Tutorial: Creating a RESTful Remote Service Provider]]
  
[[Remote Services Admin]]
+
[[iPopo Compatible Providers]]
  
[[Asynchronous Proxies for Remote Services]]
+
[[REST_abstraction_for_ECF|REST-style Remote Services Providers]]
  
[[Getting Started with ECF's OSGi Remote Services Implementation]]
+
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]]
  
[[OSGi 4.2 Remote Services and ECF]]
+
[[EIG:Configuration_Properties | Distribution Provider Configuration Properties (ECF generic, r-OSGi, Restlet)]]
  
[[Distributed EventAdmin Service]]
+
[[Zookeeper Based ECF Discovery]]
  
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
+
[[Etcd-Based Discovery Provider]]
  
[[REST_abstraction_for_ECF|REST-style Remote Services Providers]]
+
==[http://eclipseecf.blogspot.com/ ECF Blog]==
  
[[SOAP-based Providers|SOAP-based Remote Services Providers]]
+
==ECF Documentation Project==
  
[http://eclipseecf.blogspot.com/2010/02/osgi-remote-services-and-sync-vs-async.html OSGi Remote Services and Sync vs. Async Remote Procedure Call]
+
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]
  
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution 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 ]
  
[[EIG:Configuration_Properties | Discovery and Distribution Configuration Properties]]
+
==Additional Documentation==
  
===Other Cool Stuff===
+
*[[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]]
  
[[ECF Servers|Servers]]
+
==Recent Presentations==
  
[https://bugs.eclipse.org/bugs/show_bug.cgi?id=310580 DNS-SD based ECF wide area discovery provider (bug 310580)]
+
*[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]
  
[https://bugs.eclipse.org/bugs/show_bug.cgi?id=280347 Google Wave Provider work (bug 280347)]
 
  
[[TweetHub]]
+
=Development (for contributors & committers)=
  
[[Newsreader|NNTP Protocol/Newsreader]]
+
==ECF Calls and Meetings==
  
[[Google_Summer_of_Code_2010 | Google Summer of Code ECF Projects for 2010]]
+
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]
  
[[DocShare Plugin|Real-Time Shared Editing]]
+
===Next Hangout (proposed):  ===
  
[[Extending Real-Time Shared Editing for Use with Other Editors]]
+
===Notes from Recent Meetings===
 +
*[[ECF_Conference_Call_01.07.2013|1.07.2014 Call Agenda and Notes]]
  
[[Sharing Editor Selections]]
+
====Archive Notes====
  
[[ECF Filetransfer Support for NTLMv2 Proxies]]
+
*[[ECF Meeting Notes|Notes from Previous Meetings]]
  
[[Comments on the Riena Project Goals and Relationship to ECF project]]
+
===IRC===
  
[[Remote_Eclipse_RCP_Management | Remote Eclipse RCP Management]]
+
*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>
  
[[Screen Captures over IM]]
+
==Project Planning==
  
[[ECF/Adopters|ECF Adopters List (please add yourself if you are using ECF)]]
+
[[Planning for ECF 3.8 | Plan for ECF 3.8]]
 +
 
 +
[[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==
 
==Coding Conventions==
Line 123: Line 128:
 
source code formatter to use in Eclipse to easily enforce these conventions.
 
source code formatter to use in Eclipse to easily enforce these conventions.
  
==Presentations==
+
==Builds==
  
*[[media:ESE 2010 presentationv2.pdf|ESE 2010 presentation.pdf]]
+
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].
*[http://wiki.eclipse.org/images/f/f3/ESE_2010_presentation.pdf ESE 2010 presentation.pdf]
+
*[http://vimeo.com/14247502 Fun with remote services]
+
*[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]
+
  
==Additional Documentation==
+
Both Maven and p2 repositories are available from nightly builds [http://download.ecf-project.org/ here].
  
*[[Disabling Apache Httpclient]]
+
==Appendix==
*[[ECF API Docs]]
+
 
*[http://www.eclipse.org/ecf/org.eclipse.ecf.docs/api/ API javadocs]
+
[[ECF/Adopters|ECF Adopters List (please add yourself if you are using ECF)]]
*[[ECF Servers|Servers]]
+
*[[ECF Providers|Providers]]
+
*[[Bot Framework]]
+
*[[ECF Connection Creation and Management | ECF Container/Connection Creation and Management]]
+
  
 
{{ECF}}
 
{{ECF}}
[[Category:Eclipse Communication Framework]]
 
[[Category:EclipseRT]]
 
[[Category:Draft Documentation]]
 
[[Category:ECF]]
 

Latest revision as of 21:18, 30 October 2014

Container.png

Documentation (for consumers)

OSGi Remote Services

Introductory Materials

NEW 3.9: How to Cook an Egg with ECF (Wim Jongman presentation at EclipseCon 2014)

Tutorial: Building your first OSGi Remote Service

NEW 3.9: Tutorial: Raspberry Pi GPIO with OSGi Services

NEW 3.9: Tutorial: OSGi Remote Services for Raspberry Pi GPIO

NEW 3.9.1: ECF Remote Services for Raspberry Pi GPIO

NEW Luna: Tutorial: Building your first Asynchronous OSGi Remote Service

NEW Luna: Tutorial: OSGi Remote Services for the Raspberry Pi

Getting Started with ECF's OSGi Remote Services Implementation

New Luna: ECF Remote Services Architecture

Download and Install

Download and Install into Eclipse

Apache Karaf Install of ECF RS SDK

Install and run TimeService 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

Technical Comparison of Discovery and Distribution Providers

Distribution Provider Configuration Properties (ECF generic, r-OSGi, Restlet)

Zookeeper Based ECF Discovery

Etcd-Based Discovery Provider

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 DocumentationJavadocProvidersECF/Bot Framework
Development
Development GuidelinesIntegrators Guide