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"

(Introductory Materials)
(25 intermediate revisions by 2 users not shown)
Line 6: Line 6:
 
===What's New===
 
===What's New===
  
There was a talk about the use of OSGi 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 OSGi Remote Services.  He doesn't use ECF's open implementation of RSA, but he does make some interesting points about the utility of using OSGi Remote Services for scaling microservices across processes.
+
'''PLEASE NOTE''': [[Running TimeService examples on Java7]]
===Introductory Materials===
+
  
NEW 3.9.2: [[Tutorial:  ECF Remote Services for Accessing Existing REST Services]]
+
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.
  
[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)]
+
===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 TimeService Tutorial in Apache Karaf]]
 +
 
 +
===Tutorials and Other Introductory Materials===
 +
 
 +
[[Tutorial:  ECF Remote Services for Accessing Existing REST 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)]
  
 
[[Tutorial:  Building your first OSGi Remote Service]]
 
[[Tutorial:  Building your first OSGi Remote Service]]
  
NEW 3.9: [[Tutorial:  Raspberry Pi GPIO with OSGi Services]]
+
[[Tutorial:  Raspberry Pi GPIO with OSGi Services]]
  
NEW 3.9: [[Tutorial:  OSGi Remote Services for Raspberry Pi GPIO]]
+
[[Tutorial:  OSGi Remote Services for Raspberry Pi GPIO]]
  
NEW 3.9.1: [[ECF Remote Services for Raspberry Pi GPIO]]
+
[[ECF Remote Services for Raspberry Pi GPIO]]
  
NEW Luna: [[Tutorial:  Building your first Asynchronous OSGi Remote Service]]
+
[[Tutorial:  Building your first Asynchronous OSGi Remote Service]]
  
NEW Luna: [[Tutorial:  OSGi Remote Services for the Raspberry Pi]]
+
[[Tutorial:  OSGi Remote Services for the Raspberry Pi]]
  
 
[[Getting Started with ECF's OSGi Remote Services Implementation]]
 
[[Getting Started with ECF's OSGi Remote Services Implementation]]
  
New Luna: [[OSGi Remote Services and ECF|ECF Remote Services Architecture]]
+
[[OSGi Remote Services and ECF|ECF Remote Services Architecture]]
  
===Download and Install===
+
===Discovery and Distribution Providers===
  
[http://www.eclipse.org/ecf Download and Install into Eclipse]
+
====Discovery Providers====
  
[[EIG:Install into Apache Karaf|Apache Karaf Install of ECF RS SDK]]
+
*[[Zookeeper Based ECF Discovery| Zookeeper Discovery]]
  
[[EIG:Install Timeline Example into Apache Karaf|Install and run TimeService Tutorial in Apache Karaf]]
+
*[[Etcd-Based Discovery Provider| etcd Discovery]]
  
===More Advanced Usage of OSGi Remote Services===
+
*[[SLP-Based Discovery Provider| SLP Discovery]]
  
[[Asynchronous Proxies for Remote Services]]
+
*[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
  
[http://eclipseecf.blogspot.com/2010/02/osgi-remote-services-and-sync-vs-async.html OSGi Remote Services and Sync vs. Async Remote Procedure Call]
+
====Distribution Providers====
  
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
+
*[[Distribution Providers]]
  
[[Distributed EventAdmin Service]]
+
*[[Distribution Provider Configuration Properties]]
 
+
[[Tracing Options for Remote Services]]
+
  
 
===Remote Service Admin===
 
===Remote Service Admin===
Line 53: Line 62:
 
[[Remote Services Admin|OSGi Remote Service Admin (RSA) Management Agent]]
 
[[Remote Services Admin|OSGi Remote Service Admin (RSA) Management Agent]]
  
===Customization of ECF Remote Services (new Discovery and/or Distribution providers)===
+
===Other Cool Topics===
  
 
[[Tutorial:  Creating a RESTful Remote Service Provider]]
 
[[Tutorial:  Creating a RESTful Remote Service Provider]]
  
[[iPopo Compatible Providers]]
+
[[Asynchronous Proxies for Remote Services]]
  
[[REST_abstraction_for_ECF|REST-style Remote Services Providers]]
+
[http://eclipseecf.blogspot.com/2010/02/osgi-remote-services-and-sync-vs-async.html OSGi Remote Services and Sync vs. Async Remote Procedure Call]
  
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]]
+
[[Distributed EventAdmin Service]]
  
[[EIG:Configuration_Properties | Distribution Provider Configuration Properties (ECF generic, r-OSGi, Restlet)]]
+
[[iPopo Compatible Providers]]
  
[[Zookeeper Based ECF Discovery]]
+
[[REST_abstraction_for_ECF|REST Remote Services Providers]]
  
[[Etcd-Based Discovery Provider]]
+
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]]
  
 
==[http://eclipseecf.blogspot.com/ ECF Blog]==
 
==[http://eclipseecf.blogspot.com/ ECF Blog]==
Line 75: Line 84:
 
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]
 
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]
  
 +
*[[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)]
 
* [https://bugs.eclipse.org/bugs/show_bug.cgi?id=329124 Documentation project enhancement request (bug 329124)]
 
* [[EUG:Users Guide|Users Guide (work in progress)]]
 
* [[EUG:Users Guide|Users Guide (work in progress)]]
Line 82: Line 92:
 
* [http://download.eclipse.org/rt/ecf/3.8.1/javadoc/index.html ECF API Javadoc ]
 
* [http://download.eclipse.org/rt/ecf/3.8.1/javadoc/index.html ECF API Javadoc ]
  
==Additional Documentation==
+
==Real-Time Shared Editing==
  
*[[ECF Servers|Servers]]
 
*[[ECF Providers|Providers]]
 
*[[ECF Connection Creation and Management | ECF Container/Connection Creation and Management]]
 
 
*[[DocShare Plugin|Real-Time Shared Editing]]
 
*[[DocShare Plugin|Real-Time Shared Editing]]
 
*[[Extending Real-Time Shared Editing for Use with Other Editors]]
 
*[[Extending Real-Time Shared Editing for Use with Other Editors]]
  
 
==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)=

Revision as of 21:14, 15 July 2015

Container.png

Documentation (for consumers)

OSGi Remote Services

What's New

PLEASE NOTE: Running TimeService examples on Java7

There was a talk about the use of Remote Services from Neil Bartlett at EclipseCon 2014. It was called 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.

Download and Install

Download and Install into Eclipse

Apache Karaf Install of ECF RS SDK

Install and run TimeService Tutorial in Apache Karaf

Tutorials and Other Introductory Materials

Tutorial: ECF Remote Services for Accessing Existing REST Services

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

Getting Started with ECF's OSGi Remote Services Implementation

ECF Remote Services Architecture

Discovery and Distribution Providers

Discovery Providers

Distribution Providers

Remote Service Admin

OSGi Remote Service Admin (RSA) Management Agent

Other Cool Topics

Tutorial: Creating a RESTful Remote Service Provider

Asynchronous Proxies for Remote Services

OSGi Remote Services and Sync vs. Async Remote Procedure Call

Distributed EventAdmin Service

iPopo Compatible Providers

REST Remote Services 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)

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