Skip to main content
Jump to: navigation, search

Difference between revisions of "Distribution Providers"

(OSGi R7 Supported Intents)
(Jackson Jax-RS Distribution Provider)
 
(109 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
==Introduction==
 
==Introduction==
  
New:  ECF OSGi R7 Remote Services.  The [https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.htmlOSGi R7 Remote Services] adds the standardization of several [https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 intents].  One of those intents is the [osgi.async intent], which allows remote services to be invoked asynchronously (non-blocking) rather than synchronously (blocking).  Supporting async and the other standardized intents:  [https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#service.remoteservices-osgi.basic osgi.basic], [https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#d0e1474 osgi.private], [https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#d0e1464 osgi.confidential] requires a distribution provider that supports that intent.  For each distribution provider below, the currently supported intents are listed.  To request support for an unsupported intent, please post the request to the [https://accounts.eclipse.org/mailing-list/ecf-dev ecf-dev mailing list].
+
The OSGi R7 Remote Services/Remote Service Admin specifications (chaps 100 and 122 in [https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteserviceadmin.html OSGi Enterprise spec]) allows for the use of multiple distribution providers.  Distribution providers are responsible for the actual marshalling/serialization and network communication when a consumer invokes a remote service method.
 
+
The Remote Services/Remote Service Admin specifications (chaps 100 and 122 in [https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteserviceadmin.html OSGi Enterprise spec]) allows for the use of multiple distribution providers.  Distribution providers are responsible for the actual marshalling/serialization and network communication when a consumer invokes a remote service method.
+
  
 
The [[OSGi_Remote_Services_and_ECF | ECF Architecture]] also allows the use of multiple distribution providers.  Further, ECF's open APIs and implementations supports the creation of custom distribution providers using any desired transport protocols, serialization formats and/or libraries.
 
The [[OSGi_Remote_Services_and_ECF | ECF Architecture]] also allows the use of multiple distribution providers.  Further, ECF's open APIs and implementations supports the creation of custom distribution providers using any desired transport protocols, serialization formats and/or libraries.
Line 9: Line 7:
 
==Remote Services API==
 
==Remote Services API==
  
ECF's API for distribution providers is the Remote Services API (RSAPI).  Implementing this API is the only thing required to create a RS/RSA standards compliant distribution provider.
+
ECF's API for distribution providers is the Remote Services API (RSAPI).  Implementing this API is the only requirement to create a RS/RSA standards compliant distribution provider.  All of the distribution providers implement the RSAPI.
  
 
Symbolic Name:  [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf.remoteservice org.eclipse.ecf.remoteservice]<br>
 
Symbolic Name:  [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf.remoteservice org.eclipse.ecf.remoteservice]<br>
 
Minimum EE: J2SE-1.7+<br>
 
Minimum EE: J2SE-1.7+<br>
 
Dependencies<br>
 
Dependencies<br>
*Framework: OSGi R6+ (Equinox Mars+)
+
*Framework: OSGi R6+ (Equinox Mars+ or Felix 5.2.0+)
 
*ECF Core Bundles:  [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf org.eclipse.ecf], [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf.identity org.eclipse.ecf.identity]
 
*ECF Core Bundles:  [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf org.eclipse.ecf], [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf.identity org.eclipse.ecf.identity]
 
*org.eclipse.equinox.concurrent.future bundle
 
*org.eclipse.equinox.concurrent.future bundle
 
*org.eclipse.ecf.remoteservice.asyncproxy bundle version 1.X (Java 7) or 2.X (Java 8)
 
*org.eclipse.ecf.remoteservice.asyncproxy bundle version 1.X (Java 7) or 2.X (Java 8)
 
+
<br>
 
[http://download.eclipse.org/rt/ecf/latest/javadoc/org/eclipse/ecf/remoteservice/package-summary.html Remote Service API Javadoc]<br>
 
[http://download.eclipse.org/rt/ecf/latest/javadoc/org/eclipse/ecf/remoteservice/package-summary.html Remote Service API Javadoc]<br>
  
All ECF RSA distribution providers implement the RSAPI.
+
==Generic Provider==
  
==XML-RPC Provider==
+
The generic providers are based upon tcp transport socket api.  They are built and released as part of the Eclipse Foundation project releases.  See the ECF [https://www.eclipse.org/ecf/downloads.php Download Page].
  
====OSGi Configuration Types====
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1698916 Service Exported Config Types]====
'''ecf.xmlrpc.server''', '''ecf.xmlrpc.client'''<br>
+
'''ecf.generic.server''', '''ecf.generic.client''', '''ecf.generic.ssl.server''', '''ecf.generic.ssl.client'''<br>
  
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 OSGi R7 Supported Intents]====
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 Supported Intents]====
  
 
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
 
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
  
===Bundles===
+
===[[ECF_Generic_Provider_Configuration_Properties#Remote_Service_Configuration_Properties |  Service Properties ]]===  
  
org.eclipse.ecf.provider.xmlrpc<br>
+
===Provider Bundles===
  
===Download/Install===
+
[https://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf.sharedobject org.eclipse.ecf.sharedobject]<br>
 +
[https://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf.provider org.eclipse.ecf.provider]<br> [https://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/providers/bundles/org.eclipse.ecf.provider.remoteservice org.eclipse.ecf.provider.remoteservice]<br>
  
'''[https://github.com/ECF/XmlRpcProvider/releases]'''
+
===Download/Install/Develop===
  
===Source Code===
+
See [https://www.eclipse.org/ecf/downloads.php Download Page]<br>
  
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/XmlRpcProvider ECF XML-RPC Provider Github Repo], Paths:<br>
+
====Bndtools Templates====
'''org.eclipse.ecf.provider.xmlrpc''': bundles/org.eclipse.ecf.provider.xmlrpc<br>
+
  
===Examples===
+
The Bndtools Workspace has bndrun templates to us this distribution provider.  See the [[Bndtools Support for Remote Services Development]] tutorial
  
See hello example in released distribution and in source code under examples/
+
====Karaf Feature====
  
==Generic Provider==
+
Part of ECF SDK:  https://download.eclipse.org/rt/ecf/latest/karaf-features.xml
  
The generic providers are based upon tcp transport socket api.
+
See [https://wiki.eclipse.org/EIG:Install_into_Apache_Karaf  Karaf Install Instructions]
  
===OSGi Configuration Types===
+
See [https://www.eclipse.org/ecf/downloads.php Download Page]<br>
'''ecf.generic.server''', '''ecf.generic.client''', '''ecf.generic.ssl.server''', '''ecf.generic.ssl.client'''<br>
+
  
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 OSGi R7 Supported Intents]====
+
====Source Code====
  
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
+
Git Repo: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git ECF Git Repo]
  
[[ECF_Generic_Provider_Configuration_Properties#Remote_Service_Configuration_Properties |  See here ]] for a description for generic-provider-specific service properties such as ecf.generic.server.hostname, ecf.generic.server.port, etc.
+
====P2 Repo====
  
===Bundles===
+
Part of ECF SDK:  https://download.eclipse.org/rt/ecf/latest/site.p2/
 
+
org.eclipse.ecf.provider, org.eclipse.ecf.provider.remoteservice
+
 
+
===Download/Install===
+
  
 
See [https://www.eclipse.org/ecf/downloads.php Download Page]<br>
 
See [https://www.eclipse.org/ecf/downloads.php Download Page]<br>
 
===Source Code===
 
 
Git Repo: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git ECF Git Repo], Paths:<br>
 
'''org.eclipse.ecf.provider''': framework/bundles/org.eclipse.ecf.provider<br>
 
'''org.eclipse.ecf.provider.remoteservice''':  providers/bundles/org.eclipse.ecf.provider.remoteservice
 
  
 
===Tutorials and Examples===
 
===Tutorials and Examples===
Line 82: Line 69:
 
==r-OSGi Provider==
 
==r-OSGi Provider==
  
===OSGi Configuration Types/ECF Container Types===
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1698916 Service Exported Config Types]====
 
'''ecf.r_osgi.peer''', '''ecf.r_osgi.peer.ws'''  (see r-OSGi over Websockets below), '''ecf.r_osgi.peer.wss''' (see r-OSGi over Websockets below)<br>
 
'''ecf.r_osgi.peer''', '''ecf.r_osgi.peer.ws'''  (see r-OSGi over Websockets below), '''ecf.r_osgi.peer.wss''' (see r-OSGi over Websockets below)<br>
  
[[R-OSGi_Properties |  See here ]] for a description for rosgi-provider System properties.
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 Supported Intents]====
 
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 OSGi R7 Supported Intents]====
+
  
 
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
 
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
  
===Bundles===
+
===[[R-OSGi_Properties |  Remote Service Properties ]]===
  
org.eclipse.ecf.provider.r_osgi, ch.ethz.iks.r_osgi.remote<br>
+
===[https://github.com/ECF/DubboProvider/tree/master/bundles Provider Bundles]===
  
===Download/Install===
+
[https://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/providers/bundles/org.eclipse.ecf.provider.r_osgi org.eclipse.ecf.provider.r_osgi]<br>
 +
[https://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/protocols/bundles/ch.ethz.iks.r_osgi.remote ch.ethz.iks.r_osgi.remote]<br>
 +
 
 +
===Download/Install/Develop===
  
 
See [https://www.eclipse.org/ecf/downloads.php Download Page]<br>
 
See [https://www.eclipse.org/ecf/downloads.php Download Page]<br>
  
===Source Code===
+
====Bndtools Templates====
  
Git Repo: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git ECF Git Repo], Paths:<br>
+
The Bndtools Workspace has bndrun templates to us this distribution provider.  See the [[Bndtools Support for Remote Services Development]] tutorial
'''ch.ethz.iks.r_osgi.remote''': protocols/bundles/ch.ethz.iks.r_osgi.remote<br>
+
 
'''org.eclipse.ecf.provider.remoteservice''': providers/bundles/org.eclipse.ecf.provider.r_osgi
+
====Karaf Feature====
 +
 
 +
Part of ECF SDK:  https://download.eclipse.org/rt/ecf/latest/karaf-features.xml
 +
 
 +
See [https://wiki.eclipse.org/EIG:Install_into_Apache_Karaf  Karaf Install Instructions]
 +
 
 +
See [https://www.eclipse.org/ecf/downloads.php Download Page]<br>
 +
 
 +
====Source Code====
 +
 
 +
Git Repo: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git ECF Git Repo]
 +
 
 +
====P2 Repo====
 +
 
 +
Part of ECF SDK:  https://download.eclipse.org/rt/ecf/latest/site.p2/
 +
 
 +
See [https://www.eclipse.org/ecf/downloads.php Download Page]<br>
  
 
===r-OSGi over Websockets===
 
===r-OSGi over Websockets===
Line 111: Line 115:
 
java_websocket:  bundles/java_websocket<br>
 
java_websocket:  bundles/java_websocket<br>
 
<br>
 
<br>
[https://github.com/ECF/ROSGI-Websockets-Provider Recent build of these bundles is available here]  
+
[https://github.com/ECF/ROSGI-Websockets-Provider Recent build of these bundles is available here]
  
==JMS/ActiveMQ Providers==
+
==[https://github.com/ECF/JMS ActiveMQ Providers]==
  
 
JMS/ActiveMQ providers are based upon the [https://en.wikipedia.org/wiki/Java_Message_Service Java Messaging Service] (JMS) specification version 1.1+.
 
JMS/ActiveMQ providers are based upon the [https://en.wikipedia.org/wiki/Java_Message_Service Java Messaging Service] (JMS) specification version 1.1+.
  
===OSGi Configuration Types/ECF Container Types===
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1698916 Service Exported Config Types]====
'''ecf.jms.activemq.tcp.manager'''<br>
+
'''ecf.jms.activemq.tcp.manager''','''ecf.jms.activemq.tcp.client'''
'''ecf.jms.activemq.tcp.client'''<br>
+
  
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 OSGi R7 Supported Intents]====
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 Supported Intents]====
  
 
'''osgi.async''', '''osgi.basic''', '''osgi.private'''
 
'''osgi.async''', '''osgi.basic''', '''osgi.private'''
  
===Bundles===
+
===[[ActiveMQ Service Properties | Remote Service Properties ]]===
  
org.eclipse.ecf.provider.jms<br>
+
===[https://github.com/ECF/JMS/tree/master/bundles Provider Bundles]===
org.eclipse.ecf.provider.jms.activemq (based upon ActiveMQ 5.12 currently...see source code).
+
  
===Download/Install===
+
[https://github.com/ECF/JMS/tree/master/bundles/org.eclipse.ecf.provider.jms org.eclipse.ecf.provider.jms]<br>
 +
[https://github.com/ECF/JMS/tree/master/bundles/org.eclipse.ecf.provider.jms.activemq org.eclipse.ecf.provider.jms.activemq]  (based upon ActiveMQ 5.12 currently...see source code)<br>
  
See [https://github.com/ECF/JMS/releases here]
+
===Download/Install/Develop===
  
===Source Code===
+
See [https://github.com/ECF/JMS/releases Github Releases]
  
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/JMS ECF JMS Github Repo], Paths:<br>
+
====Bndtools Templates====
'''org.eclipse.ecf.provider.jms''': bundles/org.eclipse.ecf.provider.jms<br>
+
'''org.eclipse.ecf.provider.jms.activemq''':  bundles/org.eclipse.ecf.provider.jms.activemq
+
  
==MQTT Provider (Paho)==
+
The Bndtools Workspace has bndrun templates to us this distribution provider.  See the [[Bndtools Support for Remote Services Development]] tutorial
  
The ECF team has created a Remote Service provider based upon the MQTT3 [https://www.eclipse.org/paho/ Paho] implementation.  We are currently using Paho version 1.0.2.
+
====Karaf Feature====
  
===OSGi Configuration Types/ECF Container Types===
+
https://raw.githubusercontent.com/ECF/JMS/master/build/karaf-features.xml
'''ecf.jms.mqtt.manager'''<br>
+
'''ecf.jms.mqtt.client'''<br>
+
  
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 OSGi R7 Supported Intents]====
+
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [https://wiki.eclipse.org/EIG:Install_into_Apache_Karaf  Karaf Install Instructions]
  
'''osgi.async''', '''osgi.basic''', '''osgi.private'''
+
====Source Code====
  
===Bundles===
+
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/JMS ECF JMS Github Repo]
  
org.eclipse.ecf.provider.jms.mqtt
+
====P2 Repository====
  
===Download/Install===
+
https://raw.githubusercontent.com/ECF/JMS/master/build/
  
See [https://github.com/ECF/Mqtt-Provider/releases here]
+
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [http://www.eclipse.org/ecf/downloads.php ecf downloads] for Eclipse or Target Platform installation
 +
 
 +
==[https://github.com/ECF/DubboProvider DubboProvider]==
 +
 
 +
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1698916 Service Exported Config Types]====
 +
'''ecf.dubbo.server''', '''ecf.dubbo.client'''<br>
 +
 
 +
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 Supported Intents]====
 +
 
 +
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential''', '''dubbo'''
 +
 
 +
===[[Dubbo Service Properties | Remote Service Properties]]===
 +
 
 +
===[https://github.com/ECF/DubboProvider/tree/master/bundles Provider Bundles]===
 +
 
 +
[https://github.com/ECF/DubboProvider/tree/master/bundles/org.eclipse.ecf.provider.dubbo.common org.eclipse.ecf.provider.dubbo.common] -- Common support bundle for both Server and Client<br>
 +
[https://github.com/ECF/DubboProvider/tree/master/bundles/org.eclipse.ecf.provider.dubbo.server org.eclipse.ecf.provider.dubbo.server] -- Remote Service Server Container<br>
 +
[https://github.com/ECF/DubboProvider/tree/master/bundles/org.eclipse.ecf.provider.dubbo.client org.eclipse.ecf.provider.dubbo.client] -- Remote Service Client Container<br>
 +
 
 +
===[https://github.com/ECF/DubboProvider/tree/master/examples Example Remote Service]===
 +
 
 +
[https://github.com/ECF/DubboProvider/tree/master/examples/org.eclipse.ecf.examples.provider.dubbo.demo.api org.eclipse.ecf.examples.provider.dubbo.demo.api] -- Demo API bundle<br>
 +
[https://github.com/ECF/DubboProvider/tree/master/examples/org.eclipse.ecf.examples.provider.dubbo.demo.host org.eclipse.ecf.examples.provider.dubbo.demo.host] -- Demo Service Impl bundle<br>
 +
[https://github.com/ECF/DubboProvider/tree/master/examples/org.eclipse.ecf.examples.provider.dubbo.demo.consumer org.eclipse.ecf.examples.provider.dubbo.demo.consumer] -- Demo Service Consumer bundle<br>
 +
 
 +
===Download/Install/Develop===
 +
 
 +
'''[https://github.com/ECF/DubboProvider/releases Github Releases]'''
 +
 
 +
====Bndtools Templates====
 +
 
 +
The Bndtools Workspace has bndrun templates to us this distribution provider.  See the [[Bndtools Support for Remote Services Development]] tutorial
 +
 
 +
====Karaf Feature====
 +
 
 +
https://raw.githubusercontent.com/ECF/DubboProvider/master/build/karaf-features.xml
 +
 
 +
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [https://wiki.eclipse.org/EIG:Install_into_Apache_Karaf  Karaf Install Instructions]
 +
 
 +
====Source Code====
 +
 
 +
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/DubboProvider ECF Dubbo Distribution Provider Github Repo]
 +
 
 +
====P2 Repository====
 +
 
 +
https://raw.githubusercontent.com/ECF/DubboProvider/master/build/
 +
 
 +
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [http://www.eclipse.org/ecf/downloads.php ecf downloads] for Eclipse or Target Platform installation
 +
 
 +
==[https://github.com/ECF/HazelcastProvider Hazelcast Provider]==
 +
 
 +
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1698916 Service Exported Config Types]====
 +
'''ecf.jms.hazelcast.manager''', '''ecf.jms.hazelcast.member'''<br>
 +
 
 +
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 Supported Intents]====
 +
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential''', '''hazelcast'''
 +
 
 +
===[[Hazelcast Service Properties | Remote Service Properties]]===
 +
 
 +
===[https://github.com/ECF/HazelcastProvider/tree/master/bundles Provider Bundles]===
 +
 
 +
[https://github.com/ECF/HazelcastProvider/tree/master/bundles/org.eclipse.ecf.provider.jms.hazelcast org.eclipse.ecf.provider.jms.hazelcast]<br>
 +
 
 +
===Download/Install/Develop===
 +
 
 +
See [https://github.com/ECF/HazelcastProvider/releases GitHub Releases]
 +
 
 +
====Bndtools Templates====
 +
 
 +
The Bndtools Workspace has bndrun templates to us this distribution provider.  See the [[Bndtools Support for Remote Services Development]] tutorial
 +
 
 +
====Karaf Feature====
 +
 
 +
https://raw.githubusercontent.com/ECF/HazelcastProvider/master/build/karaf-features.xml
 +
 
 +
See [https://wiki.eclipse.org/EIG:Install_into_Apache_Karaf  Karaf Install Instructions]
 +
 
 +
====Source Code====
 +
 
 +
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/HazelcastProvider ECF Hazelcast Provider Github Repo]
 +
 
 +
====P2 Repository====
 +
 
 +
https://raw.githubusercontent.com/ECF/HazelcastProvider/master/build/
 +
 
 +
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [http://www.eclipse.org/ecf/downloads.php ecf downloads] for Eclipse or Target Platform installation
 +
 
 +
==[https://github.com/ECF/JGroups JavaGroups Provider]==
 +
 
 +
The ECF JavaGroups Provider is based upon JavaGroups ([http://jgroups.org JGroups]).
 +
 
 +
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1698916 Service Exported Config Types]====
 +
'''ecf.jgroups.manager''', '''ecf.jgroups.client'''
 +
 
 +
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 Supported Intents]====
 +
 
 +
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
 +
 
 +
===[[JavaGroups Service Properties | Remote Service Properties ]]===
 +
 
 +
===[https://github.com/ECF/JGroups Provider Bundles]===
 +
 
 +
[https://github.com/ECF/JGroups/tree/master/bundles/org.eclipse.ecf.provider.jgroups org.eclipse.ecf.provider.jgroups]<br>
 +
 
 +
===Download/Install/Develop===
 +
 
 +
See '''[https://github.com/ECF/JGroups/releases GitHub Release]'''
 +
 
 +
====Bndtools Templates====
 +
 
 +
The Bndtools Workspace has bndrun templates to us this distribution provider.  See the [[Bndtools Support for Remote Services Development]] tutorial
  
 
===Source Code===
 
===Source Code===
  
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/Mqtt-Provider ECF MQTT Provider Github Repo], Paths:<br>
+
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/https://github.com/ECF/JGroups ECF JavaGroups Provider Github Repo]
'''org.eclipse.ecf.provider.jms.mqtt''': bundles/org.eclipse.ecf.provider.jms.mqtt
+
  
==Jax-RS Providers==
+
====P2 Repo====
 +
 
 +
https://raw.githubusercontent.com/ECF/JGroups/master/build/
 +
 
 +
==[https://github.com/ECF/JaxRSProviders Jax-RS Providers]==
  
 
The ECF team has created several REST-based Remote Service providers, all of which are based upon the Jax-RS specification.  By using OSGi Remote Service standards along with Jax-RS standards, it's possible to create remote services that can be used on any compliant Jax-RS implementation, and any RSA-compliant Remote Services implementation.  For a tutorial on how this can work, see [[Tutorial:_Using_REST_and_OSGi_Standards_for_Micro_Services  | the tutorial Using REST and OSGi Standards for Micro Services]].
 
The ECF team has created several REST-based Remote Service providers, all of which are based upon the Jax-RS specification.  By using OSGi Remote Service standards along with Jax-RS standards, it's possible to create remote services that can be used on any compliant Jax-RS implementation, and any RSA-compliant Remote Services implementation.  For a tutorial on how this can work, see [[Tutorial:_Using_REST_and_OSGi_Standards_for_Micro_Services  | the tutorial Using REST and OSGi Standards for Micro Services]].
Line 171: Line 283:
 
Since REST is based upon a client-server model of services, Remote Services based upon rest may only be exported on servers.  Clients may import, but are unable to export Remote Services.
 
Since REST is based upon a client-server model of services, Remote Services based upon rest may only be exported on servers.  Clients may import, but are unable to export Remote Services.
  
===Jackson Jax-RS Distribution Provider===
+
===Jersey Jax-RS Distribution Provider===
  
====OSGi Configuration Types/ECF Container Types====
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1698916 Service Exported Config Types]====
'''ecf.jaxrs.jersey.server'''<br>
+
'''ecf.jaxrs.jersey.server''', '''ecf.jaxrs.jersey.client'''
'''ecf.jaxrs.jersey.client'''<br>
+
  
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 OSGi R7 Supported Intents]====
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 Supported Intents]====
  
 
'''osgi.async''', '''osgi.private''', '''osgi.confidential'''
 
'''osgi.async''', '''osgi.private''', '''osgi.confidential'''
  
====Bundles====
+
====[[Jackson Service Properties | Remote Service Properties]]====
  
org.eclipse.ecf.provider.jersey.server<br>
+
====[https://github.com/ECF/JaxRSProviders/tree/master/bundles Provider Bundles]====
org.eclipse.ecf.provider.jaxrs.server<br>
+
org.eclipse.ecf.provider.jaxrs
+
  
====Download/Install====
+
[https://github.com/ECF/JaxRSProviders/tree/master/bundles/org.eclipse.ecf.provider.jaxrs org.eclipse.ecf.provider.jaxrs]<br>
 +
[https://github.com/ECF/JaxRSProviders/tree/master/bundles/org.eclipse.ecf.provider.jaxrs.server org.eclipse.ecf.provider.jaxrs.server]<br>
 +
[https://github.com/ECF/JaxRSProviders/tree/master/bundles/org.eclipse.ecf.provider.jaxrs.client org.eclipse.ecf.provider.jaxrs.client]<br>
 +
[https://github.com/ECF/JaxRSProviders/tree/master/bundles/org.eclipse.ecf.provider.jersey.server org.eclipse.ecf.provider.jersey.server]<br>
 +
[https://github.com/ECF/JaxRSProviders/tree/master/bundles/org.eclipse.ecf.provider.jersey.client org.eclipse.ecf.provider.jersey.client]<br>
  
A binary distribution of the Jersey client and server is available [https://github.com/ECF/JaxRSProviders/releases here]
+
====Download/Install/Develop====
  
====Source Code====
+
See [https://github.com/ECF/JaxRSProviders/releases GitHub Release]
 +
 
 +
=====Bndtools Templates=====
 +
 
 +
The Bndtools Workspace has bndrun templates to us this distribution provider.  See the [[Bndtools Support for Remote Services Development]] tutorial
 +
 
 +
=====Karaf Feature=====
 +
 
 +
https://raw.githubusercontent.com/ECF/JaxRSProviders/master/build/karaf-features.xml
 +
 
 +
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [https://wiki.eclipse.org/EIG:Install_into_Apache_Karaf  Karaf Install Instructions]
 +
 
 +
=====Source Code=====
 +
 
 +
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/JaxRSProviders ECF JaxRS Providers Github Repo]
 +
 
 +
=====P2 Repository=====
  
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/JaxRSProviders ECF JaxRS Providers Github Repo], Paths:<br>
+
https://raw.githubusercontent.com/ECF/JaxRSProviders/master/build/
'''org.eclipse.ecf.provider.jersey.server''': bundles/org.eclipse.ecf.provider.jersey.server<br>
+
'''org.eclipse.ecf.provider.jaxrs.server''': bundles/org.eclipse.ecf.provider.jaxrs.server<br>
+
'''org.eclipse.ecf.provider.jaxrs''':  bundles/org.eclipse.ecf.provider.jaxrs<br>
+
  
If you would like to contribute to the build/releng or the coding for this provider, please [https://dev.eclipse.org/mailman/listinfo/ecf-dev join and post a note to that effect to the ecf-dev mailing list].
+
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [http://www.eclipse.org/ecf/downloads.php ecf downloads] for Eclipse or Target Platform installation
  
 
===Apache CXF Jax-RS Implementation===
 
===Apache CXF Jax-RS Implementation===
  
====OSGi Configuration Types/ECF Container Types====
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1698916 Service Exported Config Types]====
'''ecf.jaxrs.cxf.server'''<br>
+
'''ecf.jaxrs.cxf.server''', '''ecf.jaxrs.cxf.client'''<br>
'''ecf.jaxrs.cxf.client'''<br>
+
  
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 OSGi R7 Supported Intents]====
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 Supported Intents]====
  
 
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
 
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
  
====Bundles====
+
====[[Apache CXF JaxRS Service Properties | Remote Service Properties]]====
  
org.eclipse.ecf.provider.cxf.server<br>
+
====[https://github.com/ECF/JaxRSProviders/tree/master/bundles Provider Bundles]====
org.eclipse.ecf.provider.jaxrs.server<br>
+
org.eclipse.ecf.provider.jaxrs
+
  
====Source Code====
+
[https://github.com/ECF/JaxRSProviders/tree/master/bundles/org.eclipse.ecf.provider.jaxrs org.eclipse.ecf.provider.jaxrs]<br>
 +
[https://github.com/ECF/JaxRSProviders/tree/master/bundles/org.eclipse.ecf.provider.jaxrs.server org.eclipse.ecf.provider.jaxrs.server]<br>
 +
[https://github.com/ECF/JaxRSProviders/tree/master/bundles/org.eclipse.ecf.provider.jaxrs.client org.eclipse.ecf.provider.jaxrs.client]<br>
 +
[https://github.com/ECF/JaxRSProviders/tree/master/bundles/org.eclipse.ecf.provider.cxf.server org.eclipse.ecf.provider.cxf.server]<br>
 +
[https://github.com/ECF/JaxRSProviders/tree/master/bundles/org.eclipse.ecf.provider.cxf.client org.eclipse.ecf.provider.cxf.client]<br>
  
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/JaxRSProviders ECF JaxRS Providers Github Repo], Paths:<br>
+
====Download/Install/Develop====
'''org.eclipse.ecf.provider.cxf.server''': bundles/org.eclipse.ecf.provider.cxf.server<br>
+
'''org.eclipse.ecf.provider.jaxrs.server''': bundles/org.eclipse.ecf.provider.jaxrs.server<br>
+
'''org.eclipse.ecf.provider.jaxrs''':  bundles/org.eclipse.ecf.provider.jaxrs<br>
+
  
==Providers created via ECF REST API==
+
See [https://github.com/ECF/JaxRSProviders/releases GitHub Release]
  
ECF has provided an API to aid in the creation of REST-based Remote Services provider.  Using this API, it's possible to create a Remote Service client/proxy that uses an '''existing''' REST-based service.  Thus new Remote Services can be created to expose an existing REST-based service.  The following tutorial: [[Tutorial:_ECF_Remote_Services_for_Accessing_Existing_REST_Services | ECF Remote Services for Accessing Existing REST Services]] describes how to use the ECF REST API to create client provider to access an existing REST service.
+
=====Bndtools Templates=====
  
===OSGi Configuration Types/ECF Container Types===
+
The Bndtools Workspace has bndrun templates to us this distribution provider. See the [[Bndtools Support for Remote Services Development]] tutorial
'''ecf.rest.client'''<br>
+
  
As mentioned above, only REST servers may export Remote Services, so the ecf.rest.client provider may not export Remote Services.
+
=====Karaf Feature=====
  
==[https://github.com/ECF/kryo-serialization Kryo Serialization]==
+
https://raw.githubusercontent.com/ECF/JaxRSProviders/master/build/karaf-features.xml
  
This set of projects enhances the [https://wiki.eclipse.org/Distribution_Providers#Generic_Provider ECF generic providers] to use [https://github.com/EsotericSoftware/kryo Kryo serialization] rather than Java serialization. [https://github.com/EsotericSoftware/kryo Kryo serialization] is a fast and efficient object serialization for Java.
+
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [https://wiki.eclipse.org/EIG:Install_into_Apache_Karaf Karaf Install Instructions]
  
See the example of usage and documentation described on the [https://github.com/ECF/kryo-serialization main Kryo serialization project page].
+
=====Source Code=====
  
OSGi R7 Supported Intents: None
+
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/JaxRSProviders ECF JaxRS Providers Github Repo]
  
===Bundles===
+
=====P2 Repository=====
  
org.eclipse.ecf.provider.sharedobject.serializer.kryo<br>
+
https://raw.githubusercontent.com/ECF/JaxRSProviders/master/build/
  
===Dependencies===
+
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [http://www.eclipse.org/ecf/downloads.php ecf downloads] for Eclipse or Target Platform installation
  
'''org.eclipse.ecf.provider.sharedobject.serializer.kryo''':  ECF Core, RSAPI, [https://github.com/EsotericSoftware/kryo Kryo Serialization]
+
==[https://github.com/ECF/Mqtt-Provider MQTT Provider]==
  
===Source Code===
+
The ECF team has created a Remote Service provider based upon the MQTT3 [https://www.eclipse.org/paho/ Paho] implementation.  We are currently using [https://www.eclipse.org/paho/ Paho] version 1.2.1.
  
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/kryo-serialization Kryo Serialization for Generic Provider Github Repo], Paths:<br>
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1698916 Service Exported Config Types]====
'''org.eclipse.ecf.provider.sharedobject.serializer.kryo''': org.eclipse.ecf.sharedobject.serializer.kryo<br>
+
'''ecf.jms.mqtt.manager''', '''ecf.jms.mqtt.client'''
 +
 
 +
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 Supported Intents]====
 +
 
 +
'''osgi.async''', '''osgi.basic''', '''osgi.private'''
 +
 
 +
===[[MQTT Service Properties | Remote Service Properties]]===
 +
 
 +
===[https://github.com/ECF/Mqtt-Provider/tree/master/bundles Provider Bundles]===
 +
 
 +
[https://github.com/ECF/Mqtt-Provider/tree/master/bundles/org.eclipse.ecf.provider.jms.mqtt org.eclipse.ecf.provider.jms.mqtt]<br>
 +
 
 +
===Download/Install/Develop===
 +
 
 +
See [https://github.com/ECF/Mqtt-Provider/releases Github Releases]
 +
 
 +
====Bndtools Templates====
 +
 
 +
The Bndtools Workspace has bndrun templates to us this distribution provider.  See the [[Bndtools Support for Remote Services Development]] tutorial
 +
 
 +
====Karaf Feature====
 +
 
 +
https://raw.githubusercontent.com/ECF/Mqtt-Provider/master/build/karaf-features.xml
 +
 
 +
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [https://wiki.eclipse.org/EIG:Install_into_Apache_Karaf  Karaf Install Instructions]
 +
 
 +
====Source Code====
 +
 
 +
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/Mqtt-Provider ECF MQTT Provider Github Repo]
 +
 
 +
====P2 Repository====
 +
 
 +
https://raw.githubusercontent.com/ECF/Mqtt-Provider/master/build/
 +
 
 +
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [http://www.eclipse.org/ecf/downloads.php ecf downloads] for Eclipse or Target Platform installation
  
 
==[https://github.com/ECF/Py4j-RemoteServicesProvider Python OSGi Services Provider]==
 
==[https://github.com/ECF/Py4j-RemoteServicesProvider Python OSGi Services Provider]==
Line 257: Line 414:
 
Please see [[Tutorial: Python for OSGi Services]]
 
Please see [[Tutorial: Python for OSGi Services]]
  
===Download/Install===
+
The Py4j Remote Services Provider is based upon the [https://www.py4j.org/ Py4j project].  It can also optionally use [https://developers.google.com/protocol-buffers Google Protocol Buffers] for serialization/deserialization between Java and Python, and/or [https://google.github.io/flatbuffers/ Google Flatbuffers].
  
A binary build (p2) of this provider is available [https://github.com/ECF/Py4j-RemoteServicesProvider/releases here]  
+
===[https://github.com/ECF/Py4j-RemoteServicesProvider/tree/master/bundles Provider Bundles]===
  
===Source Code===
+
[https://github.com/ECF/Py4j-RemoteServicesProvider/tree/master/bundles/org.eclipse.ecf.provider.direct org.eclipse.ecf.provider.direct]<br>
 +
[https://github.com/ECF/Py4j-RemoteServicesProvider/tree/master/bundles/org.eclipse.ecf.python org.eclipse.ecf.python]<br>
 +
[https://github.com/ECF/Py4j-RemoteServicesProvider/tree/master/bundles/org.eclipse.ecf.python.protobuf org.eclipse.ecf.python.protobuf]<br>
 +
[https://github.com/ECF/Py4j-RemoteServicesProvider/tree/master/bundles/org.eclipse.ecf.provider.py4j  org.eclipse.ecf.provider.py4j]<br>
 +
[https://github.com/ECF/Py4j-RemoteServicesProvider/tree/master/bundles/org.eclipse.ecf.provider.py4j.flatbuf org.eclipse.ecf.provider.py4j.flatbuf]<br>
 +
[https://github.com/ECF/Py4j-RemoteServicesProvider/tree/master/bundles/org.eclipse.ecf.provider.direct.flatbuf org.eclipse.ecf.provider.direct.flatbuf]<br>
 +
[https://github.com/ECF/Py4j-RemoteServicesProvider/tree/master/bundles/org.eclipse.ecf.provider.direct.protobuf org.eclipse.ecf.provider.direct.protobuf]<br>
 +
[https://github.com/ECF/Py4j-RemoteServicesProvider/tree/master/bundles/org.eclipse.ecf.provider.py4j.protobuf org.eclipse.ecf.provider.py4j.protobuf]<br>
  
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/Py4j-RemoteServicesProvider ECF Python Provider Github Repo]
+
===Download/Install/Develop===
  
===Bundles===
+
See [https://github.com/ECF/Py4j-RemoteServicesProvider/releases GitHub Releases]
  
org.eclipse.ecf.remoteservice.rest<br>
+
====Bndtools Templates====
  
===Download/Install===
+
The Bndtools Workspace has bndrun templates to us this distribution provider.  See the [[Bndtools_Support_for_Remote_Services_Development | Bndtools For Remote Services Development]
  
P2 Repo and Karaf Feature:  See [https://www.eclipse.org/ecf/downloads.php Download Page]<br>
+
====Karaf Feature====
P2 Feature ID:  '''org.eclipse.ecf.remoteservice.rest.feature'''<br>
+
<br>
+
Karaf Feature:  '''ecf-remoteservices-rest''' in repos given on [[EIG:Install_into_Apache_Karaf |  Karaf Installation Page]]
+
  
===Source Code===
+
https://raw.githubusercontent.com/ECF/JMS/master/build/karaf-features.xml
  
Git Repo: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git ECF Git Repo], Paths:<br>
+
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.   See [https://wiki.eclipse.org/EIG:Install_into_Apache_Karaf Karaf Install Instructions]
'''org.eclipse.ecf.remoteservice.rest''': framework/bundles/org.eclipse.ecf.remoteservice.rest
+
  
==Hazelcast Provider==
+
====Source Code====
  
====OSGi Configuration Types/ECF Container Types====
+
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/Py4j-RemoteServicesProvider ECF Python Provider Github Repo]
'''ecf.jms.hazelcast.manager'''<br>
+
 
'''ecf.jms.hazelcast.member'''<br>
+
==[https://github.com/ECF/XmlRpcProvider XML-RPC Provider]==
 +
 
 +
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1698916 Service Exported Config Types]====
 +
'''ecf.xmlrpc.server''', '''ecf.xmlrpc.client'''<br>
  
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 OSGi R7 Supported Intents]====
+
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 Supported Intents]====
  
 
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
 
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
  
===Bundles===
+
===[[XmlRpc Service Properties | Remote Service Properties ]]===  
  
org.eclipse.ecf.provider.jms.hazelcast<br>
+
===[https://github.com/ECF/XmlRpcProvider/tree/master/bundles Provider Bundle]===
  
===Download/Install===
+
[https://github.com/ECF/XmlRpcProvider/tree/master/bundles/org.eclipse.ecf.provider.xmlrpc org.eclipse.ecf.provider.xmlrpc]
  
A binary build of hte Hazelcast distribution provider is available [https://github.com/ECF/HazelcastProvider/releases here]
+
===Download/Install/Develop===
  
===Source Code===
+
'''[https://github.com/ECF/XmlRpcProvider/releases Github Releases]'''
  
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/HazelcastProvider ECF Hazelcast Provider Github Repo], Paths:<br>
+
====Bndtools Templates====
'''org.eclipse.ecf.provider.jms.hazelcast''': bundles/org.eclipse.ecf.provider.jms.hazelcast<br>
+
  
If you would like to contribute to the build/releng or the coding for this provider, please [https://dev.eclipse.org/mailman/listinfo/ecf-dev join and post a note to that effect to the ecf-dev mailing list].
+
The Bndtools Workspace has bndrun templates to us this distribution provider. See the [[Bndtools Support for Remote Services Development]] tutorial
  
==JavaGroups (JGroups) Provider==
+
====Karaf Feature====
  
====OSGi Configuration Types/ECF Container Types====
+
https://raw.githubusercontent.com/ECF/XmlRpcProvider/master/build/karaf-features.xml
'''ecf.jgroups.manager'''<br>
+
'''ecf.jgroups.client'''<br>
+
  
====[https://osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html#i1693415 OSGi R7 Supported Intents]====
+
See [https://wiki.eclipse.org/EIG:Install_into_Apache_Karaf  Karaf Install Instructions]
  
'''osgi.async''', '''osgi.basic''', '''osgi.private''', '''osgi.confidential'''
+
====Source Code====
  
===Bundles===
+
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/XmlRpcProvider ECF XML-RPC Provider Github Repo], Paths:<br>
 +
'''org.eclipse.ecf.provider.xmlrpc''': bundles/org.eclipse.ecf.provider.xmlrpc<br>
  
org.eclipse.ecf.provider.jgroups<br>
+
====P2 Repository====
  
===Download/Install===
+
https://raw.githubusercontent.com/ECF/XmlRpcProvider/master/build/
  
A build of this provider is available '''[https://github.com/ECF/JGroups/releases here]'''
+
<b>NOTE:</b> Depends upon version 3.14.5 or higher of ECF Remote Service SDK.  See [http://www.eclipse.org/ecf/downloads.php ecf downloads] for Eclipse or Target Platform installation
  
===Source Code===
+
==Providers created via ECF REST API==
  
[https://github.com/ECF ECF Github] Repo: [https://github.com/ECF/https://github.com/ECF/JGroups ECF JavaGroups Provider Github Repo], Paths:<br>
+
ECF has provided an API to aid in the creation of REST-based Remote Services provider.   Using this API, it's possible to create a Remote Service client/proxy that uses an '''existing''' REST-based service. Thus new Remote Services can be created to expose an existing REST-based service. The following tutorial: [[Tutorial:_ECF_Remote_Services_for_Accessing_Existing_REST_Services | ECF Remote Services for Accessing Existing REST Services]] describes how to use the ECF REST API to create client provider to access an existing REST service.
'''org.eclipse.ecf.provider.jgroups''': bundles/org.eclipse.ecf.provider.jgroups<br>
+
  
If you would like to contribute to the build/releng or the coding for this provider, create a new provider, or get support or custom development on any of the existing providers, please [https://dev.eclipse.org/mailman/listinfo/ecf-dev join and post to the ecf-dev mailing list].
+
===OSGi Service Exported Configs===
 +
'''ecf.rest.client'''<br>
 +
 
 +
As mentioned above, only REST servers may export Remote Services, so the ecf.rest.client provider may not export Remote Services.
 +
 
 +
===Download/Install/Develop===
 +
 
 +
P2 Repo and Karaf Feature:  See [https://www.eclipse.org/ecf/downloads.php Download Page]<br>
 +
P2 Feature ID:  '''org.eclipse.ecf.remoteservice.rest.feature'''<br>
 +
<br>
 +
Karaf Feature:  '''ecf-remoteservices-rest''' in repos given on [[EIG:Install_into_Apache_Karaf |  Karaf Installation Page]]
 +
 
 +
===Source Code===
 +
 
 +
Git Repo: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git ECF Git Repo], Paths:<br>
 +
'''org.eclipse.ecf.remoteservice.rest''': framework/bundles/org.eclipse.ecf.remoteservice.rest

Latest revision as of 00:05, 6 November 2019

Contents

Introduction

The OSGi R7 Remote Services/Remote Service Admin specifications (chaps 100 and 122 in OSGi Enterprise spec) allows for the use of multiple distribution providers. Distribution providers are responsible for the actual marshalling/serialization and network communication when a consumer invokes a remote service method.

The ECF Architecture also allows the use of multiple distribution providers. Further, ECF's open APIs and implementations supports the creation of custom distribution providers using any desired transport protocols, serialization formats and/or libraries.

Remote Services API

ECF's API for distribution providers is the Remote Services API (RSAPI). Implementing this API is the only requirement to create a RS/RSA standards compliant distribution provider. All of the distribution providers implement the RSAPI.

Symbolic Name: org.eclipse.ecf.remoteservice
Minimum EE: J2SE-1.7+
Dependencies

  • Framework: OSGi R6+ (Equinox Mars+ or Felix 5.2.0+)
  • ECF Core Bundles: org.eclipse.ecf, org.eclipse.ecf.identity
  • org.eclipse.equinox.concurrent.future bundle
  • org.eclipse.ecf.remoteservice.asyncproxy bundle version 1.X (Java 7) or 2.X (Java 8)


Remote Service API Javadoc

Generic Provider

The generic providers are based upon tcp transport socket api. They are built and released as part of the Eclipse Foundation project releases. See the ECF Download Page.

Service Exported Config Types

ecf.generic.server, ecf.generic.client, ecf.generic.ssl.server, ecf.generic.ssl.client

Supported Intents

osgi.async, osgi.basic, osgi.private, osgi.confidential

Service Properties

Provider Bundles

org.eclipse.ecf.sharedobject
org.eclipse.ecf.provider
org.eclipse.ecf.provider.remoteservice

Download/Install/Develop

See Download Page

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the Bndtools Support for Remote Services Development tutorial

Karaf Feature

Part of ECF SDK: https://download.eclipse.org/rt/ecf/latest/karaf-features.xml

See Karaf Install Instructions

See Download Page

Source Code

Git Repo: ECF Git Repo

P2 Repo

Part of ECF SDK: https://download.eclipse.org/rt/ecf/latest/site.p2/

See Download Page

Tutorials and Examples

See using Bndtools project templates or Building your first OSGi Remote Service

r-OSGi Provider

Service Exported Config Types

ecf.r_osgi.peer, ecf.r_osgi.peer.ws (see r-OSGi over Websockets below), ecf.r_osgi.peer.wss (see r-OSGi over Websockets below)

Supported Intents

osgi.async, osgi.basic, osgi.private, osgi.confidential

Remote Service Properties

Provider Bundles

org.eclipse.ecf.provider.r_osgi
ch.ethz.iks.r_osgi.remote

Download/Install/Develop

See Download Page

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the Bndtools Support for Remote Services Development tutorial

Karaf Feature

Part of ECF SDK: https://download.eclipse.org/rt/ecf/latest/karaf-features.xml

See Karaf Install Instructions

See Download Page

Source Code

Git Repo: ECF Git Repo

P2 Repo

Part of ECF SDK: https://download.eclipse.org/rt/ecf/latest/site.p2/

See Download Page

r-OSGi over Websockets

The two r-OSGi providers: ecf.r_osgi.peer.ws, and ecf.r_osgi.peer.wss are supported by adding two additional bundles: ch.ethz.iks.r_osgi.transport.http, and Java Websocket. These two bundles are available in the ECF Github Websockets Repo, at the following paths:
ch.ethz.iks.r_osgi.transport.http: bundles/ch.ethz.iks.r_osgi.transport.http
java_websocket: bundles/java_websocket

Recent build of these bundles is available here

ActiveMQ Providers

JMS/ActiveMQ providers are based upon the Java Messaging Service (JMS) specification version 1.1+.

Service Exported Config Types

ecf.jms.activemq.tcp.manager,ecf.jms.activemq.tcp.client

Supported Intents

osgi.async, osgi.basic, osgi.private

Remote Service Properties

Provider Bundles

org.eclipse.ecf.provider.jms
org.eclipse.ecf.provider.jms.activemq (based upon ActiveMQ 5.12 currently...see source code)

Download/Install/Develop

See Github Releases

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the Bndtools Support for Remote Services Development tutorial

Karaf Feature

https://raw.githubusercontent.com/ECF/JMS/master/build/karaf-features.xml

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See Karaf Install Instructions

Source Code

ECF Github Repo: ECF JMS Github Repo

P2 Repository

https://raw.githubusercontent.com/ECF/JMS/master/build/

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See ecf downloads for Eclipse or Target Platform installation

DubboProvider

Service Exported Config Types

ecf.dubbo.server, ecf.dubbo.client

Supported Intents

osgi.async, osgi.basic, osgi.private, osgi.confidential, dubbo

Remote Service Properties

Provider Bundles

org.eclipse.ecf.provider.dubbo.common -- Common support bundle for both Server and Client
org.eclipse.ecf.provider.dubbo.server -- Remote Service Server Container
org.eclipse.ecf.provider.dubbo.client -- Remote Service Client Container

Example Remote Service

org.eclipse.ecf.examples.provider.dubbo.demo.api -- Demo API bundle
org.eclipse.ecf.examples.provider.dubbo.demo.host -- Demo Service Impl bundle
org.eclipse.ecf.examples.provider.dubbo.demo.consumer -- Demo Service Consumer bundle

Download/Install/Develop

Github Releases

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the Bndtools Support for Remote Services Development tutorial

Karaf Feature

https://raw.githubusercontent.com/ECF/DubboProvider/master/build/karaf-features.xml

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See Karaf Install Instructions

Source Code

ECF Github Repo: ECF Dubbo Distribution Provider Github Repo

P2 Repository

https://raw.githubusercontent.com/ECF/DubboProvider/master/build/

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See ecf downloads for Eclipse or Target Platform installation

Hazelcast Provider

Service Exported Config Types

ecf.jms.hazelcast.manager, ecf.jms.hazelcast.member

Supported Intents

osgi.async, osgi.basic, osgi.private, osgi.confidential, hazelcast

Remote Service Properties

Provider Bundles

org.eclipse.ecf.provider.jms.hazelcast

Download/Install/Develop

See GitHub Releases

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the Bndtools Support for Remote Services Development tutorial

Karaf Feature

https://raw.githubusercontent.com/ECF/HazelcastProvider/master/build/karaf-features.xml

See Karaf Install Instructions

Source Code

ECF Github Repo: ECF Hazelcast Provider Github Repo

P2 Repository

https://raw.githubusercontent.com/ECF/HazelcastProvider/master/build/

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See ecf downloads for Eclipse or Target Platform installation

JavaGroups Provider

The ECF JavaGroups Provider is based upon JavaGroups (JGroups).

Service Exported Config Types

ecf.jgroups.manager, ecf.jgroups.client

Supported Intents

osgi.async, osgi.basic, osgi.private, osgi.confidential

Remote Service Properties

Provider Bundles

org.eclipse.ecf.provider.jgroups

Download/Install/Develop

See GitHub Release

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the Bndtools Support for Remote Services Development tutorial

Source Code

ECF Github Repo: ECF JavaGroups Provider Github Repo

P2 Repo

https://raw.githubusercontent.com/ECF/JGroups/master/build/

Jax-RS Providers

The ECF team has created several REST-based Remote Service providers, all of which are based upon the Jax-RS specification. By using OSGi Remote Service standards along with Jax-RS standards, it's possible to create remote services that can be used on any compliant Jax-RS implementation, and any RSA-compliant Remote Services implementation. For a tutorial on how this can work, see the tutorial Using REST and OSGi Standards for Micro Services.

Since REST is based upon a client-server model of services, Remote Services based upon rest may only be exported on servers. Clients may import, but are unable to export Remote Services.

Jersey Jax-RS Distribution Provider

Service Exported Config Types

ecf.jaxrs.jersey.server, ecf.jaxrs.jersey.client

Supported Intents

osgi.async, osgi.private, osgi.confidential

Remote Service Properties

Provider Bundles

org.eclipse.ecf.provider.jaxrs
org.eclipse.ecf.provider.jaxrs.server
org.eclipse.ecf.provider.jaxrs.client
org.eclipse.ecf.provider.jersey.server
org.eclipse.ecf.provider.jersey.client

Download/Install/Develop

See GitHub Release

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the Bndtools Support for Remote Services Development tutorial

Karaf Feature

https://raw.githubusercontent.com/ECF/JaxRSProviders/master/build/karaf-features.xml

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See Karaf Install Instructions

Source Code

ECF Github Repo: ECF JaxRS Providers Github Repo

P2 Repository

https://raw.githubusercontent.com/ECF/JaxRSProviders/master/build/

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See ecf downloads for Eclipse or Target Platform installation

Apache CXF Jax-RS Implementation

Service Exported Config Types

ecf.jaxrs.cxf.server, ecf.jaxrs.cxf.client

Supported Intents

osgi.async, osgi.basic, osgi.private, osgi.confidential

Remote Service Properties

Provider Bundles

org.eclipse.ecf.provider.jaxrs
org.eclipse.ecf.provider.jaxrs.server
org.eclipse.ecf.provider.jaxrs.client
org.eclipse.ecf.provider.cxf.server
org.eclipse.ecf.provider.cxf.client

Download/Install/Develop

See GitHub Release

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the Bndtools Support for Remote Services Development tutorial

Karaf Feature

https://raw.githubusercontent.com/ECF/JaxRSProviders/master/build/karaf-features.xml

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See Karaf Install Instructions

Source Code

ECF Github Repo: ECF JaxRS Providers Github Repo

P2 Repository

https://raw.githubusercontent.com/ECF/JaxRSProviders/master/build/

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See ecf downloads for Eclipse or Target Platform installation

MQTT Provider

The ECF team has created a Remote Service provider based upon the MQTT3 Paho implementation. We are currently using Paho version 1.2.1.

Service Exported Config Types

ecf.jms.mqtt.manager, ecf.jms.mqtt.client

Supported Intents

osgi.async, osgi.basic, osgi.private

Remote Service Properties

Provider Bundles

org.eclipse.ecf.provider.jms.mqtt

Download/Install/Develop

See Github Releases

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the Bndtools Support for Remote Services Development tutorial

Karaf Feature

https://raw.githubusercontent.com/ECF/Mqtt-Provider/master/build/karaf-features.xml

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See Karaf Install Instructions

Source Code

ECF Github Repo: ECF MQTT Provider Github Repo

P2 Repository

https://raw.githubusercontent.com/ECF/Mqtt-Provider/master/build/

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See ecf downloads for Eclipse or Target Platform installation

Python OSGi Services Provider

Please see Tutorial: Python for OSGi Services

The Py4j Remote Services Provider is based upon the Py4j project. It can also optionally use Google Protocol Buffers for serialization/deserialization between Java and Python, and/or Google Flatbuffers.

Provider Bundles

org.eclipse.ecf.provider.direct
org.eclipse.ecf.python
org.eclipse.ecf.python.protobuf
org.eclipse.ecf.provider.py4j
org.eclipse.ecf.provider.py4j.flatbuf
org.eclipse.ecf.provider.direct.flatbuf
org.eclipse.ecf.provider.direct.protobuf
org.eclipse.ecf.provider.py4j.protobuf

Download/Install/Develop

See GitHub Releases

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the [[Bndtools_Support_for_Remote_Services_Development | Bndtools For Remote Services Development]

Karaf Feature

https://raw.githubusercontent.com/ECF/JMS/master/build/karaf-features.xml

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See Karaf Install Instructions

Source Code

ECF Github Repo: ECF Python Provider Github Repo

XML-RPC Provider

Service Exported Config Types

ecf.xmlrpc.server, ecf.xmlrpc.client

Supported Intents

osgi.async, osgi.basic, osgi.private, osgi.confidential

Remote Service Properties

Provider Bundle

org.eclipse.ecf.provider.xmlrpc

Download/Install/Develop

Github Releases

Bndtools Templates

The Bndtools Workspace has bndrun templates to us this distribution provider. See the Bndtools Support for Remote Services Development tutorial

Karaf Feature

https://raw.githubusercontent.com/ECF/XmlRpcProvider/master/build/karaf-features.xml

See Karaf Install Instructions

Source Code

ECF Github Repo: ECF XML-RPC Provider Github Repo, Paths:
org.eclipse.ecf.provider.xmlrpc: bundles/org.eclipse.ecf.provider.xmlrpc

P2 Repository

https://raw.githubusercontent.com/ECF/XmlRpcProvider/master/build/

NOTE: Depends upon version 3.14.5 or higher of ECF Remote Service SDK. See ecf downloads for Eclipse or Target Platform installation

Providers created via ECF REST API

ECF has provided an API to aid in the creation of REST-based Remote Services provider. Using this API, it's possible to create a Remote Service client/proxy that uses an existing REST-based service. Thus new Remote Services can be created to expose an existing REST-based service. The following tutorial: ECF Remote Services for Accessing Existing REST Services describes how to use the ECF REST API to create client provider to access an existing REST service.

OSGi Service Exported Configs

ecf.rest.client

As mentioned above, only REST servers may export Remote Services, so the ecf.rest.client provider may not export Remote Services.

Download/Install/Develop

P2 Repo and Karaf Feature: See Download Page
P2 Feature ID: org.eclipse.ecf.remoteservice.rest.feature

Karaf Feature: ecf-remoteservices-rest in repos given on Karaf Installation Page

Source Code

Git Repo: ECF Git Repo, Paths:
org.eclipse.ecf.remoteservice.rest: framework/bundles/org.eclipse.ecf.remoteservice.rest

Copyright © Eclipse Foundation, Inc. All Rights Reserved.