Modified: websites/production/camel/content/cxf.html
==============================================================================
--- websites/production/camel/content/cxf.html (original)
+++ websites/production/camel/content/cxf.html Fri Aug 25 11:19:54 2017
@@ -36,17 +36,6 @@
<![endif]-->
- <link href='//camel.apache.org/styles/highlighter/styles/shCoreCamel.css'
rel='stylesheet' type='text/css' />
- <link href='//camel.apache.org/styles/highlighter/styles/shThemeCamel.css'
rel='stylesheet' type='text/css' />
- <script src='//camel.apache.org/styles/highlighter/scripts/shCore.js'
type='text/javascript'></script>
- <script src='//camel.apache.org/styles/highlighter/scripts/shBrushJava.js'
type='text/javascript'></script>
- <script src='//camel.apache.org/styles/highlighter/scripts/shBrushXml.js'
type='text/javascript'></script>
- <script src='//camel.apache.org/styles/highlighter/scripts/shBrushPlain.js'
type='text/javascript'></script>
-
- <script type="text/javascript">
- SyntaxHighlighter.defaults['toolbar'] = false;
- SyntaxHighlighter.all();
- </script>
<title>
Apache Camel: CXF
@@ -86,443 +75,121 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="CXF-CXFComponent">CXF
Component</h2><div class="confluence-information-macro
confluence-information-macro-note"><span class="aui-icon aui-icon-small
aui-iconfont-warning confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>When using CXF as a consumer, the
<a shape="rect" href="cxf-bean-component.html">CXF Bean Component</a> 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.</p></div></div><div class="confluence-information-macro
confluence-information-macro-tip"><span class="aui-icon aui-icon-small
aui-iconfont-approve confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>When using CXF in
streaming modes (see DataFormat option), then also read about <a shape="rect"
href="stream-caching.html">Stream caching</a>.</p></div></div><p>The
<strong>cxf:</strong> component provides integration with <a shape="rect"
href="http://cxf.apache.org">Apache CXF</a> for connecting to JAX-WS services
hosted in CXF.</p><p></p><div class="toc-macro client-side-toc-macro"
data-headerelements="H1,H2,H3,H4,H5,H6,H7"></div><p>Maven users will need to
add the following dependency to their <code>pom.xml</code> for this
component:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<dependency>
+<div class="wiki-content maincontent"><h2 id="CXF-CXFComponent">CXF
Component</h2><rich-text-body><p>When using CXF as a consumer, the <a
shape="rect" href="cxf-bean-component.html">CXF Bean Component</a> 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.</p></rich-text-body><rich-text-body><p>When using CXF in streaming
modes (see DataFormat option), then also read about <a shape="rect"
href="stream-caching.html">Stream caching</a>.</p></rich-text-body><p>The
<strong>cxf:</strong> component provides integration with <a shape="rect"
href="http://cxf.apache.org">Apache CXF</a> for connecting to JAX-WS services
hosted in CXF.</p><p></p><p>Maven users will need to add the following
dependency to their <code>pom.xm
l</code> for this component:</p><parameter
ac:name="language">xml</parameter><plain-text-body><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>
-]]></script>
-</div></div><div class="confluence-information-macro
confluence-information-macro-tip"><p class="title">CXF dependencies</p><span
class="aui-icon aui-icon-small aui-iconfont-approve
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>If you want to learn about CXF
dependencies you can checkout the <code><a shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/cxf/trunk/distribution/src/main/release/lib/WHICH_JARS">WHICH-JARS</a></code>
text file.</p></div></div><h3 id="CXF-URIformat">URI format</h3><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[cxf:bean:cxfEndpoint[?options]
-]]></script>
-</div></div><p>Where <strong>cxfEndpoint</strong> 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.</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[cxf://someAddress[?options]
-]]></script>
-</div></div><p>Where <strong>someAddress</strong> specifies the CXF endpoint's
address. With this URI format, most of the endpoint details are specified using
options.</p><p>For either style above, you can append options to the URI as
follows:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[cxf:bean:cxfEndpoint?wsdlURL=wsdl/hello_world.wsdl&dataFormat=PAYLOAD
-]]></script>
-</div></div><h3 id="CXF-Options">Options</h3><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Required</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>wsdlURL</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The location of the WSDL. It is obtained
from endpoint address by default. <br clear="none" class="atl-forced-newline">
<br clear="none" class="atl-forced-newline"> <em>Example</em>: <a shape="rect"
class="external-link" href="file://local/wsdl/hello.wsdl"
rel="nofollow">file://local/wsdl/hello.wsdl</a> or
<code>wsdl/hello.wsdl</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>serviceClass</code></p></td><td colspan="1"
rowspan="1" class="
confluenceTd"><p>Yes</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The name of the SEI (Service Endpoint Interface) class.
This class can have, but does not require, JSR181 annotations. <br clear="none"
class="atl-forced-newline"> 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
<strong>MUST</strong> be provided. It is possible to use <code>#</code>
notation to reference a <code>serviceClass</code> object instance from the
registry. E.g. <code>serviceClass=#beanName</code>. The
<code>serviceClass</code> for a CXF producer (that is, the <code>to</code>
endpoint) should be a Java interface.<br clear="none"
class="atl-forced-newline"> <strong>Since 2.8,</strong> 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. <br clear="none"
class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> Please
be advised that the <strong>referenced object cannot be a Proxy</strong>
(Spring AOP Proxy is OK) as it relies on
<code>Object.getClass().getName()</code> method for non Spring AOP Proxy. <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Example</em>:
<code>org.apache.camel.Hello</code></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>serviceName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The service name this service is
implementing, it maps to the <code>wsdl:service@name</code>. <br clear="none"
class="atl-forced-newline"> <br clear="none" class="atl-forced-newline">
<strong>Required</strong> for camel-cxf consumer
since camel-2.2.0 or if more than one <code>serviceName</code> is present in
WSDL. <br clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Example</em>:
{http:­//org.apache.camel}ServiceName</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>endpointName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The port name this service is implementing,
it maps to the <code>wsdl:port@name</code>. <br clear="none"
class="atl-forced-newline"> <br clear="none" class="atl-forced-newline">
<strong>Required</strong> for camel-cxf consumer since camel-2.2.0 or if more
than one <code>portName</code> is present under <code>serviceName</code>. <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Example</em>:
{http:­//org.apache.camel}PortName</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><
p><code>dataFormat</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The data type messages supported by the CXF endpoint.
<br clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>POJO</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>: <code>POJO</code>,
<code>PAYLOAD</code>, <code>MESSAGE</code></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>relayHeaders</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Please see the <strong>Description
of</strong> <code><strong>relayHeaders</strong></code> <strong>option</strong>
section for this option. Should a CXF endpoint relay headers along the route.
Currently only available when <code>dataFormat=POJO</code> <br clear="none"
class="atl-forced-newline"> <br clear="none" class="atl-f
orced-newline"> <em>Default</em>: <code>true</code> <br clear="none"
class="atl-forced-newline"> <em>Example</em>: <code>true</code>,
<code>false</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>wrapped</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Which kind of operation that CXF endpoint producer will
invoke <br clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>false</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>: <code>true</code>,
<code>false</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>wrappedStyle</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>New in 2.5.0</strong> 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 <br clear="none"
class="atl-forced-newline"> <br clear="none" class="atl-forced-newline">
<em>Default</em>: <code>Null</code> <br clear="none"
class="atl-forced-newline"> <em>Example</em>: <code>true</code>,
<code>false</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>setDefaultBus</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Deprecated</strong> Will set the default bus
when CXF endpoint create a bus by itself. This option is deprecated use
defaultBus from Camel 2.16 onwards.<br clear="none" class="atl-forced-newline">
<br clear="none" class="atl-forced-newline"> <em>Default</em>:
<code>false</code> <br clear="none" class="atl-forced-newline">
<em>Example</em>: <code>true</code>, <code>false</code></p></td></tr><tr><td
colspan
="1" rowspan="1" class="confluenceTd"><span><code>defaultBus</code><br
clear="none"></span></td><td colspan="1" rowspan="1"
class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd"><p><span><strong>Camel 2.16:</strong> Will set the default
bus when CXF endpoint create a bus by itself
</span></p><p><span><span> </span><em>Default</em><span>:
</span><code>false</code><span> </span><br clear="none"
class="atl-forced-newline"><span> </span><em>Example</em><span>:
</span><code>true</code><span>,
</span><code>false</code></span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>bus</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>A default bus created by CXF Bus Factory. Use
<code>#</code> notation to reference a bus object from the registry. The
referenced object must be an instance of <code>org.apache.cxf.Bus</code>. <br
clear="none" class="atl-for
ced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>:
<code>bus=#busName</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxfBinding</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Use <code>#</code> notation to reference a CXF binding
object from the registry. The referenced object must be an instance of
<code>org.apache.camel.component.cxf.CxfBinding</code> (use an instance of
<code>org.apache.camel.component.cxf.DefaultCxfBinding</code>). <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Example</em>:
<code>cxfBinding=#bindingName</code></p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>headerFilterStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Use <code>#</code> notation to reference a
header filter strategy object from the registry. The referenced object must
be an instance of <code>org.apache.camel.spi.HeaderFilterStrategy</code> (use
an instance of
<code>org.apache.camel.component.cxf.CxfHeaderFilterStrategy</code>). <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Example</em>:
<code>headerFilterStrategy=#strategyName</code></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>loggingFeatureEnabled</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in 2.3. This option enables CXF Logging
Feature which writes inbound and outbound SOAP messages to log. <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>false</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>:
<code>loggingFeatureEnabled</code><code>=true</code></p></td></tr><tr><td co
lspan="1" rowspan="1"
class="confluenceTd"><p><code>defaultOperationName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in 2.4, this option will set the
default operationName that will be used by the CxfProducer which invokes the
remote service. <br clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>null</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>:
<code>defaultOperationName</code><code>=greetMe</code></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>defaultOperationNamespace</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in 2.4. This option will set the
default operationNamespace that will be used by the CxfProducer which invokes
the remote service. <br clear="none" class="atl-forced-newline"> <br clear
="none" class="atl-forced-newline"> <em>Default</em>: <code>null</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>:
<code>defaultOperationNamespace</code><code>=</code><code><a shape="rect"
class="external-link"
href="http://apache.org/hello_world_soap_http">http://apache.org/hello_world_soap_http</a></code></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>synchronous</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>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. <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>false</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>:
synchronous=true</p></td></tr><tr><td colspan="1" rowspan="1
" class="confluenceTd"><p><code>publishedEndpointUrl</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in 2.5. This option can override the
endpointUrl that published from the WSDL which can be accessed with service
address url plus ?wsdl. <br clear="none" class="atl-forced-newline"> <br
clear="none" class="atl-forced-newline"> <em>Default</em>: <code>null</code>
<br clear="none" class="atl-forced-newline"> <em>Example</em>:
publshedEndpointUrl=<a shape="rect" class="external-link"
href="http://example.com/service"
rel="nofollow">http://example.com/service</a></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>properties.XXX</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> Allows to set
custom properties to CXF in the endpoint uri. For example setting
<code>properties.m
tom-enabled=true</code> to enable MTOM. <code style="line-height:
1.4285715;">properties.org.apache.cxf.interceptor.OneWayProcessorInterceptor.USE_ORIGINAL_THREAD=true
</code><span style="line-height: 1.4285715;">just make sure the CXF doesn't
switch the thread when start the invocation.</span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>allowStreaming</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>New in <strong>Camel 2.8.2</strong>. This option
controls whether the CXF component, when running in PAYLOAD mode (see below),
will DOM parse the incoming messages into DOM Elements or keep the payload as a
javax.xml.transform.Source object that would allow streaming in some
cases.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>skipFaultLogging</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>New in <strong>Camel 2.11</strong>. This option
controls whether the PhaseInterceptorChain skips logging the Fault that it
catches.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><span style="line-height:
1.4285715;"><code>cxfEndpointConfigurer</code><br
clear="none"></span></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>New in <strong>Camel 2.11</strong>. This option could
apply the implementation of
<code><span>org.apache.camel.component.cxf.CxfEndpointConfigurer which
</span></code><span>supports to configure the CXF endpoint in
</span><span> programmatic way. </span><span style="line-height:
1.4285715;">Since </span><strong style="line-height: 1.4285715;">Camel 2.15.0,
</strong>user can configure the CXF server and client by implementing
configure{Server|Client} method of
<span><code>CxfEndpointConfigurer</code>.</span></p></td></tr><tr><td
colspan="1" r
owspan="1" class="confluenceTd"><p><code>username</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in <strong>Camel 2.12.3</strong> This
option is used to set the basic authentication information of username for the
CXF client.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>password</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>New in <strong>Camel 2.12.3</strong> This option is
used to set the basic authentication information of password for the CXF
client.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>continuationTimeout</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in <strong>Camel 2.14.0 </strong>This
option is used to set the CXF continuation timeout which could be used
in CxfConsumer by default when the CXF server is using Jetty or Servlet
transport. (Before <strong>Camel 2.14.0</strong>, CxfConsumer just set the
continuation timeout to be 0, which means the continuation suspend operation
never timeout.)</p><p><em> Default</em>: <span style="font-family:
monospace;">30000</span><br clear="none"
class="atl-forced-newline"> <em>Example</em>:
continuation=80000</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>cookieHandler</code></td><td colspan="1" rowspan="1"
class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd">New in<strong> Camel 2.19.0:</strong> Configure a cookie
handler to maintain a HTTP session</td></tr></tbody></table></div><p>The
<code>serviceName</code> and <code>portName</code> are <a shape="rect"
class="external-link" href="http://en.wikipedia.org/wiki/QName"
rel="nofollow">QNames</a>, so if you provide them be sure to prefix them with
their {namespace} as shown in the examples above.
</p><h4 id="CXF-Thedescriptionsofthedataformats">The descriptions of the
dataformats</h4><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>DataFormat</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>POJO</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>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.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>PAYLOAD</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>PAYLOAD</code> is the
message payload (the contents of the <code>soap:body</code>) after message
configuration in the CXF endpoint is applied. Only Protocol JAX-WS handler is
supported. Logical JAX-WS handler is not supported.</p></td></tr><t
r><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>MESSAGE</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>MESSAGE</code> is the raw message
that is received from the transport layer. It is not suppose to touch or change
Stream, some of the CXF interceptors will be removed if you are using this kind
of DataFormat so you can't see any soap headers after the camel-cxf consumer
and JAX-WS handler is not supported.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>CXF_MESSAGE</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>New in <strong>Camel
2.8.2</strong>, <code>CXF_MESSAGE</code> allows for invoking the full
capabilities of CXF interceptors by converting the message from the transport
layer into a raw SOAP message</p></td></tr></tbody></table></div><p>You can
determine the data format mode of an exchange by retrieving the exchange
property, <code>CamelCXFDataFormat</code>. The exchange key constant is defi
ned in
<code>org.apache.camel.component.cxf.CxfConstants.DATA_FORMAT_PROPERTY</code>.</p><h5
id="CXF-HowtoenableCXF'sLoggingOutInterceptorinMESSAGEmode">How to enable
CXF's LoggingOutInterceptor in MESSAGE mode</h5><p>CXF's
<code>LoggingOutInterceptor</code> outputs outbound message that goes on the
wire to logging system (Java Util Logging). Since the
<code>LoggingOutInterceptor</code> is in <code>PRE_STREAM</code> phase (but
<code>PRE_STREAM</code> phase is removed in <code>MESSAGE</code> mode), you
have to configure <code>LoggingOutInterceptor</code> to be run during the
<code>WRITE</code> phase. The following is an example.</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
- <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="target/write"/>
- </bean>
-
-<cxf:cxfEndpoint id="serviceEndpoint"
address="http://localhost:${CXFTestSupport.port2}/LoggingInterceptorInMessageModeTest/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>
-]]></script>
-</div></div><h4 id="CXF-DescriptionofrelayHeadersoption">Description of
relayHeaders option</h4><p>There are <em>in-band</em> and <em>out-of-band</em>
on-the-wire headers from the perspective of a JAXWS WSDL-first
developer.</p><p>The <em>in-band</em> headers are headers that are explicitly
defined as part of the WSDL binding contract for an endpoint such as SOAP
headers.</p><p>The <em>out-of-band</em> headers are headers that are serialized
over the wire, but are not explicitly part of the WSDL binding
contract.</p><p>Headers relaying/filtering is bi-directional.</p><p>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 <code>relayHeaders</code> should be set to
<code>true</code>, which is the default value.</p><h5
id="CXF-AvailableonlyinPOJOmode">Available only in POJO mode</h5><p>The
<code>relayHeaders=true</code> express an intent to relay the head
ers. The actual decision on whether a given header is relayed is delegated to
a pluggable instance that implements the <code>MessageHeadersRelay</code>
interface. A concrete implementation of <code>MessageHeadersRelay</code> will
be consulted to decide if a header needs to be relayed or not. There is already
an implementation of <code>SoapMessageHeadersRelay</code> 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 <code>relayHeaders=true</code>.
If there is a header on the wire, whose name space is unknown to the runtime,
then a fall back <code>DefaultMessageHeadersRelay</code> will be used, which
simply allows all headers to be relayed.</p><p>The
<code>relayHeaders=false</code> setting asserts that all headers in-band and
out-of-band will be dropped.</p><p>You can plugin your own
<code>MessageHeadersRelay</code> implementations overriding or adding
additional ones to the list of relays
. In order to override a preloaded relay instance just make sure that your
<code>MessageHeadersRelay</code> 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.</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<cxf:cxfEndpoint ...>
+</plain-text-body><parameter ac:name="title">CXF
dependencies</parameter><rich-text-body><p>If you want to learn about CXF
dependencies you can checkout the <code><a shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/cxf/trunk/distribution/src/main/release/lib/WHICH_JARS">WHICH-JARS</a></code>
text file.</p></rich-text-body><h3 id="CXF-URIformat">URI
format</h3><parameter
ac:name="language">java</parameter><plain-text-body>cxf:bean:cxfEndpoint[?options]
+</plain-text-body><p>Where <strong>cxfEndpoint</strong> 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.</p><parameter
ac:name="language">java</parameter><plain-text-body>cxf://someAddress[?options]
+</plain-text-body><p>Where <strong>someAddress</strong> specifies the CXF
endpoint's address. With this URI format, most of the endpoint details are
specified using options.</p><p>For either style above, you can append options
to the URI as follows:</p><parameter
ac:name="language">java</parameter><plain-text-body>cxf:bean:cxfEndpoint?wsdlURL=wsdl/hello_world.wsdl&dataFormat=PAYLOAD
+</plain-text-body><h3 id="CXF-Options">Options</h3><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Required</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>wsdlURL</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The location of the WSDL. It is obtained
from endpoint address by default. <br clear="none" class="atl-forced-newline">
<br clear="none" class="atl-forced-newline"> <em>Example</em>: <a shape="rect"
class="external-link" href="file://local/wsdl/hello.wsdl"
rel="nofollow">file://local/wsdl/hello.wsdl</a> or
<code>wsdl/hello.wsdl</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>serviceClass</code></p></td><td colspan="1"
rowspan="1" c
lass="confluenceTd"><p>Yes</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The name of the SEI (Service Endpoint Interface) class.
This class can have, but does not require, JSR181 annotations. <br clear="none"
class="atl-forced-newline"> 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
<strong>MUST</strong> be provided. It is possible to use <code>#</code>
notation to reference a <code>serviceClass</code> object instance from the
registry. E.g. <code>serviceClass=#beanName</code>. The
<code>serviceClass</code> for a CXF producer (that is, the <code>to</code>
endpoint) should be a Java interface.<br clear="none"
class="atl-forced-newline"> <strong>Since 2.8,</strong> it is possible to omit
both wsdlURL and serviceClass options for PAYLOAD and MESSAGE mode. Whe
n they are omitted, arbitrary XML elements can be put in CxfPayload's body in
PAYLOAD mode to facilitate CXF Dispatch Mode. <br clear="none"
class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> Please
be advised that the <strong>referenced object cannot be a Proxy</strong>
(Spring AOP Proxy is OK) as it relies on
<code>Object.getClass().getName()</code> method for non Spring AOP Proxy. <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Example</em>:
<code>org.apache.camel.Hello</code></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>serviceName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The service name this service is
implementing, it maps to the <code>wsdl:service@name</code>. <br clear="none"
class="atl-forced-newline"> <br clear="none" class="atl-forced-newline">
<strong>Required</strong> for camel-cxf con
sumer since camel-2.2.0 or if more than one <code>serviceName</code> is
present in WSDL. <br clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Example</em>:
{http:­//org.apache.camel}ServiceName</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>endpointName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The port name this service is implementing,
it maps to the <code>wsdl:port@name</code>. <br clear="none"
class="atl-forced-newline"> <br clear="none" class="atl-forced-newline">
<strong>Required</strong> for camel-cxf consumer since camel-2.2.0 or if more
than one <code>portName</code> is present under <code>serviceName</code>. <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Example</em>:
{http:­//org.apache.camel}PortName</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenc
eTd"><p><code>dataFormat</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The data type messages supported by the CXF endpoint.
<br clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>POJO</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>: <code>POJO</code>,
<code>PAYLOAD</code>, <code>MESSAGE</code></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>relayHeaders</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Please see the <strong>Description
of</strong> <code><strong>relayHeaders</strong></code> <strong>option</strong>
section for this option. Should a CXF endpoint relay headers along the route.
Currently only available when <code>dataFormat=POJO</code> <br clear="none"
class="atl-forced-newline"> <br clear="none" class=
"atl-forced-newline"> <em>Default</em>: <code>true</code> <br clear="none"
class="atl-forced-newline"> <em>Example</em>: <code>true</code>,
<code>false</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>wrapped</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Which kind of operation that CXF endpoint producer will
invoke <br clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>false</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>: <code>true</code>,
<code>false</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>wrappedStyle</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>New in 2.5.0</strong> 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 <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>Null</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>: <code>true</code>,
<code>false</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>setDefaultBus</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Deprecated</strong> Will set the default bus
when CXF endpoint create a bus by itself. This option is deprecated use
defaultBus from Camel 2.16 onwards.<br clear="none" class="atl-forced-newline">
<br clear="none" class="atl-forced-newline"> <em>Default</em>:
<code>false</code> <br clear="none" class="atl-forced-newline">
<em>Example</em>: <code>true</code>, <code>false</code></p></td></tr><tr><td c
olspan="1" rowspan="1" class="confluenceTd"><span><code>defaultBus</code><br
clear="none"></span></td><td colspan="1" rowspan="1"
class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd"><p><span><strong>Camel 2.16:</strong> Will set the default
bus when CXF endpoint create a bus by itself
</span></p><p><span><span> </span><em>Default</em><span>:
</span><code>false</code><span> </span><br clear="none"
class="atl-forced-newline"><span> </span><em>Example</em><span>:
</span><code>true</code><span>,
</span><code>false</code></span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>bus</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>A default bus created by CXF Bus Factory. Use
<code>#</code> notation to reference a bus object from the registry. The
referenced object must be an instance of <code>org.apache.cxf.Bus</code>. <br
clear="none" class="a
tl-forced-newline"> <br clear="none" class="atl-forced-newline">
<em>Example</em>: <code>bus=#busName</code></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>cxfBinding</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Use <code>#</code> notation to reference a
CXF binding object from the registry. The referenced object must be an instance
of <code>org.apache.camel.component.cxf.CxfBinding</code> (use an instance of
<code>org.apache.camel.component.cxf.DefaultCxfBinding</code>). <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Example</em>:
<code>cxfBinding=#bindingName</code></p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>headerFilterStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Use <code>#</code> notation to refer
ence a header filter strategy object from the registry. The referenced object
must be an instance of <code>org.apache.camel.spi.HeaderFilterStrategy</code>
(use an instance of
<code>org.apache.camel.component.cxf.CxfHeaderFilterStrategy</code>). <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Example</em>:
<code>headerFilterStrategy=#strategyName</code></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>loggingFeatureEnabled</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in 2.3. This option enables CXF Logging
Feature which writes inbound and outbound SOAP messages to log. <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>false</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>:
<code>loggingFeatureEnabled</code><code>=true</code></p></td></tr><tr>
<td colspan="1" rowspan="1"
class="confluenceTd"><p><code>defaultOperationName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in 2.4, this option will set the
default operationName that will be used by the CxfProducer which invokes the
remote service. <br clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>null</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>:
<code>defaultOperationName</code><code>=greetMe</code></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>defaultOperationNamespace</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in 2.4. This option will set the
default operationNamespace that will be used by the CxfProducer which invokes
the remote service. <br clear="none" class="atl-forced-newline"> <br
clear="none" class="atl-forced-newline"> <em>Default</em>: <code>null</code>
<br clear="none" class="atl-forced-newline"> <em>Example</em>:
<code>defaultOperationNamespace</code><code>=</code><code><a shape="rect"
class="external-link"
href="http://apache.org/hello_world_soap_http">http://apache.org/hello_world_soap_http</a></code></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>synchronous</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>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. <br
clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Default</em>: <code>false</code> <br
clear="none" class="atl-forced-newline"> <em>Example</em>:
synchronous=true</p></td></tr><tr><td colspan="1" rows
pan="1" class="confluenceTd"><p><code>publishedEndpointUrl</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in 2.5. This option can override the
endpointUrl that published from the WSDL which can be accessed with service
address url plus ?wsdl. <br clear="none" class="atl-forced-newline"> <br
clear="none" class="atl-forced-newline"> <em>Default</em>: <code>null</code>
<br clear="none" class="atl-forced-newline"> <em>Example</em>:
publshedEndpointUrl=<a shape="rect" class="external-link"
href="http://example.com/service"
rel="nofollow">http://example.com/service</a></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>properties.XXX</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> Allows to set
custom properties to CXF in the endpoint uri. For example setting <code>proper
ties.mtom-enabled=true</code> to enable MTOM. <code style="line-height:
1.4285715;">properties.org.apache.cxf.interceptor.OneWayProcessorInterceptor.USE_ORIGINAL_THREAD=true
</code><span style="line-height: 1.4285715;">just make sure the CXF doesn't
switch the thread when start the invocation.</span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>allowStreaming</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>New in <strong>Camel 2.8.2</strong>. This option
controls whether the CXF component, when running in PAYLOAD mode (see below),
will DOM parse the incoming messages into DOM Elements or keep the payload as a
javax.xml.transform.Source object that would allow streaming in some
cases.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>skipFaultLogging</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspa
n="1" class="confluenceTd"><p>New in <strong>Camel 2.11</strong>. This option
controls whether the PhaseInterceptorChain skips logging the Fault that it
catches.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><span style="line-height:
1.4285715;"><code>cxfEndpointConfigurer</code><br
clear="none"></span></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>New in <strong>Camel 2.11</strong>. This option could
apply the implementation of
<code><span>org.apache.camel.component.cxf.CxfEndpointConfigurer which
</span></code><span>supports to configure the CXF endpoint in
</span><span> programmatic way. </span><span style="line-height:
1.4285715;">Since </span><strong style="line-height: 1.4285715;">Camel 2.15.0,
</strong>user can configure the CXF server and client by implementing
configure{Server|Client} method of
<span><code>CxfEndpointConfigurer</code>.</span></p></td></tr><tr><td colspan
="1" rowspan="1" class="confluenceTd"><p><code>username</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in <strong>Camel 2.12.3</strong> This
option is used to set the basic authentication information of username for the
CXF client.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>password</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>New in <strong>Camel 2.12.3</strong> This option is
used to set the basic authentication information of password for the CXF
client.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>continuationTimeout</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>New in <strong>Camel 2.14.0 </strong>This
option is used to set the CXF continuation timeout which could b
e used in CxfConsumer by default when the CXF server is using Jetty or Servlet
transport. (Before <strong>Camel 2.14.0</strong>, CxfConsumer just set the
continuation timeout to be 0, which means the continuation suspend operation
never timeout.)</p><p><em> Default</em>: <span style="font-family:
monospace;">30000</span><br clear="none"
class="atl-forced-newline"> <em>Example</em>:
continuation=80000</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>cookieHandler</code></td><td colspan="1" rowspan="1"
class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd">New in<strong> Camel 2.19.0:</strong> Configure a cookie
handler to maintain a HTTP session</td></tr></tbody></table></div><p>The
<code>serviceName</code> and <code>portName</code> are <a shape="rect"
class="external-link" href="http://en.wikipedia.org/wiki/QName"
rel="nofollow">QNames</a>, so if you provide them be sure to prefix them with
their {namespace} as shown in the examples
above.</p><h4 id="CXF-Thedescriptionsofthedataformats">The descriptions of the
dataformats</h4><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>DataFormat</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>POJO</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>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.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>PAYLOAD</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>PAYLOAD</code> is the
message payload (the contents of the <code>soap:body</code>) after message
configuration in the CXF endpoint is applied. Only Protocol JAX-WS handler is
supported. Logical JAX-WS handler is not supported.</p></td><
/tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>MESSAGE</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>MESSAGE</code> is the raw message
that is received from the transport layer. It is not suppose to touch or change
Stream, some of the CXF interceptors will be removed if you are using this kind
of DataFormat so you can't see any soap headers after the camel-cxf consumer
and JAX-WS handler is not supported.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>CXF_MESSAGE</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>New in <strong>Camel
2.8.2</strong>, <code>CXF_MESSAGE</code> allows for invoking the full
capabilities of CXF interceptors by converting the message from the transport
layer into a raw SOAP message</p></td></tr></tbody></table></div><p>You can
determine the data format mode of an exchange by retrieving the exchange
property, <code>CamelCXFDataFormat</code>. The exchange key constant i
s defined in
<code>org.apache.camel.component.cxf.CxfConstants.DATA_FORMAT_PROPERTY</code>.</p><h5
id="CXF-HowtoenableCXF'sLoggingOutInterceptorinMESSAGEmode">How to enable
CXF's LoggingOutInterceptor in MESSAGE mode</h5><p>CXF's
<code>LoggingOutInterceptor</code> outputs outbound message that goes on the
wire to logging system (Java Util Logging). Since the
<code>LoggingOutInterceptor</code> is in <code>PRE_STREAM</code> phase (but
<code>PRE_STREAM</code> phase is removed in <code>MESSAGE</code> mode), you
have to configure <code>LoggingOutInterceptor</code> to be run during the
<code>WRITE</code> phase. The following is an
example.<plain-text-body>{snippet:id=enableLoggingOutInterceptor|lang=xml|url=camel/trunk/components/camel-cxf/src/test/resources/org/apache/camel/component/cxf/LoggingInterceptorInMessageModeTest-context.xml}</plain-text-body></p><h4
id="CXF-DescriptionofrelayHeadersoption">Description of relayHeaders
option</h4><p>There are <em>in-band</em> and <em>out-of-band
</em> on-the-wire headers from the perspective of a JAXWS WSDL-first
developer.</p><p>The <em>in-band</em> headers are headers that are explicitly
defined as part of the WSDL binding contract for an endpoint such as SOAP
headers.</p><p>The <em>out-of-band</em> headers are headers that are serialized
over the wire, but are not explicitly part of the WSDL binding
contract.</p><p>Headers relaying/filtering is bi-directional.</p><p>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 <code>relayHeaders</code> should be set to
<code>true</code>, which is the default value.</p><h5
id="CXF-AvailableonlyinPOJOmode">Available only in POJO mode</h5><p>The
<code>relayHeaders=true</code> express 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 <code>MessageHeadersRelay<
/code> interface. A concrete implementation of
<code>MessageHeadersRelay</code> will be consulted to decide if a header needs
to be relayed or not. There is already an implementation of
<code>SoapMessageHeadersRelay</code> 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 <code>relayHeaders=true</code>. If there is a
header on the wire, whose name space is unknown to the runtime, then a fall
back <code>DefaultMessageHeadersRelay</code> will be used, which simply allows
all headers to be relayed.</p><p>The <code>relayHeaders=false</code> setting
asserts that all headers in-band and out-of-band will be dropped.</p><p>You can
plugin your own <code>MessageHeadersRelay</code> implementations overriding or
adding additional ones to the list of relays. In order to override a preloaded
relay instance just make sure that your <code>MessageHeadersRelay</code>
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.</p><parameter
ac:name="">xml</parameter><plain-text-body><cxf:cxfEndpoint ...>
<cxf:properties>
- <entry key="org.apache.camel.cxf.message.headers.relays">
+ <entry key="org.apache.camel.cxf.message.headers.relays">
<list>
- <ref bean="customHeadersRelay"/>
+ <ref bean="customHeadersRelay"/>
</list>
</entry>
</cxf:properties>
</cxf:cxfEndpoint>
- <bean id="customHeadersRelay"
class="org.apache.camel.component.cxf.soap.headers.CustomHeadersRelay"/>
-]]></script>
-</div></div><p>Take a look at the tests that show how you'd be able to
relay/drop headers here:</p><p><a shape="rect" class="external-link"
href="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">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</a></p><h5
id="CXF-ChangessinceRelease2.0">Changes since Release
2.0</h5><ul><li><code>POJO</code> and <code>PAYLOAD</code> modes are supported.
In <code>POJO</code> mode, only out-of-band message headers are available for
filtering as the in-band headers have been processed and removed from header
list by CXF. The in-band headers are incorporated into the
<code>MessageContentList</code> in POJO mode. The <code>camel-cxf</code>
component does make any attempt to remove the in-band headers from the <code>Mes
sageContentList</code>. If filtering of in-band headers is required, please
use <code>PAYLOAD</code> mode or plug in a (pretty straightforward) CXF
interceptor/JAXWS Handler to the CXF endpoint.</li><li><p>The Message Header
Relay mechanism has been merged into <code>CxfHeaderFilterStrategy</code>. The
<code>relayHeaders</code> option, its semantics, and default value remain the
same, but it is a property of <code>CxfHeaderFilterStrategy</code>.<br
clear="none"> Here is an example of configuring it.</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
-<bean id="dropAllMessageHeadersStrategy"
class="org.apache.camel.component.cxf.common.header.CxfHeaderFilterStrategy">
-
- <!-- Set relayHeaders to false to drop all SOAP headers -->
- <property name="relayHeaders" value="false"/>
-
-</bean>
-]]></script>
-</div></div>Then, your endpoint can reference the
<code>CxfHeaderFilterStrategy</code>.<div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
-<route>
- <from
uri="cxf:bean:routerNoRelayEndpoint?headerFilterStrategy=#dropAllMessageHeadersStrategy"/>
- <to
uri="cxf:bean:serviceNoRelayEndpoint?headerFilterStrategy=#dropAllMessageHeadersStrategy"/>
-</route>
-]]></script>
-</div></div></li><li><p>The <code>MessageHeadersRelay</code> interface has
changed slightly and has been renamed to <code>MessageHeaderFilter</code>. It
is a property of <code>CxfHeaderFilterStrategy</code>. Here is an example of
configuring user defined Message Header Filters:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
-<bean id="customMessageFilterStrategy"
class="org.apache.camel.component.cxf.common.header.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.common.header.SoapMessageHeaderFilter"/>
-
- <!-- Add custom filter here -->
- <bean
class="org.apache.camel.component.cxf.soap.headers.CustomHeaderFilter"/>
- </list>
- </property>
-</bean>
-]]></script>
-</div></div></li><li><p>Other than <code>relayHeaders</code>, there are new
properties that can be configured in
<code>CxfHeaderFilterStrategy</code>.</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Required</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>relayHeaders</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>All message headers will be processed by
Message Header Filters <br clear="none" class="atl-forced-newline"> <br
clear="none" class="atl-forced-newline"> <em>Type</em>: <code>boolean</code>
<br clear="none" class="atl-forced-newline"> <em>Default</em>:
<code>true</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>relayAllMessage
Headers</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>All message headers will be propagated (without
processing by Message Header Filters) <br clear="none"
class="atl-forced-newline"> <br clear="none" class="atl-forced-newline">
<em>Type</em>: <code>boolean</code> <br clear="none"
class="atl-forced-newline"> <em>Default</em>:
<code>false</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>allowFilterNamespaceClash</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>If two filters overlap in activation
namespace, the property control how it should be handled. If the value is
<code>true</code>, last one wins. If the value is <code>false</code>, it will
throw an exception <br clear="none" class="atl-forced-newline"> <br
clear="none" class="atl-forced-newline"> <em>Type</em>: <code>boolean</code>
<br clear="none" class="atl-forced-newline"> <em>Default</em>:
<code>false</code></p></td></tr></tbody></table></div><h3
id="CXF-ConfiguretheCXFendpointswithSpring">Configure the CXF endpoints with
Spring</h3><p>You can configure the CXF endpoint with the Spring configuration
file shown below, and you can also embed the endpoint into the
<code>camelContext</code> tags. When you are invoking the service endpoint, you
can set the <code>operationName</code> and <code>operationNamespace</code>
headers to explicitly state which operation you are calling.</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<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="
+ <bean id="customHeadersRelay"
class="org.apache.camel.component.cxf.soap.headers.CustomHeadersRelay"/>
+</plain-text-body><p>Take a look at the tests that show how you'd be able to
relay/drop headers here:</p><p><a shape="rect" class="external-link"
href="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">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</a></p><h5
id="CXF-ChangessinceRelease2.0">Changes since Release
2.0</h5><ul><li><code>POJO</code> and <code>PAYLOAD</code> modes are supported.
In <code>POJO</code> mode, only out-of-band message headers are available for
filtering as the in-band headers have been processed and removed from header
list by CXF. The in-band headers are incorporated into the
<code>MessageContentList</code> in POJO mode. The <code>camel-cxf</code>
component does make any attempt to remove the in-band headers from the <co
de>MessageContentList</code>. If filtering of in-band headers is required,
please use <code>PAYLOAD</code> mode or plug in a (pretty straightforward) CXF
interceptor/JAXWS Handler to the CXF endpoint.</li><li><p>The Message Header
Relay mechanism has been merged into <code>CxfHeaderFilterStrategy</code>. The
<code>relayHeaders</code> option, its semantics, and default value remain the
same, but it is a property of <code>CxfHeaderFilterStrategy</code>.<br
clear="none"> Here is an example of configuring
it.<plain-text-body>{snippet:id=dropAllMessageHeadersStrategy|lang=xml|url=camel/trunk/components/camel-cxf/src/test/resources/org/apache/camel/component/cxf/soap/headers/CxfMessageHeadersRelayTest-context.xml}</plain-text-body>Then,
your endpoint can reference the
<code>CxfHeaderFilterStrategy</code>.<plain-text-body>{snippet:id=noRelayRoute|lang=xml|url=camel/trunk/components/camel-cxf/src/test/resources/org/apache/camel/component/cxf/soap/headers/CxfMessageHeadersRelayTest-context.x
ml}</plain-text-body></p></li><li><p>The <code>MessageHeadersRelay</code>
interface has changed slightly and has been renamed to
<code>MessageHeaderFilter</code>. It is a property of
<code>CxfHeaderFilterStrategy</code>. Here is an example of configuring user
defined Message Header
Filters:<plain-text-body>{snippet:id=customMessageFilterStrategy|lang=xml|url=camel/trunk/components/camel-cxf/src/test/resources/org/apache/camel/component/cxf/soap/headers/CxfMessageHeadersRelayTest-context.xml}</plain-text-body></p></li><li><p>Other
than <code>relayHeaders</code>, there are new properties that can be
configured in <code>CxfHeaderFilterStrategy</code>.</p><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Required</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><cod
e>relayHeaders</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>All message headers will be processed by Message Header
Filters <br clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Type</em>: <code>boolean</code> <br
clear="none" class="atl-forced-newline"> <em>Default</em>:
<code>true</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>relayAllMessageHeaders</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>All message headers will be propagated
(without processing by Message Header Filters) <br clear="none"
class="atl-forced-newline"> <br clear="none" class="atl-forced-newline">
<em>Type</em>: <code>boolean</code> <br clear="none"
class="atl-forced-newline"> <em>Default</em>:
<code>false</code></p></td></tr><tr><td colspan="1" rowspan="1" class="conflue
nceTd"><p><code>allowFilterNamespaceClash</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>If two filters overlap in activation namespace, the
property control how it should be handled. If the value is <code>true</code>,
last one wins. If the value is <code>false</code>, it will throw an exception
<br clear="none" class="atl-forced-newline"> <br clear="none"
class="atl-forced-newline"> <em>Type</em>: <code>boolean</code> <br
clear="none" class="atl-forced-newline"> <em>Default</em>:
<code>false</code></p></td></tr></tbody></table></div><h3
id="CXF-ConfiguretheCXFendpointswithSpring">Configure the CXF endpoints with
Spring</h3><p>You can configure the CXF endpoint with the Spring configuration
file shown below, and you can also embed the endpoint into the
<code>camelContext</code> tags. When you are invoking the service endpoint, you
can set the <code>operationName</code> and <code>operationNamespace</co
de> headers to explicitly state which operation you are calling.</p><parameter
ac:name="">xml</parameter><plain-text-body><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.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">
- <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://camel.apache.org/schema/spring">
+ http://camel.apache.org/schema/spring
http://camel.apache.org/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://camel.apache.org/schema/spring">
<route>
- <from uri="cxf:bean:routerEndpoint" />
- <to uri="cxf:bean:serviceEndpoint" />
+ <from uri="cxf:bean:routerEndpoint" />
+ <to uri="cxf:bean:serviceEndpoint" />
</route>
</camelContext>
</beans>
-]]></script>
-</div></div><p>Be sure to include the JAX-WS <code>schemaLocation</code>
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
<code><cxf:cxfEndpoint/></code> tag--these are required because the
combined {<code>namespace}localName</code> syntax is presently not supported
for this tag's attribute values.</p><p>The <code>cxf:cxfEndpoint</code> element
supports many additional attributes:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Value</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>PortName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The endpoint name this service is
implementing, it maps to the <code>wsdl:port@name</code>. In the format of
<code>ns:PORT_NAME</code> where <code>ns</code>
is a namespace prefix valid at this scope.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>serviceName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The service name this service
is implementing, it maps to the <code>wsdl:service@name</code>. In the format
of <code>ns:SERVICE_NAME</code> where <code>ns</code> is a namespace prefix
valid at this scope.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>wsdlURL</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The location of the WSDL. Can be on the
classpath, file system, or be hosted remotely.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>bindingId</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The <code>bindingId</code> for
the service model to use.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>address</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p
>The service publish address.</p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>bus</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p>The bus name that will be used in the JAX-WS
>endpoint.</p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>serviceClass</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p>The class name of the SEI (Service
>Endpoint Interface) class which could have JSR181 annotation or
>not.</p></td></tr></tbody></table></div><p>It also supports many child
>elements:</p><div class="table-wrap"><table
>class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
>class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
>class="confluenceTh"><p>Value</p></th></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>cxf:inInterceptors</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p>The incoming interceptors for
>this endpoint. A list of <code><bean></cod
e> or <code><ref></code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:inFaultInterceptors</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The incoming fault interceptors
for this endpoint. A list of <code><bean></code> or
<code><ref></code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:outInterceptors</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The outgoing interceptors for
this endpoint. A list of <code><bean></code> or
<code><ref></code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:outFaultInterceptors</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The outgoing fault interceptors
for this endpoint. A list of <code><bean></code> or
<code><ref></code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:properties</code></p></td><td colspan="1"
rowspan
="1" class="confluenceTd"><p>A properties map which should be supplied to the
JAX-WS endpoint. See below.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:handlers</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>A JAX-WS handler list which should be
supplied to the JAX-WS endpoint. See below.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>cxf:dataBinding</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>You can specify the which
<code>DataBinding</code> will be use in the endpoint. This can be supplied
using the Spring <code><bean class="MyDataBinding"/></code>
syntax.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:binding</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>You can specify the
<code>BindingFactory</code> for this endpoint to use. This can be supplied
using the Spring <code><bean class="MyBindingFactory"/></code> syn
tax.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:features</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The features that hold the interceptors for
this endpoint. A list of {{<bean>}}s or
{{<ref>}}s</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:schemaLocations</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The schema locations for
endpoint to use. A list of {{<schemaLocation>}}s</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:serviceFactory</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The service factory for this endpoint to
use. This can be supplied using the Spring <code><bean
class="MyServiceFactory"/></code>
syntax</p></td></tr></tbody></table></div><div> </div>
-
-
-</li></ul><p>You can find more advanced examples that show how to provide
interceptors, properties and handlers on the CXF <a shape="rect"
class="external-link"
href="https://cwiki.apache.org/CXF20DOC/JAX-WS+Configuration">JAX-WS
Configuration page</a>.</p><p><strong>NOTE</strong><br clear="none"> You can
use cxf:properties to set the camel-cxf endpoint's dataFormat and setDefaultBus
properties from spring configuration file.</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<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">
+</plain-text-body><p>Be sure to include the JAX-WS <code>schemaLocation</code>
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
<code><cxf:cxfEndpoint/></code> tag--these are required because the
combined {<code>namespace}localName</code> syntax is presently not supported
for this tag's attribute values.</p><p>The <code>cxf:cxfEndpoint</code> element
supports many additional attributes:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Value</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>PortName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The endpoint name this service is
implementing, it maps to the <code>wsdl:port@name</code>. In the format of
<code>ns:PORT_NAME</code> where <code>ns</
code> is a namespace prefix valid at this scope.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>serviceName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The service name this service is
implementing, it maps to the <code>wsdl:service@name</code>. In the format of
<code>ns:SERVICE_NAME</code> where <code>ns</code> is a namespace prefix valid
at this scope.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>wsdlURL</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The location of the WSDL. Can be on the
classpath, file system, or be hosted remotely.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>bindingId</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The <code>bindingId</code> for
the service model to use.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>address</code></p></td><td colspan="1"
rowspan="1" class="confluence
Td"><p>The service publish address.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>bus</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The bus name that will be used in the
JAX-WS endpoint.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>serviceClass</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The class name of the SEI (Service Endpoint
Interface) class which could have JSR181 annotation or
not.</p></td></tr></tbody></table></div><p>It also supports many child
elements:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Value</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:inInterceptors</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The incoming interceptors for this
endpoint. A list of <code><bean>
;</code> or <code><ref></code>.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>cxf:inFaultInterceptors</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The incoming fault interceptors
for this endpoint. A list of <code><bean></code> or
<code><ref></code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:outInterceptors</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The outgoing interceptors for
this endpoint. A list of <code><bean></code> or
<code><ref></code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:outFaultInterceptors</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The outgoing fault interceptors
for this endpoint. A list of <code><bean></code> or
<code><ref></code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:properties</code></p></td><td colspan="1" r
owspan="1" class="confluenceTd"><p>A properties map which should be supplied
to the JAX-WS endpoint. See below.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:handlers</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>A JAX-WS handler list which should be
supplied to the JAX-WS endpoint. See below.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>cxf:dataBinding</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>You can specify the which
<code>DataBinding</code> will be use in the endpoint. This can be supplied
using the Spring <code><bean class="MyDataBinding"/></code>
syntax.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:binding</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>You can specify the
<code>BindingFactory</code> for this endpoint to use. This can be supplied
using the Spring <code><bean class="MyBindingFactory"/></cod
e> syntax.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:features</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The features that hold the interceptors for
this endpoint. A list of {{<bean>}}s or
{{<ref>}}s</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:schemaLocations</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The schema locations for
endpoint to use. A list of {{<schemaLocation>}}s</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>cxf:serviceFactory</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The service factory for this endpoint to
use. This can be supplied using the Spring <code><bean
class="MyServiceFactory"/></code>
syntax</p></td></tr></tbody></table></div><rich-text-body> </rich-text-body></li></ul><p>You
can find more advanced examples that show how to provide interceptors,
properties and h
andlers on the CXF <a shape="rect" class="external-link"
href="https://cwiki.apache.org/CXF20DOC/JAX-WS+Configuration">JAX-WS
Configuration page</a>.</p><p><strong>NOTE</strong><br clear="none"> You can
use cxf:properties to set the camel-cxf endpoint's dataFormat and setDefaultBus
properties from spring configuration file.</p><parameter
ac:name="">xml</parameter><plain-text-body><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"/>
+ <entry key="dataFormat" value="MESSAGE"/>
+ <entry key="setDefaultBus" value="true"/>
</cxf:properties>
</cxf:cxfEndpoint>
-]]></script>
-</div></div><h3
id="CXF-ConfiguringtheCXFEndpointswithApacheAriesBlueprint.">Configuring the
CXF Endpoints with Apache Aries Blueprint.</h3><p>Since camel 2.8 there is
support for utilizing aries blueprint dependency injection for your CXF
endpoints.<br clear="none"> The schema utilized is very similar to the spring
schema so the transition is fairly transparent.</p><p>Example</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<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
https://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">
+</plain-text-body><h3
id="CXF-ConfiguringtheCXFEndpointswithApacheAriesBlueprint.">Configuring the
CXF Endpoints with Apache Aries Blueprint.</h3><p>Since camel 2.8 there is
support for utilizing aries blueprint dependency injection for your CXF
endpoints.<br clear="none"> The schema utilized is very similar to the spring
schema so the transition is fairly transparent.</p><p>Example</p><parameter
ac:name="">xml</parameter><plain-text-body><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
https://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"/>
+ <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 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">
+ <camelContext xmlns="http://camel.apache.org/schema/blueprint">
<route>
- <from uri="routerEndpoint"/>
- <to uri="log:request"/>
+ <from uri="routerEndpoint"/>
+ <to uri="log:request"/>
</route>
</camelContext>
</blueprint>
-]]></script>
-</div></div><p>Currently the endpoint element is the first supported CXF
namespacehandler.</p><p>You can also use the bean references just as in
spring</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<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="
+</plain-text-body><p>Currently the endpoint element is the first supported CXF
namespacehandler.</p><p>You can also use the bean references just as in
spring</p><parameter ac:name="">xml</parameter><plain-text-body><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
https://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 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"
/>
+ <bean id="reportIncidentRoutes"
class="org.apache.camel.example.reportincident.ReportIncidentRoutes" />
- <camelContext
xmlns="http://camel.apache.org/schema/blueprint">
- <routeBuilder ref="reportIncidentRoutes"/>
+ <camelContext xmlns="http://camel.apache.org/schema/blueprint">
+ <routeBuilder ref="reportIncidentRoutes"/>
</camelContext>
</blueprint>
-]]></script>
-</div></div><h3
id="CXF-Howtomakethecamel-cxfcomponentuselog4jinsteadofjava.util.logging">How
to make the camel-cxf component use log4j instead of
java.util.logging</h3><p>CXF's default logger is
<code>java.util.logging</code>. If you want to change it to log4j, proceed as
follows. Create a file, in the classpath, named
<code>META-INF/cxf/org.apache.cxf.logger</code>. This file should contain the
fully-qualified name of the class,
<code>org.apache.cxf.common.logging.Log4jLogger</code>, with no comments, on a
single line.</p><h3
id="CXF-Howtoletcamel-cxfresponsemessagewithxmlstartdocument">How to let
camel-cxf response message with xml start document</h3><p>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"?>"</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[Error:sendSms: SoapFault exception: [Client]
looks like we got no XML document in [...]
-]]></script>
-</div></div><p>To resolved this issue, you just need to tell
StaxOutInterceptor to write the XML start document for you.</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
[... 418 lines stripped ...]