Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
ECF/Getting Started with Remote Services API
Install ECF 3.0. See ecf download.
In addition you will need Equinox in your target platform (either the Equinox 3.5 SDK or the parts that come with Eclipse).
Service Interface
As with any OSGi service, you must first define your service interface. Here is a trivial example 'hello' service interface:
package org.eclipse.ecf.examples.remoteservices.hello; public interface IHello { public void hello(String from); }
This service is defined, along with a simple implementation, in this project in CVS
cvs: :pserver:anonymous@dev.eclipse.org:/cvsroot/rt
modules: org.eclipse.ecf/examples/bundles/org.eclipse.ecf.examples.remoteservices.hello, org.eclipse.ecf/examples/bundles/org.eclipse.ecf.examples.remoteservices.hello.host.rs, org.eclipse.ecf/examples/bundles/org.eclipse.ecf.examples.remoteservices.hello.consumer.rs
Here is a project set file for these projects.
The service interface above is contained in the o.e.e.e.remoteservices.hello bundle, along with a trivial implementation (in org.eclipse.ecf.examples.remoteservices.hello.impl.Hello).
Registering the Service (Host)
Here is the code in org.eclipse.ecf.internal.examples.remoteservices.hello.host.rs.Activator that registers a remote service with the ECF RFC119 implementation:
public void start(BundleContext context) throws Exception { this.context = context; // Create R-OSGi Container IContainerManager containerManager = getContainerManagerService(); container = containerManager.getContainerFactory().createContainer( "ecf.r_osgi.peer"); // Get remote service container adapter IRemoteServiceContainerAdapter containerAdapter = (IRemoteServiceContainerAdapter) container .getAdapter(IRemoteServiceContainerAdapter.class); // Register remote service serviceRegistration = containerAdapter.registerRemoteService( new String[] { IHello.class.getName() }, new Hello(), null); System.out.println("IHello RemoteService registered"); }
This code does the following:
- Creates an r-osgi ECF container to do the distribution.
- Gets the containerAdapter from the container instance so that remote services can be registered/accessed.
- Creates and registers the IHello implementation.
Here is the expected output to the console for this host
osgi> IHello RemoteService registered
If you get the following warning when starting the host:
osgi> WARNING: Port 9278 already in use. This instance of R-OSGi is running on port 9279
This means that there is some other R-OSGi instance running on that same system, and that port 9278 is not available for use by the host. In this case, you need to stop the host, and disable the other R-OSGi instance before running the host again. To disable R-OSGI, see Disabling R-OSGi and R-OSGI Properties.
Using the Service (Consumer)
The ECF remote services API consumer essentially needs to lookup the remote reference, and then use the Here is code from org.eclipse.ecf.internal.examples.remoteservices.hello.consumer.rs.Activator
public void start(BundleContext context) throws Exception { this.context = context; // Create R-OSGi Container IContainerManager containerManager = getContainerManagerService(); container = containerManager.getContainerFactory().createContainer( "ecf.r_osgi.peer"); // Get remote service container adapter IRemoteServiceContainerAdapter containerAdapter = (IRemoteServiceContainerAdapter) container .getAdapter(IRemoteServiceContainerAdapter.class); // Lookup IRemoteServiceReference IRemoteServiceReference[] helloReferences = containerAdapter .getRemoteServiceReferences(IDFactory.getDefault().createID( container.getConnectNamespace(), RSGI_SERVICE_HOST), IHello.class.getName(), null); Assert.isNotNull(helloReferences); Assert.isTrue(helloReferences.length > 0); // Get remote service for reference IRemoteService remoteService = containerAdapter .getRemoteService(helloReferences[0]); // Get the proxy IHello proxy = (IHello) remoteService.getProxy(); // Finally...call the proxy proxy.hello("RemoteService Consumer"); }
This code
- Creates a container r-osgi container instance.
- Gets the remote service container adapter.
- Looksup IRemoteServiceReference array for the IHello service using the r-osgi://localhost:9278 host (the value of ROSGI_SERVICE_HOST).
- Gets the IRemoteService for the given IRemoteServiceReference.
- Gets a proxy via the IRemoteService.getProxy(), and casts it to the IHello interface.
- Makes the remote call (proxy.hello("RemoteService Consumer")
The output on the remote service host is
osgi> IHello RemoteService registered hello from=RemoteService Consumer
Eclipse Communication Framework |
API |
API Documentation • Javadoc • Providers |
Development |
Development Guidelines • Integrators Guide |