Overview

Documentation

Search

Community

Developers

Related Projects

ServiceMix CXF BC

ServiceMix ships with a JBI compliant HTTP/SOAP or JMS/SOAP binding component named servicemix-cxf-bc which use Apache CXF internally.

Here are the main features:

  • JBI compliant Binding Component
  • Usable in a lightweight mode in servicemix.xml configuration files
  • SOAP 1.1 and 1.2 support
  • MIME attachments
  • Support for all MEPs as consumers or providers
  • SSL support
  • WS-Security support
  • WS-Policy support
  • WS-RM support
  • WS-Addressing support

Maven Archetype

This archetype creates a CXF BC Service Unit, including consumer and provider sample:

mvn archetype:create \
  -DarchetypeGroupId=org.apache.servicemix.tooling \
  -DarchetypeArtifactId=servicemix-cxf-bc-service-unit
  -DarchetypeVersion=2010.01 \
  -DgroupId=your.group.id \
  -DartifactId=your.artifact.id \
  -Dversion=your-version

Once you've customized the service unit, simply install the SU:

mvn install
Remember that to be deployable in ServiceMix, the ServiceUnit has to be embedded in a Service Assembly: only the Service Assembly zip file can be deployed in ServiceMix.
To add your SU in a SA, you need to define it in the dependency sets: 
<dependency>
  <groupId>your.group.id</groupId>
  <artifactId>your.artifact.id</artifactId>
  <version>your-version</version>
</dependency>

Endpoints Configuration

Consumer Endpoint

A consumer endpoint is a server-side CXF endpoint that will consume plain HTTP+SOAP requests and send them into the NMR to a given JBI endpoint, which is called the proxied endpoint.

Following is an example of an HTTP consumer endpoint:

<cxfbc:consumer wsdl="/wsdl/calculator.wsdl"
                      service="calculator:CalculatorService"
                      endpoint="CalculatorPort"
                      targetEndpoint="CalculatorPortProxy"
                      targetService="calculator:CalculatorService"
                      targetInterface="calculator:CalculatorPortType">
          
</cxfbc:consumer>
Consumer Endpoint Attributes
Name Type Description Required
wsdl String the wsdl will be retrieved from the given location yes
service QName the service name of the proxied endpoint no (required if the WSDL has more than one service)
endpoint String the endpoint name of the proxied endpoint no (required if the specified service has more than one endpoint)
interfaceName QName the interface name of the proxied endpoint no
targetService QName the service name of the target endpoint no (defaults to the service attribute)
targetEndpoint String the endpoint name of the target endpoint no (defaults to the endpoint attribute)
targetInterfaceName QName the interface name of the target endpoint no
busCfg String the spring configuration file used for cxf bus initialization no
mtomEnabled boolean Enable MTOM / attachment support no (defaults to false)
synchronous boolean Specifies if the endpoint expects send messageExchange by sendSync no (defaults to false)
useJBIWrapper boolean Specifies if the endpoint expects messages to use the JBI wrapper for SOAP messages. no (defaults to true,Ignore the value of useSOAPEnvelope if useJBIWrapper is true)
useSOAPEnvelope boolean Specifies if the endpoint expects soap messages when useJBIWrapper is false no (defaults to true)
locationURI String Specifies the HTTP address to which requests are sent. This value will overide any value specified in the WSDL. no (if provided the value will override the URL defined in the WSDL)
timeout long Specifies the interval for which the endpoint will wait for a response, This is specified in seconds. no (defaults to 0 which means wait until response back)
x509 boolean Specifies if the endpoint use X.509 Certificate to do the authentication. no (defaults to false), by default we delegate AA to SMX JAASAuthenticationService with ws-security UsernameToken, if we set this flag as true, we can check for X.509 certificate to run authentication with
delegateToJaas boolean Specifies if the endpoint delegate to JAASAuthenticationService to do the authentication. no (defaults to true) If we only want ws-security get involved and don't want to delegate to SMX JAASAuthenticationService then set this flag as false
schemaValidationEnabled boolean Specifies if the endpoint use schemavalidation for the incoming/outgoing message. no (defaults to false)
properties Map Sets arbitrary properties that are added to the CXF context at the Endpoint level. no

The targetService, targetEndpoint and targetInterfaceName attributes can be used to specify the routing method to use (routing by interface, service or endpoint) and is also useful to allow several proxy endpoints to be created for the same JBI endpoint.

We leverage all ws-* features from apache cxf by means of putting configuration into busCfg which is used for cxf bus initialization

Provider Endpoint

A provider endpoint is a client-side JBI endpoint which can receive requests from the NMR and send them to a given url where the service is provided.

Here is an example of an http provider endpoint:

<cxfbc:provider wsdl="/wsdl/calculator.wsdl"
                      locationURI="http://localhost:9001/bridgetest"
                      service="calculator:CalculatorService"
                      endpoint="CalculatorPortProxy"
                      interfaceName="calculator:CalculatorPortType">

</cxfbc:provider>
Provider Endpoint Attributes
Name Type Description Required
wsdl String the wsdl will be retrieved from the given location yes
service QName the service name of the exposed jbi endpoint yes
endpoint String the endpoint name of the exposed jbi endpoint yes
interfaceName QName the interface name of the exposed jbi endpoint no
locationURI URI the http url of the target service no (if provided the value will override the URL defined in the WSDL)
busCfg String the spring configuration file used for cxf bus initialization no
mtomEnabled boolean Enable MTOM / attachment support no (defaults to false)
useJBIWrapper boolean Specifies if the endpoint expects messages to use the JBI wrapper for SOAP messages. no (defaults to true,Ignore the value of useSOAPEnvelope if useJBIWrapper is true)
useSOAPEnvelope boolean Specifies if the endpoint expects soap messages when useJBIWrapper is false no (defaults to true)
schemaValidationEnabled boolean Specifies if the endpoint use schemavalidation for the incoming/outgoing message. no (defaults to false)
properties Map Sets arbitrary properties that are added to the CXF context at the Endpoint level. no

WS-Addressing

When used on a SOAP consumer endpoint, servicemix-http handles the WS-Adressing Action and To headers.

wsa:Action

The wsa:Action header can be used to specify the target interface name and operation to use for the JBI exchange.

The header uses the following syntax:

[target namespace][delimiter][interface name][delimiter][operation name]

where:

  • [delimiter] is ":" when the [target namespace] is a URN, otherwise "/".
  • [target namespace] is the namespace of the interface.
  • [interface name] is the name of the interface.
  • [operation name] is the name of the operation.

For example, the following header

<wsa:Action>http://example.com/stockquote/StockQuoteInterface/GetLastTradePrice</wsa:Action>

will be used to address the JBI exchange with the following properties:

wsa:To

The wsa:To header specifies the target JBI service name and endpoint name.

The header uses the following syntax:

[target namespace][delimiter][service name][delimiter][endpoint name]

where:

  • [delimiter] is ":" when the [target namespace] is a URN, otherwise "/".
  • [target namespace] is the namespace of the interface.
  • [service name] is the name of the service.
  • [endpoint name] is the name of the endpoint.

For example, the following header

<wsa:To>urn:example:stockquote:StockQuoteService:JBIEndpoint</wsa:To>

will be used to address the JBI exchange with the following properties:

  • service name: {urn:example:stockquote}StockQuoteService
  • endpoint name: JBIEndpoint

    You can find a WS-Addressing test case here

    More about Cxf WS-Addressing implementation

WS-Policy

You can find a WS-Policy test case

here

More about Cxf WS-Policy implementation

WS-Security

You can find a WS-Security test case

here

More about Cxf WS-Security implementation

WS-RM

You can find a WS-RM test case

here

More about Cxf WS-RM implementation

Interceptors Configuration

Since cxfbc is using Apache CXF internally, so you can configure cxf bc endpoint with inteceptors which follow cxf inteceptor api.
example per as below

 <cxfbc:consumer wsdl="...">
         <cxfbc:inInterceptors>
          <bean class="org.apache.cxf.interceptor.LoggingInInterceptor"/>
        </cxfbc:inInterceptors>
        <cxfbc:outInterceptors>
          <bean class="org.apache.cxf.interceptor.LoggingOutInterceptor"/>
        </cxfbc:outInterceptors>
        <cxfbc:inFaultInterceptors>
          <bean class="org.apache.cxf.interceptor.LoggingInInterceptor"/>
        </cxfbc:inFaultInterceptors>
        <cxfbc:outFaultInterceptors>
          <bean class="org.apache.cxf.interceptor.LoggingOutInterceptor"/>
        </cxfbc:outFaultInterceptors>
   </cxfbc:consumer>

Can find document for CXF interceptors here

Features configuration

You can also configure CXF features directly on CXF BC endpoint. Example per as below:

 <cxfbc:consumer wsdl="...">
     <cxfbc:features>
           <bean class="org.apache.cxf.transport.jms.JMSConfigFeature">
                <property name="jmsConfig">
                    <bean class="org.apache.cxf.transport.jms.JMSConfiguration">
                        <property name="concurrentConsumers">
                            <value>5</value>
                        </property>
                        <property name="connectionFactory">
                            <ref bean="myConnectionFactory" />
                        </property>
                        <property name="targetDestination">
                            <value>test.jmstransport.text</value>
                        </property>
                        <property name="useJms11">
                            <value>false</value>
                        </property>
                    </bean>
                </property>
            </bean>
        </cxfbc:features>
</cxfbc:consumer>