Spring Web Services Component
Available as of Camel 2.6
The spring-ws: component allows you to integrate with Spring Web Services. It offers both client-side support, for accessing web services, and server-side support for creating your own contract-first web services.
Maven users will need to add the following dependency to their pom.xml for this component:
As of Camel 2.8 this component ships with Spring-WS 2.0.x which (like the rest of Camel) requires Spring 3.0.x.
Earlier Camel versions shipped Spring-WS 1.5.9 which is compatible with Spring 2.5.x and 3.0.x. In order to run earlier versions of camel-spring-ws on Spring 2.5.x you need to add the spring-webmvc module from Spring 2.5.x. In order to run Spring-WS 1.5.9 on Spring 3.0.x you need to exclude the OXM module from Spring 3.0.x as this module is also included in Spring-WS 1.5.9 (see this post)
The URI scheme for this component is as follows
To expose a web service mapping-type needs to be set to any of the following:
| Mapping type || Description |
| rootqname || Offers the option to map web service requests based on the qualified name of the root element contained in the message. |
| soapaction || Used to map web service requests based on the SOAP action specified in the header of the message. |
| uri || In order to map web service requests that target a specific URI. |
| xpathresult || Used to map web service requests based on the evaluation of an XPath expression against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI. |
| beanname || Allows you to reference an org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher object in order to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping, SoapActionEndpointMapping, etc |
As a consumer the address should contain a value relevant to the specified mapping-type (e.g. a SOAP action, XPath expression). As a producer the address should be set to the URI of the web service your calling upon.
You can append query options to the URI in the following format, ?option=value&option=value&...
| Name || Required? || Description |
| soapAction || No || SOAP action to include inside a SOAP request when accessing remote web services |
| wsAddressingAction || No || WS-Addressing 1.0 action header to include when accessing web services. The To header is set to the address of the web service as specified in the endpoint URI (default Spring-WS behavior). |
| expression || Only when mapping-type is xpathresult || XPath expression to use in the process of mapping web service requests, should match the result specified by xpathresult |
| timeout || No || Camel 2.10: Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer, see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout(). This option works when using the built-in message sender implementations: CommonsHttpMessageSender and HttpUrlConnectionMessageSender. One of these implementations will be used by default for HTTP based services unless you customize the Spring WS configuration options supplied to the component. If you are using a non-standard sender, it is assumed that you will handle your own timeout configuration.|
Camel 2.12: The built-in message sender HttpComponentsMessageSender is considered instead of CommonsHttpMessageSender which has been deprecated, see HttpComponentsMessageSender.setReadTimeout().
| sslContextParameters || No || Camel 2.10: Reference to an org.apache.camel.util.jsse.SSLContextParameters in the Registry. See Using the JSSE Configuration Utility. This option works when using the built-in message sender implementations: CommonsHttpMessageSender and HttpUrlConnectionMessageSender. One of these implementations will be used by default for HTTP based services unless you customize the Spring WS configuration options supplied to the component. If you are using a non-standard sender, it is assumed that you will handle your own TLS configuration.|
Camel 2.12: The built-in message sender HttpComponentsMessageSender is considered instead of CommonsHttpMessageSender which has been deprecated.
Registry based options
The following options can be specified in the registry (most likely a Spring ApplicationContext) and referenced from the endpoint URI using the # notation.
| Name || Required? || Description |
| webServiceTemplate || No || Option to provide a custom WebServiceTemplate. This allows for full control over client-side web services handling; like adding a custom interceptor or specifying a fault resolver, message sender or message factory. |
| messageSender || No || Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports |
| messageFactory || No || Option to provide a custom WebServiceMessageFactory. For example when you want Apache Axiom to handle web service messages instead of SAAJ |
| transformerFactory || No || Option to override default TransformerFactory. The provided transformer factory must be of type javax.xml.transform.TransformerFactory |
| endpointMapping || Only when mapping-type is rootqname, soapaction, uri or xpathresult || Reference to an instance of org.apache.camel.component.spring.ws.bean.CamelEndpointMapping in the Registry/ApplicationContext. Only one bean is required in the registry to serve all Camel/Spring-WS endpoints. This bean is auto-discovered by the MessageDispatcher and used to map requests to Camel endpoints based on characteristics specified on the endpoint (like root QName, SOAP action, etc) |
| messageFilter || No || Option to provide a custom MessageFilter since 2.10.3. For example when you want to process your headers or attachments by your own. |
| Name || Type || Description |
| CamelSpringWebserviceEndpointUri || String || URI of the web service your accessing as a client, overrides address part of the endpoint URI |
| CamelSpringWebserviceSoapAction || String || Header to specify the SOAP action of the message, overrides soapAction option if present |
| CamelSpringWebserviceAddressingAction || URI || Use this header to specify the WS-Addressing action of the message, overrides wsAddressingAction option if present |
| CamelSpringWebserviceSoapHeader || Source || Camel 2.11.1: Use this header to specify/access the SOAP headers of the message. |
Accessing web services
To call a web service at http://foo.com/bar simply define a route:
And sent a message:
Remember if it's a SOAP service you're calling you don't have to include SOAP tags. Spring-WS will perform the XML-to-SOAP marshaling.
Sending SOAP and WS-Addressing action headers
When a remote web service requires a SOAP action or use of the WS-Addressing standard you define your route as:
Optionally you can override the endpoint options with header values:
Using SOAP headers
Available as of Camel 2.11.1
You can provide the SOAP header(s) as a Camel Message header when sending a message to a spring-ws endpoint, for example given the following SOAP header in a String
We can set the body and header on the Camel Message as follows:
And then send the Exchange to a spring-ws endpoint to call the Web Service.
Likewise the spring-ws consumer will also enrich the Camel Message with the SOAP header.
For an example see this unit test.
The header and attachment propagation
Spring WS Camel supports propagation of the headers and attachments into Spring-WS WebServiceMessage response since version 2.10.3.
The endpoint will use so called "hook" the MessageFilter (default implementation is provided by BasicMessageFilter) to propagate the exchange headers and attachments into WebSdrviceMessage response.
Now you can use
Note: If the exchange header in the pipeline contains text, it generates Qname(key)=value attribute in the soap header.
Recommended is to create a QName class directly and put into any key into header.
How to use MTOM attachments
The BasicMessageFilter provides all required information for Apache Axiom in order to produce MTOM message. If you want to use Apache Camel Spring WS within Apache Axiom, here is an example:
1. Simply define the messageFactory as is bellow and spring-ws will use MTOM strategy to populate your SOAP message with optimized attachments.
2. Add into your pom.xml the following dependencies
3. Add your attachment into the pipeline, for example using a Processor implementation.
4. Define endpoint (producer) as ussual, for example like this:
5. Now, your producer will generate MTOM message with otpmized attachments.
The custom header and attachment filtering
If you need to provide your custome processing of either headers or attachments, extend existing BasicMessageFilter and override the approchiate methods or write a brand new implementation of the MessageFilter interface.
To use your custom filter, add this into your spring context:
You can specify either a global a or a local message filter as follows:
a) the global custome filter that provides the global configuration for all spring-ws endpoints
b) the local messageFilter directly on the endpoint as follows:
For more information see CAMEL-5724
If you want to create your own MessageFilter, consider overrideing the following methods in the default implementation of MessageFilter in class BasicMessageFilter:
Using a custom MessageSender and MessageFactory
A custom message sender or factory in the registry can be referenced like this:
Exposing web services
In order to expose a web service using this component you first need to set-up a MessageDispatcher to look for endpoint mappings in a Spring XML file. If you plan on running inside a servlet container you probably want to use a MessageDispatcherServlet configured in web.xml.
By default the MessageDispatcherServlet will look for a Spring XML named /WEB-INF/spring-ws-servlet.xml. To use Camel with Spring-WS the only mandatory bean in that XML file is CamelEndpointMapping. This bean allows the MessageDispatcher to dispatch web service requests to your routes.
More information on setting up Spring-WS can be found in Writing Contract-First Web Services. Basically paragraph 3.6 "Implementing the Endpoint" is handled by this component (specifically paragraph 3.6.2 "Routing the Message to the Endpoint" is where CamelEndpointMapping comes in). Also don't forget to check out the Spring Web Services Example included in the Camel distribution.
Endpoint mapping in routes
With the XML configuration in-place you can now use Camel's DSL to define what web service requests are handled by your endpoint:
The following route will receive all web service requests that have a root element named "GetFoo" within the http://example.com/ namespace.
The following route will receive web service requests containing the http://example.com/GetFoo SOAP action.
The following route will receive all requests sent to http://example.com/foobar.
The route below will receive requests that contain the element <foobar>abc</foobar> anywhere inside the message (and the default namespace).
Alternative configuration, using existing endpoint mappings
For every endpoint with mapping-type beanname one bean of type CamelEndpointDispatcher with a corresponding name is required in the Registry/ApplicationContext. This bean acts as a bridge between the Camel endpoint and an existing endpoint mapping like PayloadRootQNameEndpointMapping.
|The use of the beanname mapping-type is primarily meant for (legacy) situations where you're already using Spring-WS and have endpoint mappings defined in a Spring XML file. The beanname mapping-type allows you to wire your Camel route into an existing endpoint mapping. When you're starting from scratch it's recommended to define your endpoint mappings as Camel URI's (as illustrated above with endpointMapping) since it requires less configuration and is more expressive. Alternatively you could use vanilla Spring-WS with the help of annotations.|
An example of a route using beanname:
Camel's pluggable data formats offer support for pojo/xml marshalling using libraries such as JAXB, XStream, JibX, Castor and XMLBeans. You can use these data formats in your route to sent and receive pojo's, to and from web services.
When accessing web services you can marshal the request and unmarshal the response message:
Similarly when providing web services, you can unmarshal XML requests to POJO's and marshal the response message back to XML: