Skip to main content
Jump to: navigation, search

Difference between revisions of "Eclipse Communication Framework Project"

(Introductory Materials)
(What's New)
(123 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Image:container.png|right]]  
+
[[Image:container.png|right|300px]]  
  
=Documentation (for consumers)=
 
 
==OSGi Remote Services==
 
==OSGi Remote Services==
  
===Introductory Materials===
+
===What's New===
  
[[Tutorial: Building your first OSGi Remote Service]]
+
[https://github.com/ECF/grpc-RemoteServicesProvier gRPC Distribution Provider]
  
NEW 3.8.1: [[Tutorial:  Building your first Asynchronous OSGi Remote Service]]
+
[https://www.eclipse.org/ecf/downloads.php ECF 3.14.12]
  
NEW 3.8.1: [[Tutorial:  OSGi Remote Services for the Raspberry Pi]]
+
[https://github.com/ECF/JaxRSProviders Release 1.13.8 of JaxRS Distribution Providers]
  
[[Getting Started with ECF's OSGi Remote Services Implementation]]
+
[[OSGi Remote Service Admin User's Guide]]
 +
 
 +
[[OSGi Services between Python and Java]]
 +
 
 +
[[Gogo Commands for Remote Services Development]]
 +
 
 +
[[Bndtools Support for Remote Services Development]]
 +
 
 +
[[RSA Console Commands]]
 +
 
 +
[[Karaf Remote Management with Eclipse]]
 +
 
 +
[[EIG:Install Timeline Example into Apache Karaf|Install and run TimeService Tutorial in Apache Karaf]]
  
[[OSGi Remote Services and ECF]]
+
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===
  
[[EIG:Download|Download ECF Remote Services/RSA Implementation]]
+
[https://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/releng/org.eclipse.ecf.releng/projectSet-git.psf  Project Set file of active ECF projects]
  
[[EIG:Add to Target Platform|How to Add Remote Services/RSA to Your Target Platform]]
+
[http://www.eclipse.org/ecf Download and Install into Eclipse]
  
NEW 3.8: [[EIG:Install into Apache Karaf|Apache Karaf Install of ECF RS SDK]]
+
[[EIG:Install into Apache Karaf|Apache Karaf Install of ECF RS SDK]]
  
NEW 3.8: [[EIG:Install Timeline Example into Apache Karaf|Install and run Timeline Tutorial in Apache Karaf]]
+
[[EIG:Install Timeline Example into Apache Karaf|Install and run TimeService Tutorial in Apache Karaf]]
  
===More Advanced Usage of OSGi Remote Services===
+
===Tutorials===
  
[[Asynchronous Proxies for Remote Services]]
+
[[Tutorial: JaxRS Remote Services on Karaf]]
  
[http://eclipseecf.blogspot.com/2010/02/osgi-remote-services-and-sync-vs-async.html OSGi Remote Services and Sync vs. Async Remote Procedure Call]
+
[[Using the Bndtools Remote Services Project Templates]]
  
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
+
[[Tutorial:  Python for OSGi Services]]
  
[[Distributed EventAdmin Service]]
+
[[Tutorial:  Using Google RPC/ProtocolBuffers for Remote Services]]
  
[[Tracing Options 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]]
 +
 
 +
[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:  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===
 +
 
 +
[[Discovery Providers]]
 +
 
 +
[[Distribution 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]]
  
===Customization of ECF Remote Services (new Discovery and/or Distribution providers)===
+
===Other Cool Topics===
  
[[Tutorial:  Creating a RESTful Remote Service Provider]]
+
[[ECF Filetransfer Docs (used in Eclipse/P2)|ECF Filetransfer Docs]]
  
[[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]
  
[[SOAP-based Providers|SOAP-based Remote Services Providers]]
+
[[Distributed EventAdmin Service]]
  
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]]
+
[[iPopo Compatible Providers]]
  
[[EIG:Configuration_Properties | Discovery and Distribution Configuration Properties]]
+
[[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 60: Line 103:
 
==ECF Documentation Project==
 
==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]
+
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 67: Line 111:
 
* [[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/latest/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]]
Line 78: Line 120:
 
==Recent Presentations==
 
==Recent Presentations==
  
*[http://www.lemmster.de/publications/Discover_Remote_Services_-_Democamp_HH_2013_-_Markus_Alexander_Kuppe.pdf Democamp presentation by Markus Kuppe]
+
*[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.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):  Tuesday, January 14, 2013 - 1700 UTC/09:00am pacific===
 
 
*[[ECF_Conference_Call_01.14.2013|Proposed agenda for next meeting]]
 
 
===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===
Line 104: Line 130:
 
*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==
+
==Source Code==
  
[[Planning for ECF 3.8 | Plan for ECF 3.8]]
+
[http://git.eclipse.org/c/ecf/org.eclipse.ecf.git source code]
  
[[ECF 4.0 ToDos]]
+
[http://git.eclipse.org/c/ecf/ecf.git/ web documentation]
 
+
==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==
  
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
+
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.
 
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==
+
 
+
[[ECF/Adopters|ECF Adopters List (please add yourself if you are using ECF)]]
+
  
 
{{ECF}}
 
{{ECF}}

Revision as of 16:56, 18 July 2020

Container.png

OSGi Remote Services

What's New

gRPC Distribution Provider

ECF 3.14.12

Release 1.13.8 of JaxRS Distribution Providers

OSGi Remote Service Admin User's Guide

OSGi Services between Python and Java

Gogo Commands for Remote Services Development

Bndtools Support for Remote Services Development

RSA Console Commands

Karaf Remote Management with Eclipse

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

Project Set file of active ECF projects

Download and Install into Eclipse

Apache Karaf Install of ECF RS SDK

Install and run TimeService Tutorial in Apache Karaf

Tutorials

Tutorial: JaxRS Remote Services on Karaf

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

Discovery Providers

Distribution 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

ECF Filetransfer Docs

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