JAX-RS (JSR 311) is the community-driven Standard for building RESTful web services with Java. The reference implementation for JAX-RS is Jersey and ships as OSGi bundles. This project connects Jersey and OSGi at the service level. This means that OSGi services can be published as RESTful web services by simply registering them as OSGi services and also consumed as OSGi services ;).
When the com.eclipsesource.jaxrs.connector bundle is activated all @Path/@Provider annotated
objects that are registered as OSGi services will be published as RESTful web services.
Services can be added or removed during runtime and will be published or postponed.
To publish services on different ports the http.port service property can be used.
The connector detects configuration changes during runtime (e.g. when done by the
OSGi Configuration Admin Service).
The second major feature of the connector is the consumer part. The idea behind this is to be able to reuse the @Path/@Provider interfaces for consuming the services. See these posts for a detailed description: Consuming REST services in Java the cool way, Consuming REST services in OSGi the cool way.
Install from this software repository into your target: http://hstaudacher.github.com/osgi-jax-rs-connector or download the binaries:
- com.eclipsesource.jaxrs.connector_2.4.0.201303032249.jar
- com.eclipsesource.jaxrs.consumer_1.3.0.201303032249.jar
If dependencies can't be satisfied please disable "include required software" within the target editor.
- For Eclipse: Add the com.eclipsesource.jaxrs.connector.feature (OSGi JAX-RS Connector) to your target using the url above.
- Add the com.eclipsesource.jaxrs.connector and the 3 Jersey bundles to your OSGi instance.
- Convert some OSGi service to resources like in this tutorial
- Point your client to the specified url. Don't forget that the default root path is
/services. So registering a service with the path/examplewould lead to/services/example. - Read this post to see how to handle the consumer.
This git repository contains two example bundles. A @Path annotated resource will be registred in com.eclipsesource.jaxrs.connector.example
and com.eclipsesource.jaxrs.connector.example.ds. In the ds bundle OSGi Declarative Services will be used to register
the service and it provides an additional example for @Provider annotated providers. If you want to run the examples within
your Eclipse IDE use the launch configurations located in the bundles.
After you have started the bundles a service will be available at http://localhost:9090/services/osgi-jax-rs.
- OSGi Core Specification 4.2 and an OSGi HttpService implementation (e.g. Equinox, Felix).
- JRE 1.6 (same as Jersey)
- Neil Bartlett's jaxrs-osgi-extender
- OSGi Remote Services (e.g. Apache CXF)
Jersey 2.0 (m12) is included in the software repository.
- 1.0 (Jan 23rd, 2012): Functionality to publish
@Pathannotated OSGi services as web resources. - 2.0 (Aug 27th, 2012): Use the config admin to specify the root path. The default root path is /services. You can configure the path by specifying a config with the service.pid
com.eclipsesource.jaxrs.connectorand the propertyroot. The path needs to be a valid servlet path e.g. "/api". - 2.1 (Oct 26th, 2012): Besides
@Pathannotated object it's now possible to register@Providerannotated objects as OSGi services too. Thanks to Dirk Lecluse for this contribution. - 2.1.1 (Nov 11th, 2012): Updated included Jersey Version (1.15).
- 2.2.0 (Jan 3rd, 2013): Updated included Jersey Version (2.0 m11). Added Consumer integration.
- 2.3.0 (Jan 22th, 2013): Added service property to exclude a resource from publishing. See
ServiceProperties. - 2.4.0 (Feb 28th, 2013): Updated included Jersey Version (2.0 m12).
- 2.4.1 (Mar 3rd, 2013): Adds error handling to consumer.
The code is published under the terms of the Eclipse Public License, version 1.0.
Included binaries from Jersey, version 2.0 m12, which are published under two licenses, the CDDL 1.1 and GPL 2 with CPE