Jump to: navigation, search

Distribution Providers

Contents

Introduction

New: ECF OSGi R7 Remote Services. The R7 Remote Services adds the standardization of several 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: osgi.basic, osgi.private, 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 ecf-dev mailing list.

The 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 thing required to create a RS/RSA standards compliant distribution provider.

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

  • Framework: OSGi R6+ (Equinox Mars+)
  • 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

All ECF RSA distribution providers implement the RSAPI.

XML-RPC Provider

OSGi Configuration Types

ecf.xmlrpc.server, ecf.xmlrpc.client

OSGi R7 Supported Intents

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

Bundles

org.eclipse.ecf.provider.xmlrpc

Download/Install

[1]

Source Code

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

Examples

See hello example in released distribution and in source code under examples/

Generic Provider

The generic providers are based upon tcp transport socket api.

OSGi Configuration Types

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

OSGi R7 Supported Intents

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

See here for a description for generic-provider-specific service properties such as ecf.generic.server.hostname, ecf.generic.server.port, etc.

Bundles

org.eclipse.ecf.provider, org.eclipse.ecf.provider.remoteservice

Download/Install

See Download Page

Source Code

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

Tutorials and Examples

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

r-OSGi Provider

OSGi Configuration Types/ECF Container 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)

See here for a description for rosgi-provider System properties.

OSGi R7 Supported Intents

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

Bundles

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

Download/Install

See Download Page

Source Code

Git Repo: ECF Git Repo, Paths:
ch.ethz.iks.r_osgi.remote: protocols/bundles/ch.ethz.iks.r_osgi.remote
org.eclipse.ecf.provider.remoteservice: providers/bundles/org.eclipse.ecf.provider.r_osgi

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

JMS/ActiveMQ Providers

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

OSGi Configuration Types/ECF Container Types

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

OSGi R7 Supported Intents

osgi.async, osgi.basic, osgi.private

Bundles

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

Download/Install

See here

Source Code

ECF Github Repo: ECF JMS Github Repo, Paths:
org.eclipse.ecf.provider.jms: bundles/org.eclipse.ecf.provider.jms
org.eclipse.ecf.provider.jms.activemq: bundles/org.eclipse.ecf.provider.jms.activemq

MQTT Provider (Paho)

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

OSGi Configuration Types/ECF Container Types

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

OSGi R7 Supported Intents

osgi.async, osgi.basic, osgi.private

Bundles

org.eclipse.ecf.provider.jms.mqtt

Download/Install

See here

Source Code

ECF Github Repo: ECF MQTT Provider Github Repo, Paths:
org.eclipse.ecf.provider.jms.mqtt: bundles/org.eclipse.ecf.provider.jms.mqtt

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.

Jackson Jax-RS Distribution Provider

OSGi Configuration Types/ECF Container Types

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

OSGi R7 Supported Intents

osgi.async, osgi.private, osgi.confidential

Bundles

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

Download/Install

A binary distribution of the Jersey client and server is available here

Source Code

ECF Github Repo: ECF JaxRS Providers Github Repo, Paths:
org.eclipse.ecf.provider.jersey.server: bundles/org.eclipse.ecf.provider.jersey.server
org.eclipse.ecf.provider.jaxrs.server: bundles/org.eclipse.ecf.provider.jaxrs.server
org.eclipse.ecf.provider.jaxrs: bundles/org.eclipse.ecf.provider.jaxrs

If you would like to contribute to the build/releng or the coding for this provider, please join and post a note to that effect to the ecf-dev mailing list.

Apache CXF Jax-RS Implementation

OSGi Configuration Types/ECF Container Types

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

OSGi R7 Supported Intents

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

Bundles

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

Source Code

ECF Github Repo: ECF JaxRS Providers Github Repo, Paths:
org.eclipse.ecf.provider.cxf.server: bundles/org.eclipse.ecf.provider.cxf.server
org.eclipse.ecf.provider.jaxrs.server: bundles/org.eclipse.ecf.provider.jaxrs.server
org.eclipse.ecf.provider.jaxrs: bundles/org.eclipse.ecf.provider.jaxrs

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 Configuration Types/ECF Container Types

ecf.rest.client

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

Kryo Serialization

This set of projects enhances the ECF generic providers to use Kryo serialization rather than Java serialization. Kryo serialization is a fast and efficient object serialization for Java.

See the example of usage and documentation described on the main Kryo serialization project page.

OSGi R7 Supported Intents: None

Bundles

org.eclipse.ecf.provider.sharedobject.serializer.kryo

Dependencies

org.eclipse.ecf.provider.sharedobject.serializer.kryo: ECF Core, RSAPI, Kryo Serialization

Source Code

ECF Github Repo: Kryo Serialization for Generic Provider Github Repo, Paths:
org.eclipse.ecf.provider.sharedobject.serializer.kryo: org.eclipse.ecf.sharedobject.serializer.kryo

Python OSGi Services Provider

Please see Tutorial: Python for OSGi Services

Download/Install

A binary build (p2) of this provider is available here

Source Code

ECF Github Repo: ECF Python Provider Github Repo

Bundles

org.eclipse.ecf.remoteservice.rest

Download/Install

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

Hazelcast Provider

OSGi Configuration Types/ECF Container Types

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

OSGi R7 Supported Intents

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

Bundles

org.eclipse.ecf.provider.jms.hazelcast

Download/Install

A binary build of hte Hazelcast distribution provider is available here

Source Code

ECF Github Repo: ECF Hazelcast Provider Github Repo, Paths:
org.eclipse.ecf.provider.jms.hazelcast: bundles/org.eclipse.ecf.provider.jms.hazelcast

If you would like to contribute to the build/releng or the coding for this provider, please join and post a note to that effect to the ecf-dev mailing list.

JavaGroups (JGroups) Provider

OSGi Configuration Types/ECF Container Types

ecf.jgroups.manager
ecf.jgroups.client

OSGi R7 Supported Intents

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

Bundles

org.eclipse.ecf.provider.jgroups

Download/Install

A build of this provider is available here

Source Code

ECF Github Repo: ECF JavaGroups Provider Github Repo, Paths:
org.eclipse.ecf.provider.jgroups: bundles/org.eclipse.ecf.provider.jgroups

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 join and post to the ecf-dev mailing list.