Page History

{toc:type=list|maxLevel=3}

h2. Configuration Properties

These properties are set on the Service Registration in the OSGi Service Registry.

h3. Service Provider properties For Configuring SOAP-based services and consumers

*Note:* for backwards compatibility old values marked below are still supported. 

|| Property Name || Data Type || Example || Description ||
| service.exported.interfaces
 (previously:_osgi.remote.interfaces_) | String | {{org.example.BarService,org.example.FooService

}} {{*}}| Denotes the interfaces to be exposed remotely. This is a comma-separated list of fully qualified Java interfaces that should be made available remotely. A special value of {{*}} can be provided meaning that _all_ of the interfaces passed to the {{BundleContext.registerService()}} call are suitable for remoting. |
| service.exported.configs (previously:_osgi.remote.configuration.type_)

 | String | {{org.apache.cxf.ws

}} | Specifies the mechanism for configuring the service exposure. Possible values:

 
* {{org.apache.cxf.ws}} (previously: {{pojo}}) the OSGi Service is exposed as a Web Service.

* {{wsdl}} configuration driven from WSDL |

h4. {{org.apache.cxf.ws}} configuration type

When the {{service.exported.configs=org.apache.cxf.ws}} (or {{osgi.remote.configuration.type=pojo}}) property is specified, the following properties may also be specified.

|| Property Name

 || Data Type

 || Example || Description ||
| org.apache.cxf.ws.address

(previously:_osgi.remote.configuration.pojo.address_)

 | String | {{

http://localhost:9090/greeter

}}

 | The address at which the service with be made available remotely. If this property is not specified, this defaults to {{

http://localhost:9000/fully/qualified/ClassName

}}.

 |
| org.apache.cxf.ws.httpservice.context

(previously:_osgi.remote.configuration.pojo.httpservice.context_)

 | String | {{/auction}} | When this property is specified, the OSGi HTTP Service is used to expose the service, rather than a dedicated Jetty HTTP Server. This property doesn't allow the specification of a port number, as this is provided by the HTTP Service. The Distributed OSGi distributions come with Pax-Web, for which configuration information can be found here: http://wiki.ops4j.org/display/paxweb/Configuration

, however other OSGi HTTP Service implementations are potentially configured differently.

 |

h3. Service Provider properties For Configuring RESTful JAXRS-based endpoints and

 consumers

h4. {{org.apache.cxf.rs}} configuration type

When the {{service.exported.configs=org.apache.cxf.rs}} property is specified, the following properties may also be specified.

|| Property Name

 || Data Type

 || Example || Description ||
| org.apache.cxf.rs.address

 | String | {{

http://localhost:9090/greeter

}}

 | The address at which the service with be made available remotely. If this property is not specified, this defaults to {{

http://localhost:9000/fully/qualified/ClassName

}}.

 |
| org.apache.cxf.rs.httpservice.context

 | String | {{/auction}} | When this property is specified, the OSGi HTTP Service which is used to expose the service, rather than a dedicated Jetty HTTP Server. By default, absolute address may look like 'http://localhost:8080/auction'

  |
| org.apache.cxf.rs.provider

 | Boolean | {true or false} | Can be used to identify a global JAXRS provider as CXF-compatible |
| org.apache.cxf.rs.provider.expected

 | Boolean | {true or false} | Can be used to require global providers to set an 'org.apache.cxf.rs.provider' property with a value 'true'.

 |
| org.apache.cxf.rs.provider.globalquery

Alternatively, one can register per-service specific providers during the application service registration :

{code

:java

}
CustomMessageBodyReaderWriter provider1 = new CustomMessageBodyReaderWriter();
provider.setCustomProperty(true);
CustomMessageBodyReaderWriter provider2 = new CustomMessageBodyReaderWriter();
provider2.setCustomProperty(false);

Dictionary properties = new Hashtable();
properties.put("org.apache.cxf.rs.provider", provider);

Dictionary properties2 = new Hashtable();
properties.put("org.apache.cxf.rs.provider", provider2);


bundleContext.registerService(
  new String[]{"org.books.BookService"}, new BookServiceImpl(), properties);
bundleContext.registerService(
  new String[]{"org.books.BookService"}, new AdvancedBookServiceImpl(), properties2);

{code}


h3. Service Consumer properties

On client side proxies, typically the same properties are set as on set service provider side for both SOAP and RESTful clients. There are some additional properties too. Since the client-side proxy is registered by the DOSGi implementation, all these properties are read-only.

|| Property Name || Data Type || Example || Description ||
| service.imported | boolean | {{true}} | This property is always set on a service proxy, indicating that the real service is remote. |
| org.apache.cxf.remote.dsw.client

 | String | | This property is set to the bundle name of the CXF-DOSGi implementation and can be used to find client side proxies created by the CXF DOSGi implementation. |

h2. The Intent Map
_*TODO*_

h2. {{remote-services.xml}} files

The CXF DOSGi implementation provides a DSW (Distribution Software) implementation of Distributed OSGi. It is compatible with any Distributed OSGi Discovery implementation in order to discover remote services dynamically.

 

However, using a Discovery system is optional, it is also possible to statically configure remote services into the system. This is done by registering one or more bundles containing {{remote-services.xml}} files. By default the system looks for any files with the {{.xml}} extension in the {{OSGI-INF/remote-service}} directory of the bundle.

Here's an example:

{noformat

} 
<service-descriptions xmlns="http://www.osgi.org/xmlns/sd/v1.0.0">
  <service-description>
    <provide interface="org.apache.cxf.dosgi.samples.greeter.GreeterService" />
    <property name="osgi.remote.interfaces">*</property>
    <property name="osgi.remote.configuration.type">pojo</property>
    <property name="osgi.remote.configuration.pojo.address">http://localhost:9090/greeter</property>
  </service-description>

  <!-- further service-description tags are allowed here -->
</service-descriptions>

{noformat} 

*Alternative locations*

By default all {{*.xml}} files in the OSGI-INF/remote-service location are considered, this location can be changed by setting the {{Remote-Service}} header in the bundle manifest, e.g.

{noformat

}
Remote-Service: META-INF/osgi

{noformat}

h2. Contributing Distribution properties to Existing Services (without changing them)
CXF/DOSGi allows you to add the distribution properties to existing OSGi services. You can do this by installing a bundle that contains an XML file with the extra properties in the {{OSGI-INF/remote-service}} directory:

A sample {{OSGI-INF/remote-service/sd.xml}} file looks like this:

{noformat

}
<service-decorations xmlns="http://cxf.apache.org/xmlns/service-decoration/1.0.0">
 <service-decoration>
   <match interface="org.apache.F(.*)">
     <match-property name="test.prop" value="xyz"/>
     <add-property name="service.exported.interfaces" value="*"/>
   </match>
 </service-decoration>
</service-decorations>
{noformat}
A service decorations file can have any number of {{service-decoration}} tags, each tag describing a *match* rule for services that are to be decorated.

The match rules are defined as follows:

* {{match interface="org.apache.Foo"}} matches any service that is registered under the _org.apache.Foo_ class or interface. The {{interface}} attribute takes regular expressions, so specifying {{org.apache(.)*}} will match any service registered with an interface in a subpackage of _org.apache_.

* The optional {{match-property}} tags allows you to declare extra conditions to be applied to services of which the interface matches. In the above example the rule will only match services that have the {{test.prop}} property set to the value {{xyz}}. Other services don't match. Any number of {{match-property}} tags can be specified.

* The {{add-property}} specifies the extra property to be added to the remote service. The above example adds {{service.exported.interfaces="*"}} which will cause any matching service to be exposed remotely. The {{add-property}} has an optional {{type}} attribute which defaults to {{java.lang.String}}. You can specify other Java basic types such as {{java.lang.Long}} if needed. You can have any number of {{add-property}} tags.

Note the bundle with the extra metadata will need to be started before the bundle with the service that is to be remoted is started (need to fix this).