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"

(Additional Documentation)
(Tutorials)
(55 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Image:container.png|right|300px]]  
 
[[Image:container.png|right|300px]]  
  
=Documentation (for consumers)=
 
 
==OSGi Remote Services==
 
==OSGi Remote Services==
  
 
===What's New===
 
===What's New===
  
'''PLEASE NOTE''':  [[Running TimeService examples on Java7]]
+
[[Bndtools Support for Remote Services Development]]
  
There was a talk about the use of Remote Services from Neil Bartlett at EclipseCon 2014.  It was called [https://www.youtube.com/watch?v=Jp2sVAmgrSA Scaling and Orchestrating Microservices with OSGi].   About midway through the talk he discusses the use of Remote Services. Sadly, he doesn't use ECF's open implementation of RSA, but he does make some interesting points about the utility of using Remote Services for scaling microservices across processes.
+
[[RSA Console Commands]]
 +
 
 +
[[Karaf Remote Management with Eclipse]]
 +
 
 +
[https://www.eclipse.org/ecf/downloads.php ECF 3.13.8 Released 9/2/2017]
 +
 
 +
[[EIG:Install Timeline Example into Apache Karaf|Install and run TimeService Tutorial in Apache Karaf]]
 +
 
 +
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!
  
 
===Download and Install===
 
===Download and Install===
Line 18: Line 25:
 
[[EIG:Install Timeline Example into Apache Karaf|Install and run TimeService Tutorial in Apache Karaf]]
 
[[EIG:Install Timeline Example into Apache Karaf|Install and run TimeService Tutorial in Apache Karaf]]
  
===Introductory Materials===
+
===Tutorials===
  
NEW 3.9.2: [[Tutorial:  ECF Remote Services for Accessing Existing REST Services]]
+
[[Using the Bndtools Remote Services Project Templates]]
  
[http://www.eclipse.org/ecf/presentations/ese2014/How%20to%20Cook%20an%20Egg%20with%20the%20Eclipse%20Communication%20Framework.pdf NEW 3.9.1: How to Cook an Egg with ECF (Wim Jongman presentation at EclipseCon 2014)]
+
[[Tutorial: Python for OSGi Services]]
  
[[Tutorial:  Building your first OSGi Remote Service]]
+
[[Tutorial:  Using Google RPC/ProtocolBuffers for Remote Services]]
  
NEW 3.9: [[Tutorial:  Raspberry Pi GPIO with OSGi Services]]
+
[[Tutorial:  Creating Custom Distribution Providers]]
  
NEW 3.9: [[Tutorial:  OSGi Remote Services for Raspberry Pi GPIO]]
+
[[Tutorial:  Exposing a Jax REST service as an OSGi Remote Service]]
  
NEW 3.9.1: [[ECF Remote Services for Raspberry Pi GPIO]]
+
[[Tutorial:  Using REST and OSGi Standards for Micro Services]]
  
NEW Luna: [[Tutorial:  Building your first Asynchronous OSGi Remote Service]]
+
[[Tutorial:  ECF Remote Services for Accessing Existing REST Services]]
  
NEW Luna: [[Tutorial:  OSGi Remote Services for the Raspberry Pi]]
+
[[Tutorial:  Creating a RESTful Remote Service Provider]]
  
[[Getting Started with ECF's OSGi Remote Services Implementation]]
+
[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)]
  
New Luna: [[OSGi Remote Services and ECF|ECF Remote Services Architecture]]
+
[[Tutorial:  Building your first OSGi Remote Service]]
 
+
===Discovery and Distribution Providers===
+
  
====Discovery Providers====
+
[[Tutorial:  Raspberry Pi GPIO with OSGi Services]]
  
[[Zookeeper Based ECF Discovery| Zookeeper Discovery]]
+
[[Tutorial:  OSGi Remote Services for Raspberry Pi GPIO]]
  
[[Etcd-Based Discovery Provider| etcd Discovery]]
+
[[ECF Remote Services for Raspberry Pi GPIO]]
  
[[SLP-Based Discovery Provider| SLP Discovery]]
+
[[Tutorial:  Building your first Asynchronous OSGi Remote Service]]
  
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
+
[[Tutorial:  OSGi Remote Services for the Raspberry Pi]]
  
====Distribution Providers====
+
===Remote Service Distribution and Discovery Providers===
  
 
[[Distribution Providers]]
 
[[Distribution Providers]]
  
[[Distribution Provider Configuration Properties]]
+
[[Discovery Providers]]
  
 
===Remote Service Admin===
 
===Remote Service Admin===
 +
 +
[[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]]
 
[[Remote Services Admin|OSGi Remote Service Admin (RSA) Management Agent]]
  
 
===Other Cool Topics===
 
===Other Cool Topics===
 
[[Tutorial:  Creating a RESTful Remote Service Provider]]
 
  
 
[[Asynchronous Proxies for Remote Services]]
 
[[Asynchronous Proxies for Remote Services]]
Line 73: Line 80:
  
 
[[iPopo Compatible Providers]]
 
[[iPopo Compatible Providers]]
 
[[REST_abstraction_for_ECF|REST-style Remote Services Providers]]
 
  
 
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]]
 
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]]
Line 90: Line 95:
 
* [[EUG:How to Contribute|How to Contribute]]
 
* [[EUG:How to Contribute|How to Contribute]]
 
* [[ECF Documentation Priorities]]
 
* [[ECF Documentation Priorities]]
* [http://download.eclipse.org/rt/ecf/3.8.1/javadoc/index.html ECF API Javadoc ]
+
* [http://download.eclipse.org/rt/ecf/latest/javadoc/index.html ECF API Javadoc ]
  
 
==Real-Time Shared Editing==
 
==Real-Time Shared Editing==
Line 98: Line 103:
  
 
==Recent Presentations==
 
==Recent Presentations==
 +
 +
*[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)]
  
 
*[http://www.lemmster.de/publications/Discover_Remote_Services_-_Democamp_HH_2013_-_Markus_Alexander_Kuppe.pdf Democamp presentation by Markus Kuppe]
 
*[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://www.eclipsecon.org/europe2013/discover-remote-osgi-services Discover Remote OSGi Services]
 
*[http://vimeo.com/14247502 Fun with remote services]
 
*[http://vimeo.com/14247502 Fun with remote services]
 
  
 
=Development (for contributors & committers)=
 
=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===
  
 
*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==
 
 
[[Planning for ECF 3.8 | Plan for ECF 3.8]]
 
 
[[ECF 4.0 ToDos]]
 
  
 
==Access to Source Code==
 
==Access to Source Code==
Line 140: Line 127:
 
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==
+
{{:Eclipse Communication Framework Project/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==
 
==Appendix==

Revision as of 17:19, 19 April 2018

Container.png

OSGi Remote Services

What's New

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 ]https://dev.eclipse.org/mailman/listinfo/ecf-dev ecf-dev mailing list]

Real-Time Shared Editing

Recent Presentations

Development (for contributors & committers)

IRC

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.

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.

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