The cxf: component provides integration with Apache CXF for connecting to JAX-WS services hosted in CXF.
Maven users will need to add the following dependency to their
pom.xml
for this component:
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-cxf</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency>
CXF dependencies | |
---|---|
If you want to learn about CXF dependencies, see the |
Note | |
---|---|
When using CXF as a consumer, the CAMEL:CXF Bean Component allows you to factor out how message payloads are received from their processing as a RESTful or SOAP web service. This has the potential of using a multitude of transports to consume web services. The bean component's configuration is also simpler and provides the fastest method to implement web services using Camel and CXF. |
cxf:bean:cxfEndpoint[?options]
Where cxfEndpoint represents a bean ID that references a bean in the Spring bean registry. With this URI format, most of the endpoint details are specified in the bean definition.
cxf://someAddress[?options]
Where someAddress specifies the CXF endpoint's address. With this URI format, most of the endpoint details are specified using options.
For either style above, you can append options to the URI as follows:
cxf:bean:cxfEndpoint?wsdlURL=wsdl/hello_world.wsdl&dataFormat=PAYLOAD
Name | Required | Description |
---|---|---|
wsdlURL
|
No |
The location of the WSDL. WSDL is obtained from endpoint address by default. For example:
|
serviceClass
|
Yes |
The name of the SEI (Service Endpoint Interface) class. This class can have, but does not require, JSR181 annotations. Since 2.0, this option is only required by POJO mode. If the wsdlURL option is provided, serviceClass is not required for PAYLOAD and MESSAGE mode. When wsdlURL option is used without serviceClass, the serviceName and portName (endpointName for Spring configuration) options MUST be provided. Since 2.0, it is possible to use Please be advised that the referenced object cannot
be a Proxy (Spring AOP Proxy is OK) as it relies on
Since 2.8, it is possible to omit both wsdlURL and serviceClass options for PAYLOAD and MESSAGE mode. When they are omitted, arbitrary XML elements can be put in CxfPayload's body in PAYLOAD mode to facilitate CXF Dispatch Mode. For example: |
serviceName
|
Only if more than one serviceName present in WSDL |
The service name this service is implementing, it maps to the
|
portName
|
Only if more than one portName under the
serviceName is present, and it is required for camel-cxf
consumer since camel 2.2 |
The port name this service is implementing, it maps to the
|
dataFormat
|
No | Which message data format the CXF endpoint supports. Possible values are:
POJO
(default), PAYLOAD ,
MESSAGE . |
relayHeaders
|
No | Available since Fuse Mediation Router 1.6.1. Please see the Description
of relayHeader option section for this option in Fuse Mediation Router 2.0.
Should a CXF endpoint relay headers along the route. Currently only available
when dataFormat=POJO . Possible values are:
true
(default), false . |
wrapped
|
No | Which kind of operation the CXF endpoint producer will invoke. Possible values
are: true , false
(default). |
wrappedStyle
|
No | Since 2.5.0 The WSDL style that describes how
parameters are represented in the SOAP body. If the value is false ,
CXF will chose the document-literal unwrapped style, If the value is
true , CXF will chose the document-literal wrapped style |
setDefaultBus
|
No | Specifies whether or not to use the default CXF bus for this endpoint. Possible
values are: true , false
(default). |
bus
|
No |
New in Fuse Mediation Router 2.0, use By default, uses the default bus created by CXF Bus Factory. |
cxfBinding
|
No |
New in Fuse Mediation Router 2.0, use |
headerFilterStrategy
|
No | New in Fuse Mediation Router 2.0, use # notation to reference a header
filter strategy object from the registry—for example,
headerFilterStrategy=#strategyName . The referenced object
must be an instance of
org.apache.camel.spi.HeaderFilterStrategy . |
loggingFeatureEnabled
|
No | New in 2.3, this option enables CXF Logging Feature which writes inbound and
outbound SOAP messages to log. Possible values are: true ,
false
(default). |
defaultOperationName
|
No |
New in 2.4, this option will set the default
|
defaultOperationNameSpace
|
No |
New in 2.4, this option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service. For example:
|
synchronous
|
No | New in 2.5, this option will let CXF endpoint decide to use sync or async API to
do the underlying work. The default value is false , which means
camel-cxf endpoint will try to use async API by default. |
publishedEndpointUrl
|
No |
New in 2.5, this option overrides the endpoint URL that appears in the
published WSDL that is accessed using the service address URL plus
|
properties.
|
No | Camel 2.8: Allows you to set custom CXF
properties in the endpoint URI. For example, setting
properties.mtom-enabled=true to enable MTOM. |
The serviceName
and portName
are QNames, so if you provide them
be sure to prefix them with their {namespace}
as shown in the
examples above.
NOTE From Fuse Mediation Router 1.5.1, the
serviceClass
for a CXF producer (that is, the
to
endpoint) should be a Java interface.
DataFormat | Description |
---|---|
POJO
|
POJOs (plain old Java objects) are the Java parameters to the method being invoked on the target server. Both Protocol and Logical JAX-WS handlers are supported. |
PAYLOAD
|
PAYLOAD is the message payload (the contents of the
soap:body ) after message configuration in the CXF
endpoint is applied. Only Protocol JAX-WS handler is supported. Logical JAX-WS
handler is not supported. |
MESSAGE
|
MESSAGE is the raw message that is received from the
transport layer. JAX-WS handler is not supported. |
You can determine the data format mode of an exchange by retrieving the exchange
property, CamelCXFDataFormat
. The exchange key constant is defined in
org.apache.camel.component.cxf.CxfConstants.DATA_FORMAT_PROPERTY
.
Since Camel 2.8, there is support for using Aries blueprint dependency injection for your CXF endpoints. The schema is very similar to the Spring schema, so the transition is fairly transparent.
For example:
<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.0.0" xmlns:camel-cxf="http://camel.apache.org/schema/blueprint/cxf" xmlns:cxfcore="http://cxf.apache.org/blueprint/core" xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd"> <camel-cxf:cxfEndpoint id="routerEndpoint" address="http://localhost:9001/router" serviceClass="org.apache.servicemix.examples.cxf.HelloWorld"> <camel-cxf:properties> <entry key="dataFormat" value="MESSAGE"/> </camel-cxf:properties> </camel-cxf:cxfEndpoint> <camel-cxf:cxfEndpoint id="serviceEndpoint" address="http://localhost:9000/SoapContext/SoapPort" serviceClass="org.apache.servicemix.examples.cxf.HelloWorld"> </camel-cxf:cxfEndpoint> <camelContext xmlns="http://camel.apache.org/schema/blueprint"> <route> <from uri="routerEndpoint"/> <to uri="log:request"/> </route> </camelContext> </blueprint>
Currently the endpoint element is the first supported CXF namespacehandler.
You can also use the bean references just as in spring
<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.0.0" xmlns:jaxws="http://cxf.apache.org/blueprint/jaxws" xmlns:cxf="http://cxf.apache.org/blueprint/core" xmlns:camel="http://camel.apache.org/schema/blueprint" xmlns:camelcxf="http://camel.apache.org/schema/blueprint/cxf" xsi:schemaLocation=" http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd http://cxf.apache.org/blueprint/jaxws http://cxf.apache.org/schemas/blueprint/jaxws.xsd http://cxf.apache.org/blueprint/core http://cxf.apache.org/schemas/blueprint/core.xsd "> <camelcxf:cxfEndpoint id="reportIncident" address="/camel-example-cxf-blueprint/webservices/incident" wsdlURL="META-INF/wsdl/report_incident.wsdl" serviceClass="org.apache.camel.example.reportincident.ReportIncidentEndpoint"> </camelcxf:cxfEndpoint> <bean id="reportIncidentRoutes" class="org.apache.camel.example.reportincident.ReportIncidentRoutes" /> <camelContext xmlns="http://camel.apache.org/schema/blueprint"> <routeBuilder ref="reportIncidentRoutes"/> </camelContext> </blueprint>
CXF's LoggingOutInterceptor
outputs outbound message that goes on
the wire to logging system (java.util.logging
). Since the
LoggingOutInterceptor
is in PRE_STREAM
phase
(but PRE_STREAM
phase is removed in MESSAGE
mode),
you have to configure LoggingOutInterceptor
to be run during the
WRITE
phase. The following is an example.
<bean id="loggingOutInterceptor" class="org.apache.cxf.interceptor.LoggingOutInterceptor"> <!-- it really should have been user-prestream but CXF does have such phase! --> <constructor-arg value="write"/> </bean> <cxf:cxfEndpoint id="serviceEndpoint" address="http://localhost:9002/helloworld" serviceClass="org.apache.camel.component.cxf.HelloService"> <cxf:outInterceptors> <ref bean="loggingOutInterceptor"/> </cxf:outInterceptors> <cxf:properties> <entry key="dataFormat" value="MESSAGE"/> </cxf:properties> </cxf:cxfEndpoint>
There are in-band and out-of-band on-the-wire headers from the perspective of a JAXWS WSDL-first developer.
The in-band headers are headers that are explicitly defined as part of the WSDL binding contract for an endpoint such as SOAP headers.
The out-of-band headers are headers that are serialized over the wire, but are not explicitly part of the WSDL binding contract.
Headers relaying/filtering is bi-directional.
When a route has a CXF endpoint and the developer needs to have on-the-wire headers,
such as SOAP headers, be relayed along the route to be consumed say by another JAXWS
endpoint, then relayHeaders
should be set to true
,
which is the default value.
The relayHeaders=true
setting expresses an intent to relay the
headers. The actual decision on whether a given header is relayed is delegated to a
pluggable instance that implements the MessageHeadersRelay
interface.
A concrete implementation of MessageHeadersRelay
will be consulted to
decide if a header needs to be relayed or not. There is already an implementation of
SoapMessageHeadersRelay
which binds itself to well-known SOAP
name spaces. Currently only out-of-band headers are filtered, and in-band headers will
always be relayed when relayHeaders=true
. If there is a header on the
wire, whose name space is unknown to the runtime, then a fall back
DefaultMessageHeadersRelay
will be used, which simply allows all
headers to be relayed.
The relayHeaders=false
setting asserts that all headers, in-band
and out-of-band, will be dropped.
You can plugin your own MessageHeadersRelay
implementations
overriding or adding additional ones to the list of relays. In order to override a
preloaded relay instance just make sure that your MessageHeadersRelay
implementation services the same name spaces as the one you looking to override. Also
note, that the overriding relay has to service all of the name spaces as the one you
looking to override, or else a runtime exception on route start up will be thrown as
this would introduce an ambiguity in name spaces to relay instance mappings.
<cxf:cxfEndpoint ...> <cxf:properties> <entry key="org.apache.camel.cxf.message.headers.relays"> <list> <ref bean="customHeadersRelay"/> </list> </entry> </cxf:properties> </cxf:cxfEndpoint> <bean id="customHeadersRelay" class="org.apache.camel.component.cxf.soap.headers.CustomHeadersRelay"/>
Take a look at the tests that show how you'd be able to relay/drop headers here:
https://svn.apache.org/repos/asf/camel/branches/camel-1.x/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/soap/headers/CxfMessageHeadersRelayTest.java
POJO
andPAYLOAD
modes are supported. InPOJO
mode, only out-of-band message headers are available for filtering as the in-band headers have been processed and removed from the header list by CXF. The in-band headers are incorporated into theMessageContentList
inPOJO
mode. Thecamel-cxf
component does make any attempt to remove the in-band headers from theMessageContentList
as it does in 1.6.1. If filtering of in-band headers is required, please usePAYLOAD
mode or plug in a (pretty straightforward) CXF interceptor/JAXWS Handler to the CXF endpoint.The Message Header Relay mechanism has been merged into
CxfHeaderFilterStrategy
. TherelayHeaders
option, its semantics, and default value remain the same, but it is a property ofCxfHeaderFilterStrategy
.Here is an example of configuring it.<bean id="dropAllMessageHeadersStrategy" class="org.apache.camel.component.cxf.CxfHeaderFilterStrategy"> <!-- Set relayHeaders to false to drop all SOAP headers --> <property name="relayHeaders" value="false"/> </bean>
Then, your endpoint can reference the
CxfHeaderFilterStrategy
.<route> <from uri="cxf:bean:routerNoRelayEndpoint?headerFilterStrategy=#dropAllMessageHeadersStrategy"/> <to uri="cxf:bean:serviceNoRelayEndpoint?headerFilterStrategy=#dropAllMessageHeadersStrategy"/> </route>
The
MessageHeadersRelay
interface has changed slightly and has been renamed toMessageHeaderFilter
. It is a property ofCxfHeaderFilterStrategy
. Here is an example of configuring user defined Message Header Filters:<bean id="customMessageFilterStrategy" class="org.apache.camel.component.cxf.CxfHeaderFilterStrategy"> <property name="messageHeaderFilters"> <list> <!-- SoapMessageHeaderFilter is the built in filter. It can be removed by omitting it. --> <bean class="org.apache.camel.component.cxf.SoapMessageHeaderFilter"/> <!-- Add custom filter here --> <bean class="org.apache.camel.component.cxf.soap.headers.CustomHeaderFilter"/> </list> </property> </bean>
Other than
relayHeaders
, there are new properties that can be configured inCxfHeaderFilterStrategy
.
Name | Description | type | Required? | Default value |
---|---|---|---|---|
relayHeaders
|
All message headers will be processed by Message Header Filters | boolean
|
No | true (1.6.1 behavior) |
relayAllMessageHeaders
|
All message headers will be propagated (without processing by Message Header Filters) | boolean
|
No | false (1.6.1 behavior) |
allowFilterNamespaceClash
|
If two filters overlap in activation namespace, the property control how it
should be handled. If the value is true , last one wins. If
the value is false , it will throw an exception |
boolean
|
No | false (1.6.1 behavior) |
You can configure the CXF endpoint with the Spring configuration file shown below, and
you can also embed the endpoint into the camelContext
tags. When you
are invoking the service endpoint, you can set the operationName
and
operationNameSpace
headers to explicitly state which operation
you are calling.
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:cxf="http://activemq.apache.org/camel/schema/cxfEndpoint" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd http://activemq.apache.org/camel/schema/cxfEndpoint http://activemq.apache.org/camel/schema/cxf/camel-cxf-1.6.0.xsd http://activemq.apache.org/camel/schema/spring http://activemq.apache.org/camel/schema/spring/camel-spring.xsd "> <cxf:cxfEndpoint id="routerEndpoint" address="http://localhost:9003/CamelContext/RouterPort" serviceClass="org.apache.hello_world_soap_http.GreeterImpl"/> <cxf:cxfEndpoint id="serviceEndpoint" address="http://localhost:9000/SoapContext/SoapPort" wsdlURL="testutils/hello_world.wsdl" serviceClass="org.apache.hello_world_soap_http.Greeter" endpointName="s:SoapPort" serviceName="s:SOAPService" xmlns:s="http://apache.org/hello_world_soap_http" /> <camelContext id="camel" xmlns="http://activemq.apache.org/camel/schema/spring"> <route> <from uri="cxf:bean:routerEndpoint" /> <to uri="cxf:bean:serviceEndpoint" /> </route> </camelContext> </beans>
NOTE In Camel 2.x we change to use
http://camel.apache.org/schema/cxf
as the CXF endpoint's target
namespace.
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:cxf="http://camel.apache.org/schema/cxf" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd http://camel.apache.org/schema/cxf http://camel.apache.org/schema/cxf/camel-cxf.xsd http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd "> ...
Note | |
---|---|
In Fuse Mediation Router 2.x, the
|
Be sure to include the JAX-WS schemaLocation
attribute specified on
the root beans element. This allows CXF to validate the file and is required. Also note
the namespace declarations at the end of the <cxf:cxfEndpoint/>
tag--these are required because the combined {namespace}localName
syntax is
presently not supported for this tag's attribute values.
The cxf:cxfEndpoint
element supports many additional
attributes:
Name | Value |
---|---|
PortName
|
The endpoint name this service is implementing, it maps to the
wsdl:port@name . In the format of
ns:PORT_NAME where ns is a namespace
prefix valid at this scope. |
serviceName
|
The service name this service is implementing, it maps to the
wsdl:service@name . In the format of
ns:SERVICE_NAME where ns is a
namespace prefix valid at this scope. |
wsdlURL
|
The location of the WSDL. Can be on the classpath, file system, or be hosted remotely. |
bindingId
|
The bindingId for the service model to use. |
address
|
The service publish address. |
bus
|
The bus name that will be used in the JAX-WS endpoint. |
serviceClass
|
The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not. |
It also supports many child elements:
Name | Value |
---|---|
cxf:inInterceptors
|
The incoming interceptors for this endpoint. A list of
<bean> or <ref> . |
cxf:inFaultInterceptors
|
The incoming fault interceptors for this endpoint. A list of
<bean> or <ref> . |
cxf:outInterceptors
|
The outgoing interceptors for this endpoint. A list of
<bean> or <ref> . |
cxf:outFaultInterceptors
|
The outgoing fault interceptors for this endpoint. A list of
<bean> or <ref> . |
cxf:properties
|
A properties map which should be supplied to the JAX-WS endpoint. See below. |
cxf:handlers
|
A JAX-WS handler list which should be supplied to the JAX-WS endpoint. See below. |
cxf:dataBinding
|
You can specify the which DataBinding will be use in the
endpoint. This can be supplied using the Spring <bean
class="MyDataBinding"/> syntax. |
cxf:binding
|
You can specify the BindingFactory for this endpoint to use.
This can be supplied using the Spring <bean
class="MyBindingFactory"/> syntax. |
cxf:features
|
The features that hold the interceptors for this endpoint. A list of
<bean> s or <ref> s |
cxf:schemaLocations
|
The schema locations for endpoint to use. A list of
<schemaLocation> s |
cxf:serviceFactory
|
The service factory for this endpoint to use. This can be supplied using the
Spring <bean class="MyServiceFactory"/> syntax |
You can find more advanced examples which show how to provide interceptors, properties and handlers here: http://cwiki.apache.org/CXF20DOC/jax-ws-configuration.html
Note | |
---|---|
You can use CXF:properties to set the CXF endpoint's <cxf:cxfEndpoint id="testEndpoint" address="http://localhost:9000/router" serviceClass="org.apache.camel.component.cxf.HelloService" endpointName="s:PortName" serviceName="s:ServiceName" xmlns:s="http://www.example.com/test"> <cxf:properties> <entry key="dataFormat" value="MESSAGE"/> <entry key="setDefaultBus" value="true"/> </cxf:properties> </cxf:cxfEndpoint> |
CXF's default logger is java.util.logging
. If you want to change it
to log4j
, proceed as follows. Create a file, in the classpath, named
META-INF/cxf/org.apache.cxf.logger
. This file should contain the
fully-qualified name of the class,
org.apache.cxf.common.logging.Log4jLogger
, with no comments, on a
single line.
If you are using some soap client such as PHP, you will get this kind of error, because CXF doesn't add the XML start document "<?xml version="1.0" encoding="utf-8"?>"
Error:sendSms: SoapFault exception: [Client] looks like we got no XML document in [...]
To resolved this issue, you just need to tell StaxOutInterceptor to write the XML start document for you.
public class WriteXmlDeclarationInterceptor extends AbstractPhaseInterceptor<SoapMessage> { public WriteXmlDeclarationInterceptor() { super(Phase.PRE_STREAM); addBefore(StaxOutInterceptor.class.getName()); } public void handleMessage(SoapMessage message) throws Fault { message.put("org.apache.cxf.stax.force-start-document", Boolean.TRUE); } }
You can add a customer interceptor like this and configure it into you
camel-cxf
endpont
<cxf:cxfEndpoint id="routerEndpoint" address="http://localhost:${CXFTestSupport.port2}/CXFGreeterRouterTest/CamelContext/RouterPort" serviceClass="org.apache.hello_world_soap_http.GreeterImpl"> <cxf:outInterceptors> <!-- This interceptor will force the CXF server send the XML start document to client --> <bean class="org.apache.camel.component.cxf.WriteXmlDeclarationInterceptor"/> </cxf:outInterceptors> <cxf:properties> <!-- Set the publishedEndpointUrl which could override the service address from generated WSDL as you want --> <entry key="publishedEndpointUrl" value="http://www.simple.com/services/test" /> </cxf:properties> </cxf:cxfEndpoint>
Or adding a message header for it like this if you are using Camel 2.4.
// set up the response context which force start document Map<String, Object> map = new HashMap<String, Object>(); map.put("org.apache.cxf.stax.force-start-document", Boolean.TRUE); exchange.getOut().setHeader(Client.RESPONSE_CONTEXT, map);
The camel-cxf
endpoint consumer POJO
data format is
based on the cxf
invoker, so the message header has a property with the name of
CxfConstants.OPERATION_NAME
and the message body is a list of the
SEI method parameters.
public class PersonProcessor implements Processor { private static final transient Logger LOG = LoggerFactory.getLogger(PersonProcessor.class); @SuppressWarnings("unchecked") public void process(Exchange exchange) throws Exception { LOG.info("processing exchange in camel"); BindingOperationInfo boi = (BindingOperationInfo)exchange.getProperty(BindingOperationInfo.class.toString()); if (boi != null) { LOG.info("boi.isUnwrapped" + boi.isUnwrapped()); } // Get the parameters list which element is the holder. MessageContentsList msgList = (MessageContentsList)exchange.getIn().getBody(); Holder<String> personId = (Holder<String>)msgList.get(0); Holder<String> ssn = (Holder<String>)msgList.get(1); Holder<String> name = (Holder<String>)msgList.get(2); if (personId.value == null || personId.value.length() == 0) { LOG.info("person id 123, so throwing exception"); // Try to throw out the soap fault message org.apache.camel.wsdl_first.types.UnknownPersonFault personFault = new org.apache.camel.wsdl_first.types.UnknownPersonFault(); personFault.setPersonId(""); org.apache.camel.wsdl_first.UnknownPersonFault fault = new org.apache.camel.wsdl_first.UnknownPersonFault("Get the null value of person name", personFault); // Since camel has its own exception handler framework, we can't throw the exception to trigger it // We just set the fault message in the exchange for camel-cxf component handling and return exchange.getOut().setFault(true); exchange.getOut().setBody(fault); return; } name.value = "Bonjour"; ssn.value = "123"; LOG.info("setting Bonjour as the response"); // Set the response message, first element is the return value of the operation, // the others are the holders of method parameters exchange.getOut().setBody(new Object[] {null, personId, ssn, name}); } }
The camel-cxf
endpoint producer is based on the cxf client API. First you need to specify the operation name in the message
header, then add the method parameters to a list, and initialize the message with this
parameter list. The response message's body is a messageContentsList
, you
can get the result from that list.
Note: After Fuse Mediation Router 1.5,the message
body changed from an object array to a message content list. If you still want to get
the object array from the message body, you can get the body using
message.getbody(Object[].class)
, as follows:
Exchange senderExchange = new DefaultExchange(context, ExchangePattern.InOut); final List<String> params = new ArrayList<String>(); // Prepare the request message for the camel-cxf procedure params.add(TEST_MESSAGE); senderExchange.getIn().setBody(params); senderExchange.getIn().setHeader(CxfConstants.OPERATION_NAME, ECHO_OPERATION); Exchange exchange = template.send("direct:EndpointA", senderExchange); org.apache.camel.Message out = exchange.getOut(); // The response message's body is an MessageContentsList which first element is the return value of the operation, // If there are some holder parameters, the holder parameter will be filled in the reset of List. // The result will be extract from the MessageContentsList with the String class type MessageContentsList result = (MessageContentsList)out.getBody(); LOG.info("Received output text: " + result.get(0)); Map<String, Object> responseContext = CastUtils.cast((Map)out.getHeader(Client.RESPONSE_CONTEXT)); assertNotNull(responseContext); assertEquals("We should get the response context here", "UTF-8", responseContext.get(org.apache.cxf.message.Message.ENCODING)); assertEquals("Reply body on Camel is wrong", "echo " + TEST_MESSAGE, result.get(0));
PAYLOAD
means that you process the payload
message from the SOAP envelope. You can use the Header.HEADER_LIST
as
the key to set or get the SOAP headers and use the List<Element>
to set or get SOAP body elements. In Fuse Mediation Router 1.x, you can get the
List<Element>
and header from the CXF Message, but if you want
to set the response message, you need to create the CXF message using the CXF
API.
protected RouteBuilder createRouteBuilder() { return new RouteBuilder() { public void configure() { from(simpleEndpointURI + "&dataFormat=PAYLOAD").to("log:info").process(new Processor() { public void process(final Exchange exchange) throws Exception { Message inMessage = exchange.getIn(); if (inMessage instanceof CxfMessage) { CxfMessage cxfInMessage = (CxfMessage) inMessage; CxfMessage cxfOutMessage = (CxfMessage) exchange.getOut(); List<Element> inElements = cxfInMessage.getMessage().get(List.class); List<Element> outElements = new ArrayList<Element>(); XmlConverter converter = new XmlConverter(); String documentString = ECHO_RESPONSE; if (inElements.get(0).getLocalName().equals("echoBoolean")) { documentString = ECHO_BOOLEAN_RESPONSE; } org.apache.cxf.message.Exchange ex = ((CxfExchange)exchange).getExchange(); Endpoint ep = ex.get(Endpoint.class); org.apache.cxf.message.Message response = ep.getBinding().createMessage(); Document outDocument = converter.toDOMDocument(documentString); outElements.add(outDocument.getDocumentElement()); response.put(List.class, outElements); cxfOutMessage.setMessage(response); } } }); } }; }
In Fuse Mediation Router 2.0: CxfMessage.getBody()
will return
an org.apache.camel.component.cxf.CxfPayload
object, which has
getters for SOAP message headers and Body elements. This change enables decoupling the
native CXF message from the Fuse Mediation Router message.
protected RouteBuilder createRouteBuilder() { return new RouteBuilder() { public void configure() { from(SIMPLE_ENDPOINT_URI + "&dataFormat=PAYLOAD").to("log:info").process(new Processor() { @SuppressWarnings("unchecked") public void process(final Exchange exchange) throws Exception { CxfPayload<SoapHeader> requestPayload = exchange.getIn().getBody(CxfPayload.class); List<Element> inElements = requestPayload.getBody(); List<Element> outElements = new ArrayList<Element>(); // You can use a customer toStringConverter to turn a CxfPayLoad message into String as you want String request = exchange.getIn().getBody(String.class); XmlConverter converter = new XmlConverter(); String documentString = ECHO_RESPONSE; if (inElements.get(0).getLocalName().equals("echoBoolean")) { documentString = ECHO_BOOLEAN_RESPONSE; assertEquals("Get a wrong request", ECHO_BOOLEAN_REQUEST, request); } else { assertEquals("Get a wrong request", ECHO_REQUEST, request); } Document outDocument = converter.toDOMDocument(documentString); outElements.add(outDocument.getDocumentElement()); // set the payload header with null CxfPayload<SoapHeader> responsePayload = new CxfPayload<SoapHeader>(null, outElements); exchange.getOut().setBody(responsePayload); } }); } }; }
POJO
means that the data format is a list of Java
objects when the CXF endpoint produces or consumes Camel exchanges. Even
though Fuse Mediation Router exposes the message body as POJOs in this mode, the CXF component still
provides access to read and write SOAP headers. However, since CXF interceptors remove
in-band SOAP headers from the header list after they have been processed, only
out-of-band SOAP headers are available in POJO mode.
The following example illustrates how to get/set SOAP headers. Suppose we have a route that forwards from one CXF endpoint to another. That is, SOAP Client -> Fuse Mediation Router -> CXF service. We can attach two processors to obtain/insert SOAP headers at (1) before request goes out to the CXF service and (2) before response comes back to the SOAP Client. Processor (1) and (2) in this example are InsertRequestOutHeaderProcessor and InsertResponseOutHeaderProcessor. Our route looks like this:
<route> <from uri="cxf:bean:routerRelayEndpointWithInsertion"/> <process ref="InsertRequestOutHeaderProcessor" /> <to uri="cxf:bean:serviceRelayEndpointWithInsertion"/> <process ref="InsertResponseOutHeaderProcessor" /> </route>
In 2.x SOAP headers are propagated to
and from Fuse Mediation Router Message headers. The Fuse Mediation Router message header name is
org.apache.cxf.headers.Header.list
, which is a constant defined in CXF
(org.apache.cxf.headers.Header.HEADER_LIST
). The header value is a
List<>
of CXF SoapHeader
objects
(org.apache.cxf.binding.soap.SoapHeader
). The following snippet is the
InsertResponseOutHeaderProcessor
(that inserts a new SOAP header in the
response message). The way to access SOAP headers in both
InsertResponseOutHeaderProcessor
and
InsertRequestOutHeaderProcessor
are actually the same. The only
difference between the two processors is setting the direction of the inserted SOAP
header.
public static class InsertResponseOutHeaderProcessor implements Processor { @SuppressWarnings("unchecked") public void process(Exchange exchange) throws Exception { List<SoapHeader> soapHeaders = (List)exchange.getIn().getHeader(Header.HEADER_LIST); // Insert a new header String xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?><outofbandHeader " + "xmlns=\"http://cxf.apache.org/outofband/Header\" hdrAttribute=\"testHdrAttribute\" " + "xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" soap:mustUnderstand=\"1\">" + "<name>New_testOobHeader</name><value>New_testOobHeaderValue</value></outofbandHeader>"; SoapHeader newHeader = new SoapHeader(soapHeaders.get(0).getName(), DOMUtils.readXml(new StringReader(xml)).getDocumentElement()); // make sure direction is OUT since it is a response message. newHeader.setDirection(Direction.DIRECTION_OUT); //newHeader.setMustUnderstand(false); soapHeaders.add(newHeader); } }
In 1.x SOAP headers are not
propagated to and from Fuse Mediation Router Message headers. Users have to go deeper into CXF APIs
to access SOAP headers. Also, accessing the SOAP headers in a request message is
slightly different than in a response message. The
InsertRequestOutHeaderProcessor
and
InsertResponseOutHeaderProcessor
are as follow.s:
public static class InsertRequestOutHeaderProcessor implements Processor { public void process(Exchange exchange) throws Exception { CxfMessage message = exchange.getIn().getBody(CxfMessage.class); Message cxf = message.getMessage(); List<SoapHeader> soapHeaders = (List)cxf.get(Header.HEADER_LIST); // Insert a new header String xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?><outofbandHeader " + "xmlns=\"http://cxf.apache.org/outofband/Header\" hdrAttribute=\"testHdrAttribute\" " + "xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" soap:mustUnderstand=\"1\">" + "<name>New_testOobHeader</name><value>New_testOobHeaderValue</value></outofbandHeader>"; SoapHeader newHeader = new SoapHeader(soapHeaders.get(0).getName(), DOMUtils.readXml(new StringReader(xml)).getDocumentElement()); // make sure direction is IN since it is a request message. newHeader.setDirection(Direction.DIRECTION_IN); //newHeader.setMustUnderstand(false); soapHeaders.add(newHeader); } } public static class InsertResponseOutHeaderProcessor implements Processor { public void process(Exchange exchange) throws Exception { CxfMessage message = exchange.getIn().getBody(CxfMessage.class); Map responseContext = (Map)message.getMessage().get(Client.RESPONSE_CONTEXT); List<SoapHeader> soapHeaders = (List)responseContext.get(Header.HEADER_LIST); // Insert a new header String xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?><outofbandHeader " + "xmlns=\"http://cxf.apache.org/outofband/Header\" hdrAttribute=\"testHdrAttribute\" " + "xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" soap:mustUnderstand=\"1\">" + "<name>New_testOobHeader</name><value>New_testOobHeaderValue</value></outofbandHeader>"; SoapHeader newHeader = new SoapHeader(soapHeaders.get(0).getName(), DOMUtils.readXml(new StringReader(xml)).getDocumentElement()); // make sure direction is OUT since it is a response message. newHeader.setDirection(Direction.DIRECTION_OUT); //newHeader.setMustUnderstand(false); soapHeaders.add(newHeader); } }
We have already shown how to access SOAP message (CxfPayload
object) in
PAYLOAD
mode (see How to deal with the message for a camel-cxf endpoint in PAYLOAD data format).
In Fuse Mediation Router 2.x Once you obtain a
CxfPayload
object, you can invoke the
CxfPayload.getHeaders()
method that returns a List
of DOM
Elements (SOAP headers).
from(getRouterEndpointURI()).process(new Processor() { @SuppressWarnings("unchecked") public void process(Exchange exchange) throws Exception { CxfPayload<SoapHeader> payload = exchange.getIn().getBody(CxfPayload.class); List<Element> elements = payload.getBody(); assertNotNull("We should get the elements here", elements); assertEquals("Get the wrong elements size", 1, elements.size()); assertEquals("Get the wrong namespace URI", "http://camel.apache.org/pizza/types", elements.get(0).getNamespaceURI()); List<SoapHeader> headers = payload.getHeaders(); assertNotNull("We should get the headers here", headers); assertEquals("Get the wrong headers size", headers.size(), 1); assertEquals("Get the wrong namespace URI", ((Element)(headers.get(0).getObject())).getNamespaceURI(), "http://camel.apache.org/pizza/types"); } }) .to(getServiceEndpointURI());
In Fuse Mediation Router 1.x: You can
get/set to the CXF Message by the key org.apache.cxf.headers.Header.list
which is a constant defined in CXF
(org.apache.cxf.headers.Header.HEADER_LIST
).
from(routerEndpointURI).process(new Processor() { @SuppressWarnings("unchecked") public void process(Exchange exchange) throws Exception { Message inMessage = exchange.getIn(); CxfMessage message = (CxfMessage) inMessage; List<Element> elements = message.getMessage().get(List.class); assertNotNull("We should get the payload elements here" , elements); assertEquals("Get the wrong elements size" , elements.size(), 1); assertEquals("Get the wrong namespace URI" , elements.get(0).getNamespaceURI(), "http://camel.apache.org/pizza/types"); List<SoapHeader> headers = CastUtils.cast((List<?>)message.getMessage().get(Header.HEADER_LIST)); assertNotNull("We should get the headers here", headers); assertEquals("Get the wrong headers size", headers.size(), 1); assertEquals("Get the wrong namespace URI" , ((Element)(headers.get(0).getObject())).getNamespaceURI(), "http://camel.apache.org/pizza/types"); } }) .to(serviceEndpointURI);
SOAP headers are not available in MESSAGE
mode as SOAP processing is
skipped.
If you are using a CXF endpoint to consume the SOAP request, you may need to throw the
SOAP Fault
from the camel context. Basically, you can use the
throwFault
DSL to do that; it works for POJO
,
PAYLOAD
and MESSAGE
data format. You can
define the soap fault like this:
SOAP_FAULT = new SoapFault(EXCEPTION_MESSAGE, SoapFault.FAULT_CODE_CLIENT); Element detail = SOAP_FAULT.getOrCreateDetail(); Document doc = detail.getOwnerDocument(); Text tn = doc.createTextNode(DETAIL_TEXT); detail.appendChild(tn);
Then throw it as you like:
from(routerEndpointURI).setFaultBody(constant(SOAP_FAULT));
If your CXF endpoint is working in the MESSAGE
data format, you
could set the the SOAP Fault message in the message body and set the response code in
the message header.
from(routerEndpointURI).process(new Processor() { public void process(Exchange exchange) throws Exception { Message out = exchange.getOut(); // Set the message body with the out.setBody(this.getClass().getResourceAsStream("SoapFaultMessage.xml")); // Set the response code here out.setHeader(org.apache.cxf.message.Message.RESPONSE_CODE, new Integer(500)); } });
Note | |
---|---|
The response code setting only works in Fuse Mediation Router version >= 1.5.1 |
The same is true for the POJO data format. You can set the SOAP Fault on the
Out body and also indicate it's a fault by calling
Message.setFault(true)
, as follows:
from("direct:start").onException(SoapFault.class).maximumRedeliveries(0).handled(true) .process(new Processor() { public void process(Exchange exchange) throws Exception { SoapFault fault = exchange .getProperty(Exchange.EXCEPTION_CAUGHT, SoapFault.class); exchange.getOut().setFault(true); exchange.getOut().setBody(fault); } }).end().to(serviceURI);
cxf client API provides a way to invoke the operation with request and response context. If you are using a CXF endpoint producer to invoke the external Web service, you can set the request context and get the response context with the following code:
CxfExchange exchange = (CxfExchange)template.send(getJaxwsEndpointUri(), new Processor() { public void process(final Exchange exchange) { final List<String> params = new ArrayList<String>(); params.add(TEST_MESSAGE); // Set the request context to the inMessage Map<String, Object> requestContext = new HashMap<String, Object>(); requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, JAXWS_SERVER_ADDRESS); exchange.getIn().setBody(params); exchange.getIn().setHeader(Client.REQUEST_CONTEXT , requestContext); exchange.getIn().setHeader(CxfConstants.OPERATION_NAME, GREET_ME_OPERATION); } }); org.apache.camel.Message out = exchange.getOut(); // The output is an object array, the first element of the array is the return value Object\[\] output = out.getBody(Object\[\].class); LOG.info("Received output text: " + output\[0\]); // Get the response context form outMessage Map<String, Object> responseContext = CastUtils.cast((Map)out.getHeader(Client.RESPONSE_CONTEXT)); assertNotNull(responseContext); assertEquals("Get the wrong wsdl opertion name", "{http://apache.org/hello_world_soap_http}greetMe", responseContext.get("javax.xml.ws.wsdl.operation").toString());
POJO Mode: Both SOAP with Attachment and MTOM are supported (see example in Payload Mode for enabling MTOM). However, SOAP with Attachment is not tested. Since attachments are marshalled and unmarshalled into POJOs, users typically do not need to deal with the attachment themself. Attachments are propagated to Camel message's attachments since 2.1. So, it is possible to retreive attachments by Camel Message API
DataHandler Message.getAttachment(String id)
.
Payload Mode: MTOM is supported since 2.1. Attachments can be retrieved by Camel Message APIs mentioned above. SOAP with Attachment is not supported as there is no SOAP processing in this mode.
To enable MTOM, set the CXF endpoint property "mtom_enabled" to true. (I believe you can only do it with Spring.)
<cxf:cxfEndpoint id="routerEndpoint" address="http://localhost:${CXFTestSupport.port1}/CxfMtomRouterPayloadModeTest/jaxws-mtom/hello" wsdlURL="mtom.wsdl" serviceName="ns:HelloService" endpointName="ns:HelloPort" xmlns:ns="http://apache.org/camel/cxf/mtom_feature"> <cxf:properties> <!-- enable mtom by setting this property to true --> <entry key="mtom-enabled" value="true"/> <!-- set the camel-cxf endpoint data fromat to PAYLOAD mode --> <entry key="dataFormat" value="PAYLOAD"/> </cxf:properties>
You can produce a Camel message with attachment to send to a CXF endpoint in Payload mode.
Exchange exchange = context.createProducerTemplate().send("direct:testEndpoint", new Processor() { public void process(Exchange exchange) throws Exception { exchange.setPattern(ExchangePattern.InOut); List<Element> elements = new ArrayList<Element>(); elements.add(DOMUtils.readXml(new StringReader(MtomTestHelper.REQ_MESSAGE)).getDocumentElement()); CxfPayload<SoapHeader> body = new CxfPayload<SoapHeader>(new ArrayList<SoapHeader>(), elements); exchange.getIn().setBody(body); exchange.getIn().addAttachment(MtomTestHelper.REQ_PHOTO_CID, new DataHandler(new ByteArrayDataSource(MtomTestHelper.REQ_PHOTO_DATA, "application/octet-stream"))); exchange.getIn().addAttachment(MtomTestHelper.REQ_IMAGE_CID, new DataHandler(new ByteArrayDataSource(MtomTestHelper.requestJpeg, "image/jpeg"))); } }); // process response CxfPayload<SoapHeader> out = exchange.getOut().getBody(CxfPayload.class); Assert.assertEquals(1, out.getBody().size()); Map<String, String> ns = new HashMap<String, String>(); ns.put("ns", MtomTestHelper.SERVICE_TYPES_NS); ns.put("xop", MtomTestHelper.XOP_NS); XPathUtils xu = new XPathUtils(ns); Element ele = (Element)xu.getValue("//ns:DetailResponse/ns:photo/xop:Include", out.getBody().get(0), XPathConstants.NODE); String photoId = ele.getAttribute("href").substring(4); // skip "cid:" ele = (Element)xu.getValue("//ns:DetailResponse/ns:image/xop:Include", out.getBody().get(0), XPathConstants.NODE); String imageId = ele.getAttribute("href").substring(4); // skip "cid:" DataHandler dr = exchange.getOut().getAttachment(photoId); Assert.assertEquals("application/octet-stream", dr.getContentType()); MtomTestHelper.assertEquals(MtomTestHelper.RESP_PHOTO_DATA, IOUtils.readBytesFromStream(dr.getInputStream())); dr = exchange.getOut().getAttachment(imageId); Assert.assertEquals("image/jpeg", dr.getContentType()); BufferedImage image = ImageIO.read(dr.getInputStream()); Assert.assertEquals(560, image.getWidth()); Assert.assertEquals(300, image.getHeight());
You can also consume a Camel message received from a CXF endpoint in Payload mode.
public static class MyProcessor implements Processor { @SuppressWarnings("unchecked") public void process(Exchange exchange) throws Exception { CxfPayload<SoapHeader> in = exchange.getIn().getBody(CxfPayload.class); // verify request Assert.assertEquals(1, in.getBody().size()); Map<String, String> ns = new HashMap<String, String>(); ns.put("ns", MtomTestHelper.SERVICE_TYPES_NS); ns.put("xop", MtomTestHelper.XOP_NS); XPathUtils xu = new XPathUtils(ns); Element ele = (Element)xu.getValue("//ns:Detail/ns:photo/xop:Include", in.getBody().get(0), XPathConstants.NODE); String photoId = ele.getAttribute("href").substring(4); // skip "cid:" Assert.assertEquals(MtomTestHelper.REQ_PHOTO_CID, photoId); ele = (Element)xu.getValue("//ns:Detail/ns:image/xop:Include", in.getBody().get(0), XPathConstants.NODE); String imageId = ele.getAttribute("href").substring(4); // skip "cid:" Assert.assertEquals(MtomTestHelper.REQ_IMAGE_CID, imageId); DataHandler dr = exchange.getIn().getAttachment(photoId); Assert.assertEquals("application/octet-stream", dr.getContentType()); MtomTestHelper.assertEquals(MtomTestHelper.REQ_PHOTO_DATA, IOUtils.readBytesFromStream(dr.getInputStream())); dr = exchange.getIn().getAttachment(imageId); Assert.assertEquals("image/jpeg", dr.getContentType()); MtomTestHelper.assertEquals(MtomTestHelper.requestJpeg, IOUtils.readBytesFromStream(dr.getInputStream())); // create response List<Element> elements = new ArrayList<Element>(); elements.add(DOMUtils.readXml(new StringReader(MtomTestHelper.RESP_MESSAGE)).getDocumentElement()); CxfPayload<SoapHeader> body = new CxfPayload<SoapHeader>(new ArrayList<SoapHeader>(), elements); exchange.getOut().setBody(body); exchange.getOut().addAttachment(MtomTestHelper.RESP_PHOTO_CID, new DataHandler(new ByteArrayDataSource(MtomTestHelper.RESP_PHOTO_DATA, "application/octet-stream"))); exchange.getOut().addAttachment(MtomTestHelper.RESP_IMAGE_CID, new DataHandler(new ByteArrayDataSource(MtomTestHelper.responseJpeg, "image/jpeg"))); } }
Message Mode: Attachments are not supported as it does not process the message at all.
It is possible to configure a CXF endpoint so that, when a Java exception is thrown on
the server side, the stack trace for the exception is marshalled into a fault message
and returned to the client. To enable this feaure, set the dataFormat
to
PAYLOAD
and set the faultStackTraceEnabled
property to
true
in the cxfEndpoint
element, as follows:
<cxf:cxfEndpoint id="router" address="http://localhost:9002/TestMessage"
wsdlURL="ship.wsdl"
endpointName="s:TestSoapEndpoint"
serviceName="s:TestService"
xmlns:s="http://test">
<cxf:properties>
<!-- enable sending the stack trace back to client; the default value is false-->
<entry key="faultStackTraceEnabled" value="true" />
<entry key="dataFormat" value="PAYLOAD" />
</cxf:properties>
</cxf:cxfEndpoint>
For security reasons, the stack trace does not include the causing exception (that is,
the part of a stack trace that follows Caused by
). If you want to include
the causing exception in the stack trace, set the
exceptionMessageCauseEnabled
property to true
in the
cxfEndpoint
element, as follows:
<cxf:cxfEndpoint id="router" address="http://localhost:9002/TestMessage"
wsdlURL="ship.wsdl"
endpointName="s:TestSoapEndpoint"
serviceName="s:TestService"
xmlns:s="http://test">
<cxf:properties>
<!-- enable to show the cause exception message and the default value is false -->
<entry key="exceptionMessageCauseEnabled" value="true" />
<!-- enable to send the stack trace back to client, the default value is false-->
<entry key="faultStackTraceEnabled" value="true" />
<entry key="dataFormat" value="PAYLOAD" />
</cxf:properties>
</cxf:cxfEndpoint>
Warning | |
---|---|
You should only enable the |