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)
(228 intermediate revisions by 7 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 = 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==
+
==OSGi Remote Services==
  
ECF has weekly conference calls to discuss current and future issues on our roadmap. Anyone is welcome to join us.
+
===What's New===
*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#
+
[[Gogo Commands for Remote Services Development]]
===Bucky / Hudson session on September 18, 2010, 0700 UTC/10:00am pacific time===
+
  
[http://www.timeanddate.com/worldclock/fixedtime.html?year=2010&month=09&day=18&hour=07&min=00&sec=0 September 18, 2010, 0700 UTC/10:00am pacific time]
+
[[Bndtools Support for Remote Services Development]]
  
===Next Conference Call:  Monday, February 28, 2010 - 1800 UTC/10:00am pacific===
+
[[RSA Console Commands]]
  
[http://www.timeanddate.com/worldclock/fixedtime.html?year=2011&month=2&day=28&hour=18&min=00&sec=0 February 28, 2011, 1800 UTC/10:00am pacific time]
+
[[Karaf Remote Management with Eclipse]]
  
[[ECF Conference Call 2.28.2011|2.28.2011 Call Agenda/Notes]]
+
[https://www.eclipse.org/ecf/downloads.php ECF 3.13.8 Released 9/2/2017]
  
*[[ECF Meeting Notes|Notes from Previous Meetings]]
+
[[EIG:Install Timeline Example into Apache Karaf|Install and run TimeService Tutorial in Apache Karaf]]
  
[http://www.google.com/calendar/embed?src=q0gpojsaatmup0uilkklpe409c%40group.calendar.google.com&ctz=America/Los_Angeles Google Calendar]
+
Christoph Keimel presented a very cool [http://de.slideshare.net/keimel/how-to-diffuse-a-bomb-with-ecf-and-efxclipse Internet of Things game based upon ECF Remote Services] at [http://eclipsesource.com/blogs/2015/12/23/eclipse-democamp-december-munich-2015/ Eclipse Democamp].   [http://de.slideshare.net/keimel/how-to-diffuse-a-bomb-with-ecf-and-efxclipse Check it out]...it's really cool!
  
===Public and Private Chat Groups===
+
===Download and Install===
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>
+
[http://www.eclipse.org/ecf Download and Install into Eclipse]
*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> (Runs completely on ECF software)'''
+
  
==Project Planning==
+
[[EIG:Install into Apache Karaf|Apache Karaf Install of ECF RS SDK]]
  
[http://www.eclipse.org/projects/project-plan.php?projectid=rt.ecf Current Project Plan]
+
[[EIG:Install Timeline Example into Apache Karaf|Install and run TimeService Tutorial in Apache Karaf]]
  
[[ECF 4.0 ToDo collection]]
+
===Tutorials===
  
==Builds==
+
[[Using the Bndtools Remote Services Project Templates]]
  
ECF has nightly builds as well as continuous builds on checkin and release builds.  Our builder currently uses Jenkins and Buckminster and is hosted at the ECF OSU OSL build server.  See [https://build.ecf-project.org/hudson/ here for the Hudson dashboard and access to all builds].
+
[[Tutorial: Python for OSGi Services]]
  
Both Maven and p2 repositories are available for nightly builds [http://download.ecf-project.org/ here].
+
[[Tutorial: Using Google RPC/ProtocolBuffers for Remote Services]]
  
==New Stuff==
+
[[Tutorial:  Creating Custom Distribution Providers]]
  
===ECF Documentation Project===
+
[[Tutorial:  Exposing a Jax REST service as an OSGi Remote Service]]
  
* [https://bugs.eclipse.org/bugs/show_bug.cgi?id=329124 Documentation project enhancement request (bug 329124)]
+
[[Tutorial: Using REST and OSGi Standards for Micro Services]]
* [[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 4.2 Remote Services Admin===
+
[[Tutorial:  ECF Remote Services for Accessing Existing REST Services]]
  
[[Remote Services Admin]]
+
[[Tutorial:  Creating a RESTful Remote Service Provider]]
  
[[Asynchronous Proxies for Remote Services]]
+
[http://www.eclipse.org/ecf/presentations/ese2014/How%20to%20Cook%20an%20Egg%20with%20the%20Eclipse%20Communication%20Framework.pdf How to Cook an Egg with ECF (Wim Jongman presentation at EclipseCon 2014)]
  
[[Getting Started with ECF's OSGi Remote Services Implementation]]
+
[[Tutorial:  Building your first OSGi Remote Service]]
  
[[Using ECF Remote Services Bundles separate from the ECF SDK]]
+
[[Tutorial:  Raspberry Pi GPIO with OSGi Services]]
  
[[Using Spring with ECF Remote Services]]
+
[[Tutorial:  OSGi Remote Services for Raspberry Pi GPIO]]
  
[[OSGi 4.2 Remote Services and ECF]]
+
[[ECF Remote Services for Raspberry Pi GPIO]]
  
[[Distributed EventAdmin Service]]
+
[[Tutorial:  Building your first Asynchronous OSGi Remote Service]]
  
[[Discovery and Distribution Listeners | Listeners for ECF's OSGi Remote Services Implementation]]
+
[[Tutorial:  OSGi Remote Services for the Raspberry Pi]]
  
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
+
===Remote Service Distribution and Discovery Providers===
  
[[Discovery of Remote Services | Network Discovery of Remote Services]]
+
[[Distribution Providers]]
  
[[REST_abstraction_for_ECF|REST-style Remote Services Providers]]
+
[[Discovery Providers]]
  
[[SOAP-based Providers|SOAP-based Remote Services Providers]]
+
===Remote Service Admin===
  
[[Load Balancing Remote Services]]
+
[[Getting Started with ECF's OSGi Remote Services Implementation]]
 +
 
 +
[[OSGi Remote Services and ECF|ECF Remote Services Architecture]]
 +
 
 +
[[Remote Services Admin|OSGi Remote Service Admin (RSA) Management Agent]]
 +
 
 +
===Other Cool Topics===
 +
 
 +
[[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]
 
[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 Connection Creation and Management | ECF Container/Connection Creation and Management]]
+
[[Distributed EventAdmin Service]]
  
===Other Cool Stuff===
+
[[iPopo Compatible Providers]]
  
[https://bugs.eclipse.org/bugs/show_bug.cgi?id=310580 DNS-SD based ECF wide area discovery provider (bug 310580)]
+
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]]
  
[https://bugs.eclipse.org/bugs/show_bug.cgi?id=280347 Google Wave Provider work (bug 280347)]
+
==[http://eclipseecf.blogspot.com/ ECF Blog]==
  
[[TweetHub]]
+
==ECF Documentation Project==
  
[[Newsreader|NNTP Protocol/Newsreader]]
+
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]
  
[[Google_Summer_of_Code_2010 | Google Summer of Code ECF Projects for 2010]]
+
*[[Remote Service SDK - Annotated listing of bundles included in SDK]]
 +
* [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/latest/javadoc/index.html ECF API Javadoc ]
  
[[DocShare Plugin|Real-Time Shared Editing]]
+
==Real-Time Shared Editing==
  
[[Extending Real-Time Shared Editing for Use with Other Editors]]
+
*[[DocShare Plugin|Real-Time Shared Editing]]
 +
*[[Extending Real-Time Shared Editing for Use with Other Editors]]
  
[[Sharing Editor Selections]]
+
==Recent Presentations==
  
[[ECF Filetransfer Support for NTLMv2 Proxies]]
+
*[http://www.eclipse.org/ecf/presentations/ese2014/How%20to%20Cook%20an%20Egg%20with%20the%20Eclipse%20Communication%20Framework.pdf How to Cook an Egg with ECF (Wim Jongman presentation at EclipseCon 2014)]
  
[[Comments on the Riena Project Goals and Relationship to ECF project]]
+
*[http://vimeo.com/14247502 Fun with remote services]
  
[[Remote_Eclipse_RCP_Management | Remote Eclipse RCP Management]]
+
=Development (for contributors & committers)=
  
[[Screen Captures over IM]]
+
===IRC===
  
[[ECF/Adopters|ECF Adopters List (please add yourself if you are using ECF)]]
+
*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>
  
==Coding Conventions==
+
==Source Code==
  
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
+
[http://git.eclipse.org/c/ecf/org.eclipse.ecf.git source code]
source code formatter to use in Eclipse to easily enforce these conventions.
+
  
==Presentations==
+
[http://git.eclipse.org/c/ecf/ecf.git/ web documentation]
  
*[[media:ESE 2010 presentationv2.pdf|ESE 2010 presentation.pdf]]
+
==Coding Conventions==
*[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==
+
ECF is using 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.
  
*[[ECF API Docs]]
+
{{:Eclipse Communication Framework Project/Builds}}
*[http://www.eclipse.org/ecf/org.eclipse.ecf.docs/api/ API javadocs]
+
*[[ECF Servers|Servers]]
+
*[[ECF Providers|Providers]]
+
*[[Bot Framework]]
+
  
 
{{ECF}}
 
{{ECF}}
[[Category:Eclipse Communication Framework]]
 
[[Category:EclipseRT]]
 
[[Category:Draft Documentation]]
 
[[Category:ECF]]
 

Revision as of 15:40, 17 May 2018

Container.png

OSGi Remote Services

What's New

Gogo Commands for Remote Services Development

Bndtools Support for Remote Services Development

RSA Console Commands

Karaf Remote Management with Eclipse

ECF 3.13.8 Released 9/2/2017

Install and run TimeService Tutorial in Apache Karaf

Christoph Keimel presented a very cool Internet of Things game based upon ECF Remote Services at Eclipse Democamp. Check it out...it's really cool!

Download and Install

Download and Install into Eclipse

Apache Karaf Install of ECF RS SDK

Install and run TimeService Tutorial in Apache Karaf

Tutorials

Using the Bndtools Remote Services Project Templates

Tutorial: Python for OSGi Services

Tutorial: Using Google RPC/ProtocolBuffers for Remote Services

Tutorial: Creating Custom Distribution Providers

Tutorial: Exposing a Jax REST service as an OSGi Remote Service

Tutorial: Using REST and OSGi Standards for Micro Services

Tutorial: ECF Remote Services for Accessing Existing REST Services

Tutorial: Creating a RESTful Remote Service Provider

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

Tutorial: Building your first OSGi Remote Service

Tutorial: Raspberry Pi GPIO with OSGi Services

Tutorial: OSGi Remote Services for Raspberry Pi GPIO

ECF Remote Services for Raspberry Pi GPIO

Tutorial: Building your first Asynchronous OSGi Remote Service

Tutorial: OSGi Remote Services for the Raspberry Pi

Remote Service Distribution and Discovery Providers

Distribution Providers

Discovery Providers

Remote Service Admin

Getting Started with ECF's OSGi Remote Services Implementation

ECF Remote Services Architecture

OSGi Remote Service Admin (RSA) Management Agent

Other Cool Topics

Asynchronous Proxies for Remote Services

OSGi Remote Services and Sync vs. Async Remote Procedure Call

Distributed EventAdmin Service

iPopo Compatible Providers

Technical Comparison of Discovery and Distribution Providers

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 ecf-dev mailing list

Real-Time Shared Editing

Recent Presentations

Development (for contributors & committers)

IRC

Source Code

source code

web documentation

Coding Conventions

ECF is using the Equinox Coding Conventions. Also on this page are links to java source code formatter to use in Eclipse to easily enforce these conventions.

Build

ECF has nightly and continuous builds with automated integration testing. We use Jenkins and Tycho running on the ECF JIPP Instance.

Latest p2 snapshot repository is available here. Show Directory Contents, the site.p2 directory is the p2 repository, the zip contains the contents as zip.

Maven release repositories are available at maven central.

See ECF downloads for more information.

Eclipse Communication Framework
API
API DocumentationJavadocProviders
Development
Development GuidelinesIntegrators Guide

Back to the top