Difference between revisions of "Eclipse Communication Framework Project"

From Eclipsepedia

Jump to: navigation, search
(ECF Documentation Project)
 
(71 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
+
[[Tutorial: Building your first OSGi Remote Service]]
  
{{Asterisk/Numbers}}
+
NEW 3.8.1: [[Tutorial:  Building your first Asynchronous OSGi Remote Service]]
  
* SIP clients can call 420@asterisk.eclipse.org, then enter pin 8276.
+
NEW 3.8.1: [[Tutorial:  OSGi Remote Services for the Raspberry Pi]]
  
===Next Call:  Thursday, Jan 24 - 1700 UTC/9:00am pacific===
+
[[Getting Started with ECF's OSGi Remote Services Implementation]]
  
[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]
+
[[OSGi Remote Services and ECF]]
  
[[ECF Conference Call 1.24.2013|1.24.2013 Call Agenda/Notes]]
+
===Download and Install===
  
*[[ECF Meeting Notes|Notes from Previous Meetings]]
+
[http://www.eclipse.org/ecf Download and Install into Eclipse]
  
===IRC===
+
[[EIG:Install into Apache Karaf|Apache Karaf Install of ECF RS SDK]]
  
*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>
+
[[EIG:Install Timeline Example into Apache Karaf|Install and run Timeline Tutorial in Apache Karaf]]
  
==Project Planning==
+
===More Advanced Usage of OSGi Remote Services===
  
[[Planning for ECF 3.6 | Plan for ECF 3.6]]
+
[[Asynchronous Proxies for Remote Services]]
  
[[ECF 4.0 ToDos]]
+
[http://eclipseecf.blogspot.com/2010/02/osgi-remote-services-and-sync-vs-async.html OSGi Remote Services and Sync vs. Async Remote Procedure Call]
  
==Where's the Source?==
+
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
  
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).
+
[[Distributed EventAdmin Service]]
  
==Builds==
+
[[Tracing Options 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].
+
===Remote Service Admin===
  
Both Maven and p2 repositories are available from nightly builds [http://download.ecf-project.org/ here].
+
[[Remote Services Admin|OSGi Remote Service Admin (RSA) Management Agent]]
  
==New Stuff==
+
===Customization of ECF Remote Services (new Discovery and/or Distribution providers)===
  
===ECF Documentation Project===
+
[[Tutorial:  Creating a RESTful Remote Service Provider]]
  
* [https://bugs.eclipse.org/bugs/show_bug.cgi?id=329124 Documentation project enhancement request (bug 329124)]
+
[[iPopo Compatible Providers]]
* [[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===
+
[[REST_abstraction_for_ECF|REST-style Remote Services Providers]]
  
[[EIG:Download|Download]]
+
[[SOAP-based Providers|SOAP-based Remote Services Providers]]
  
[[EIG:Add to Target Platform|Add to Target Platform]]
+
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]]
  
[[Remote Services Admin]]
+
[[EIG:Configuration_Properties | Discovery and Distribution Configuration Properties]]
  
[[Asynchronous Proxies for Remote Services]]
+
==[http://eclipseecf.blogspot.com/ ECF Blog]==
  
[[Getting Started with ECF's OSGi Remote Services Implementation]]
+
==ECF Documentation Project==
  
[[OSGi 4.2 Remote Services and ECF]]
+
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]
  
[[Distributed EventAdmin Service]]
+
* [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 ]
  
[[File-based Discovery | Static File-based Discovery of Remote Service Endpoints]]
+
==Additional Documentation==
  
[[REST_abstraction_for_ECF|REST-style Remote Services Providers]]
+
*[[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]]
  
[[SOAP-based Providers|SOAP-based Remote Services Providers]]
+
==Recent Presentations==
  
[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://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]
  
[[Comparison of Discovery and Distribution Providers | Technical Comparison of Discovery and Distribution Providers]]
 
  
[[EIG:Configuration_Properties | Discovery and Distribution Configuration Properties]]
+
=Development (for contributors & committers)=
  
===Other Cool Stuff===
+
==ECF Calls and Meetings==
  
[[ECF Servers|Servers]]
+
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]
  
[https://bugs.eclipse.org/bugs/show_bug.cgi?id=310580 DNS-SD based ECF wide area discovery provider (bug 310580)]
+
===Next Hangout (proposed):  ===
  
[https://bugs.eclipse.org/bugs/show_bug.cgi?id=280347 Google Wave Provider work (bug 280347)]
+
===Notes from Recent Meetings===
 +
*[[ECF_Conference_Call_01.07.2013|1.07.2014 Call Agenda and Notes]]
  
[[TweetHub]]
+
====Archive Notes====
  
[[Newsreader|NNTP Protocol/Newsreader]]
+
*[[ECF Meeting Notes|Notes from Previous Meetings]]
  
[[Google_Summer_of_Code_2010 | Google Summer of Code ECF Projects for 2010]]
+
===IRC===
  
[[DocShare Plugin|Real-Time Shared Editing]]
+
*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>
  
[[Extending Real-Time Shared Editing for Use with Other Editors]]
+
==Project Planning==
  
[[Sharing Editor Selections]]
+
[[Planning for ECF 3.8 | Plan for ECF 3.8]]
  
[[ECF Filetransfer Support for NTLMv2 Proxies]]
+
[[ECF 4.0 ToDos]]
  
[[Comments on the Riena Project Goals and Relationship to ECF project]]
+
==Access to Source Code==
  
[[Remote_Eclipse_RCP_Management | Remote Eclipse RCP Management]]
+
[http://git.eclipse.org/c/ecf/org.eclipse.ecf.git source code repository]
  
[[Screen Captures over IM]]
+
[http://git.eclipse.org/c/ecf/ecf.git/ web documentation repository]
 
+
[[ECF/Adopters|ECF Adopters List (please add yourself if you are using ECF)]]
+
  
 
==Coding Conventions==
 
==Coding Conventions==
Line 123: Line 118:
 
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 09:46, 25 June 2014

Container.png

Contents

[edit] Documentation (for consumers)

[edit] OSGi Remote Services

[edit] Introductory Materials

Tutorial: Building your first OSGi Remote Service

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

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

Getting Started with ECF's OSGi Remote Services Implementation

OSGi Remote Services and ECF

[edit] Download and Install

Download and Install into Eclipse

Apache Karaf Install of ECF RS SDK

Install and run Timeline Tutorial in Apache Karaf

[edit] 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

[edit] Remote Service Admin

OSGi Remote Service Admin (RSA) Management Agent

[edit] 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

SOAP-based Remote Services Providers

Technical Comparison of Discovery and Distribution Providers

Discovery and Distribution Configuration Properties

[edit] ECF Blog

[edit] 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]

[edit] Additional Documentation

[edit] Recent Presentations


[edit] Development (for contributors & committers)

[edit] 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

[edit] Next Hangout (proposed):

[edit] Notes from Recent Meetings

[edit] Archive Notes

[edit] IRC

[edit] Project Planning

Plan for ECF 3.8

ECF 4.0 ToDos

[edit] Access to Source Code

source code repository

web documentation repository

[edit] 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.

[edit] 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.

[edit] Appendix

ECF Adopters List (please add yourself if you are using ECF)

Eclipse Communication Framework
API
API DocumentationJavadocProvidersECF/Bot Framework
Components
ServersShared EditingShared Code Plug-in
Development
Development GuidelinesIntegrators Guide