You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2012/09/08 00:36:15 UTC
svn commit: r831334 [2/14] - in /websites/production/camel/content: ./ cache/
Modified: websites/production/camel/content/book-component-appendix.html
==============================================================================
--- websites/production/camel/content/book-component-appendix.html (original)
+++ websites/production/camel/content/book-component-appendix.html Fri Sep 7 22:36:12 2012
@@ -529,7 +529,7 @@ atom:<span class="code-comment">//atomUr
<h3><a shape="rect" name="BookComponentAppendix-MessageHeaders"></a>Message Headers</h3>
<p>Camel atom uses these headers.</p>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Header </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>org.apache.camel.component.atom.feed</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Camel 1.x: When consuming the <tt>org.apache.abdera.model.Feed</tt> object is set to this header. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelAtomFeed</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Camel 2.0: When consuming the <tt>org.apache.abdera.model.Feed</tt> object is set to this header. </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Header </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelAtomFeed</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> When consuming the <tt>org.apache.abdera.model.Feed</tt> object is set to this header. </td></tr></tbody></table>
</div>
</div>
@@ -656,7 +656,7 @@ bean:beanID[?options]
<h3><a shape="rect" name="BookComponentAppendix-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Type </th><th colspan="1" rowspan="1" class="confluenceTh"> Default </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>method</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The method name from the bean that will be invoked. If not provided, Camel will try to determine the method itself. In case of ambiguity an exception will be thrown. See <a shape="rect" href="bean-binding.html" title="Bean Binding">Bean Binding</a> for more details. From <b>Camel 2.8</b> onwards you can specify type qualifiers to pin-point the exact method to use for overloaded methods. From <b>Camel 2.9</b> onwards you can
specify parameter values directly in the method syntax. See more details at <a shape="rect" href="bean-binding.html" title="Bean Binding">Bean Binding</a>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>cache</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If enabled, Camel will cache the result of the first <a shape="rect" href="registry.html" title="Registry">Registry</a> look-up. Cache can be enabled if the bean in the <a shape="rect" href="registry.html" title="Registry">Registry</a> is defined as a singleton scope. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>multiParameterArray</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd
"> <b>Camel 1.5:</b> How to treat the parameters which are passed from the message body; if it is <tt>true</tt>, the In message body should be an array of parameters. </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Type </th><th colspan="1" rowspan="1" class="confluenceTh"> Default </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>method</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The method name from the bean that will be invoked. If not provided, Camel will try to determine the method itself. In case of ambiguity an exception will be thrown. See <a shape="rect" href="bean-binding.html" title="Bean Binding">Bean Binding</a> for more details. From <b>Camel 2.8</b> onwards you can specify type qualifiers to pin-point the exact method to use for overloaded methods. From <b>Camel 2.9</b> onwards you can
specify parameter values directly in the method syntax. See more details at <a shape="rect" href="bean-binding.html" title="Bean Binding">Bean Binding</a>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>cache</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If enabled, Camel will cache the result of the first <a shape="rect" href="registry.html" title="Registry">Registry</a> look-up. Cache can be enabled if the bean in the <a shape="rect" href="registry.html" title="Registry">Registry</a> is defined as a singleton scope. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>multiParameterArray</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd
"> How to treat the parameters which are passed from the message body; if it is <tt>true</tt>, the In message body should be an array of parameters. </td></tr></tbody></table>
</div>
</div>
@@ -965,8 +965,6 @@ from(<span class="code-quote">"direct:st
<h2><a shape="rect" name="BookComponentAppendix-BrowseComponent"></a>Browse Component</h2>
-<p><b>Available as of Camel 2.0</b></p>
-
<p>The Browse component provides a simple <a shape="rect" href="browsableendpoint.html" title="BrowsableEndpoint">BrowsableEndpoint</a> which can be useful for testing, visualisation tools or debugging. The exchanges sent to the endpoint are all available to be browsed.</p>
@@ -1875,7 +1873,7 @@ template.send(<span class="code-quote">"
<p>The <b>cxf:</b> 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>
<div>
-<ul><li><a shape="rect" href="#CXF-CXFComponent">CXF Component</a></li><ul><li><a shape="rect" href="#CXF-URIformat">URI format</a></li><li><a shape="rect" href="#CXF-Options">Options</a></li><ul><li><a shape="rect" href="#CXF-Thedescriptionsofthedataformats">The descriptions of the dataformats</a></li><ul><li><a shape="rect" href="#CXF-HowtoenableCXF%27sLoggingOutInterceptorinMESSAGEmode">How to enable CXF's LoggingOutInterceptor in MESSAGE mode</a></li></ul><li><a shape="rect" href="#CXF-DescriptionofrelayHeadersoption">Description of relayHeaders option</a></li><ul><li><a shape="rect" href="#CXF-AvailableinRelease1.6.1andafter%28onlyinPOJOmode%29">Available in Release 1.6.1 and after (only in POJO mode)</a></li><li><a shape="rect" href="#CXF-ChangessinceRelease2.0">Changes since Release 2.0</a></li></ul></ul><li><a shape="rect" href="#CXF-ConfiguretheCXFendpointswithSpring">Configure the CXF endpoints with Spring</a></li><li><a shape="rect" href="#CXF-ConfiguringtheCXFEnd
pointswithApacheAriesBlueprint.">Configuring the CXF Endpoints with Apache Aries Blueprint.</a></li><li><a shape="rect" href="#CXF-Howtomakethecamelcxfcomponentuselog4jinsteadofjava.util.logging">How to make the camel-cxf component use log4j instead of java.util.logging</a></li><li><a shape="rect" href="#CXF-Howtoletcamelcxfresponsemessagewithxmlstartdocument">How to let camel-cxf response message with xml start document</a></li><li><a shape="rect" href="#CXF-HowtoconsumeamessagefromacamelcxfendpointinPOJOdataformat">How to consume a message from a camel-cxf endpoint in POJO data format</a></li><li><a shape="rect" href="#CXF-HowtopreparethemessageforthecamelcxfendpointinPOJOdataformat">How to prepare the message for the camel-cxf endpoint in POJO data format</a></li><li><a shape="rect" href="#CXF-HowtodealwiththemessageforacamelcxfendpointinPAYLOADdataformat">How to deal with the message for a camel-cxf endpoint in PAYLOAD data format</a></li><li><a shape="rect" href="#CXF-H
owtogetandsetSOAPheadersinPOJOmode">How to get and set SOAP headers in POJO mode</a></li><li><a shape="rect" href="#CXF-HowtogetandsetSOAPheadersinPAYLOADmode">How to get and set SOAP headers in PAYLOAD mode</a></li><li><a shape="rect" href="#CXF-SOAPheadersarenotavailableinMESSAGEmode">SOAP headers are not available in MESSAGE mode</a></li><li><a shape="rect" href="#CXF-HowtothrowaSOAPFaultfromCamel">How to throw a SOAP Fault from Camel</a></li><li><a shape="rect" href="#CXF-Howtopropagateacamelcxfendpoint%27srequestandresponsecontext">How to propagate a camel-cxf endpoint's request and response context</a></li><li><a shape="rect" href="#CXF-AttachmentSupport">Attachment Support</a></li><li><a shape="rect" href="#CXF-StreamingSupportinPAYLOADmode">Streaming Support in PAYLOAD mode</a></li><li><a shape="rect" href="#CXF-SeeAlso">See Also</a></li></ul></ul></div>
+<ul><li><a shape="rect" href="#CXF-CXFComponent">CXF Component</a></li><ul><li><a shape="rect" href="#CXF-URIformat">URI format</a></li><li><a shape="rect" href="#CXF-Options">Options</a></li><ul><li><a shape="rect" href="#CXF-Thedescriptionsofthedataformats">The descriptions of the dataformats</a></li><ul><li><a shape="rect" href="#CXF-HowtoenableCXF%27sLoggingOutInterceptorinMESSAGEmode">How to enable CXF's LoggingOutInterceptor in MESSAGE mode</a></li></ul><li><a shape="rect" href="#CXF-DescriptionofrelayHeadersoption">Description of relayHeaders option</a></li><ul><li><a shape="rect" href="#CXF-AvailableonlyinPOJOmode">Available only in POJO mode</a></li><li><a shape="rect" href="#CXF-ChangessinceRelease2.0">Changes since Release 2.0</a></li></ul></ul><li><a shape="rect" href="#CXF-ConfiguretheCXFendpointswithSpring">Configure the CXF endpoints with Spring</a></li><li><a shape="rect" href="#CXF-ConfiguringtheCXFEndpointswithApacheAriesBlueprint.">Configuring the CXF Endp
oints with Apache Aries Blueprint.</a></li><li><a shape="rect" href="#CXF-Howtomakethecamelcxfcomponentuselog4jinsteadofjava.util.logging">How to make the camel-cxf component use log4j instead of java.util.logging</a></li><li><a shape="rect" href="#CXF-Howtoletcamelcxfresponsemessagewithxmlstartdocument">How to let camel-cxf response message with xml start document</a></li><li><a shape="rect" href="#CXF-HowtoconsumeamessagefromacamelcxfendpointinPOJOdataformat">How to consume a message from a camel-cxf endpoint in POJO data format</a></li><li><a shape="rect" href="#CXF-HowtopreparethemessageforthecamelcxfendpointinPOJOdataformat">How to prepare the message for the camel-cxf endpoint in POJO data format</a></li><li><a shape="rect" href="#CXF-HowtodealwiththemessageforacamelcxfendpointinPAYLOADdataformat">How to deal with the message for a camel-cxf endpoint in PAYLOAD data format</a></li><li><a shape="rect" href="#CXF-HowtogetandsetSOAPheadersinPOJOmode">How to get and set SO
AP headers in POJO mode</a></li><li><a shape="rect" href="#CXF-HowtogetandsetSOAPheadersinPAYLOADmode">How to get and set SOAP headers in PAYLOAD mode</a></li><li><a shape="rect" href="#CXF-SOAPheadersarenotavailableinMESSAGEmode">SOAP headers are not available in MESSAGE mode</a></li><li><a shape="rect" href="#CXF-HowtothrowaSOAPFaultfromCamel">How to throw a SOAP Fault from Camel</a></li><li><a shape="rect" href="#CXF-Howtopropagateacamelcxfendpoint%27srequestandresponsecontext">How to propagate a camel-cxf endpoint's request and response context</a></li><li><a shape="rect" href="#CXF-AttachmentSupport">Attachment Support</a></li><li><a shape="rect" href="#CXF-StreamingSupportinPAYLOADmode">Streaming Support in PAYLOAD mode</a></li><li><a shape="rect" href="#CXF-SeeAlso">See Also</a></li></ul></ul></div>
<p>Maven users will need to add the following dependency to their <tt>pom.xml</tt> for this component:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
@@ -1915,7 +1913,7 @@ cxf:bean:cxfEndpoint?wsdlURL=wsdl/hello_
<h3><a shape="rect" name="BookComponentAppendix-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Required </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>wsdlURL</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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 <tt>wsdl/hello.wsdl</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>serviceClass</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Yes </td><td colspan="1" rowspan="1" class="confluenceTd"> The name of the SEI (Service Endpo
int Interface) class. This class can have, but does not require, JSR181 annotations. <br clear="none" class="atl-forced-newline"> <b>Since 2.0,</b> 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 <b>MUST</b> be provided. It is possible to use <tt>#</tt> notation to reference a <tt>serviceClass</tt> object instance from the registry. E.g. <tt>serviceClass=#beanName</tt>.<br clear="none" class="atl-forced-newline"> <b>Since 2.8,</b> 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 <b>
referenced object cannot be a Proxy</b> (Spring AOP Proxy is OK) as it relies on <tt>Object.getClass().getName()</tt> method for non Spring AOP Proxy. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>org.apache.camel.Hello</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>serviceClassInstance</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> Use either <tt>serviceClass</tt> or <tt>serviceClassInstance</tt>. <br clear="none" class="atl-forced-newline"> <b>Deprecated in 2.x</b>. In 1.6.x <tt>serviceClassInstance</tt> works like <tt>serviceClass=#beanName</tt>, which looks up a <tt>serviceObject</tt> instance from the registry. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>serviceClassInstance=beanName</tt> </td></tr><tr><td colspan="1" rowspan="1" class="conflu
enceTd"> <tt>serviceName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> The service name this service is implementing, it maps to the <tt>wsdl:service@name</tt>. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <b>Required</b> for camel-cxf consumer since camel-2.2.0 or if more than one <tt>serviceName</tt> 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 </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>portName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> The port name this service is implementing, it maps to the <tt>wsdl:port@name</tt>. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <b>Required</b> for camel-cx
f consumer since camel-2.2.0 or if more than one <tt>portName</tt> is present under <tt>serviceName</tt>. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: {http:­//org.apache.camel}PortName </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>dataFormat</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>POJO</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>POJO</tt>, <tt>PAYLOAD</tt>, <tt>MESSAGE</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>relayHeaders</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> Available since 1.6.1. Please see the <b>Descripti
on of</b> <tt><b>relayHeaders</b></tt> <b>option</b> section for this option in 2.0. Should a CXF endpoint relay headers along the route. Currently only available when <tt>dataFormat=POJO</tt> <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>true</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>true</tt>, <tt>false</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>wrapped</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>false</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>true</tt>, <tt>false</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>wrappedStyle</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>New in 2.5.0</b> 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>: <tt>Null</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>true</tt>, <tt>false</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>setDefaultBus</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> Will set the default bus when CXF endpoint create a bus by itself <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>false</tt> <br clear="none" class="atl-forced-newline">
<em>Example</em>: <tt>true</tt>, <tt>false</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>bus</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> New in 2.0.0. A default bus created by CXF Bus Factory. Use <tt>#</tt> notation to reference a bus object from the registry. The referenced object must be an instance of <tt>org.apache.cxf.Bus</tt>. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>bus=#busName</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>cxfBinding</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> New in 2.0. Use <tt>#</tt> notation to reference a CXF binding object from the registry. The referenced object must be an instance of <tt>org.apache.camel.component.cxf.CxfBinding</tt> (use an instance of <tt>org.apache.camel
.component.cxf.DefaultCxfBinding</tt>). <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>cxfBinding=#bindingName</tt> <br clear="none" class="atl-forced-newline"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>headerFilterStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> New in 2.0. Use <tt>#</tt> notation to reference a header filter strategy object from the registry. The referenced object must be an instance of <tt>org.apache.camel.spi.HeaderFilterStrategy</tt> (use an instance of <tt>org.apache.camel.component.cxf.CxfHeaderFilterStrategy</tt>). <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>headerFilterStrategy=#strategyName</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>loggingFeatureEnabled</tt> </td><td colspan="1" rowspa
n="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>false</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>loggingFeatureEnabled</tt><tt>=true</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>defaultOperationName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>null</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>defaultOperationName</tt><tt>=greetMe<
/tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>defaultOperationNamespace</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>null</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>defaultOperationNamespace</tt><tt>=</tt><tt><a shape="rect" class="external-link" href="http://apache.org/hello_world_soap_http">http://apache.org/hello_world_soap_http</a></tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>synchronous</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> New in 2.5. This option will let cxf endpoint decide to use sync or asyn
c 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>: <tt>false</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: synchronous=true </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>publishedEndpointUrl</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>null</tt> <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.co
m/service</a> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>properties.XXX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Allows to set custom properties to CXF in the endpoint uri. For example setting <tt>properties.mtom-enabled=true</tt> to enable MTOM. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>allowStreaming</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> New in 2.8.2. 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>skipFaultLogging</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td co
lspan="1" rowspan="1" class="confluenceTd"> New in 2.11. This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Required </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>wsdlURL</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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 <tt>wsdl/hello.wsdl</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>serviceClass</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Yes </td><td colspan="1" rowspan="1" class="confluenceTd"> The name of the SEI (Service Endpo
int 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 <b>MUST</b> be provided. It is possible to use <tt>#</tt> notation to reference a <tt>serviceClass</tt> object instance from the registry. E.g. <tt>serviceClass=#beanName</tt>.<br clear="none" class="atl-forced-newline"> <b>Since 2.8,</b> 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 <b>referenced object
cannot be a Proxy</b> (Spring AOP Proxy is OK) as it relies on <tt>Object.getClass().getName()</tt> method for non Spring AOP Proxy. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>org.apache.camel.Hello</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>serviceName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> The service name this service is implementing, it maps to the <tt>wsdl:service@name</tt>. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <b>Required</b> for camel-cxf consumer since camel-2.2.0 or if more than one <tt>serviceName</tt> 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 </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>p
ortName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> The port name this service is implementing, it maps to the <tt>wsdl:port@name</tt>. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <b>Required</b> for camel-cxf consumer since camel-2.2.0 or if more than one <tt>portName</tt> is present under <tt>serviceName</tt>. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: {http:­//org.apache.camel}PortName </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>dataFormat</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>POJO</tt> <br clear="none" class="atl-forced
-newline"> <em>Example</em>: <tt>POJO</tt>, <tt>PAYLOAD</tt>, <tt>MESSAGE</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>relayHeaders</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> Please see the <b>Description of</b> <tt><b>relayHeaders</b></tt> <b>option</b> section for this option. Should a CXF endpoint relay headers along the route. Currently only available when <tt>dataFormat=POJO</tt> <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>true</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>true</tt>, <tt>false</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>wrapped</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>false</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>true</tt>, <tt>false</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>wrappedStyle</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>New in 2.5.0</b> 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>: <tt>Null</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>true</tt>, <tt>false</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>setDefaultBus</tt> </td><td colspan="1" rowspan="1" class="confluenc
eTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> Will set the default bus when CXF endpoint create a bus by itself <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>false</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>true</tt>, <tt>false</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>bus</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> A default bus created by CXF Bus Factory. Use <tt>#</tt> notation to reference a bus object from the registry. The referenced object must be an instance of <tt>org.apache.cxf.Bus</tt>. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>bus=#busName</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>cxfBinding</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
No </td><td colspan="1" rowspan="1" class="confluenceTd"> Use <tt>#</tt> notation to reference a CXF binding object from the registry. The referenced object must be an instance of <tt>org.apache.camel.component.cxf.CxfBinding</tt> (use an instance of <tt>org.apache.camel.component.cxf.DefaultCxfBinding</tt>). <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>cxfBinding=#bindingName</tt> <br clear="none" class="atl-forced-newline"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>headerFilterStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> Use <tt>#</tt> notation to reference a header filter strategy object from the registry. The referenced object must be an instance of <tt>org.apache.camel.spi.HeaderFilterStrategy</tt> (use an instance of <tt>org.apache.camel.component.cxf.CxfHeaderFilterStrategy</tt>). <br clear="non
e" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>headerFilterStrategy=#strategyName</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>loggingFeatureEnabled</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>false</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>loggingFeatureEnabled</tt><tt>=true</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>defaultOperationName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> New in 2.4, this option will set the default operationName that will be used by the CxfProducer w
hich invokes the remote service. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>null</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>defaultOperationName</tt><tt>=greetMe</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>defaultOperationNamespace</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>null</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: <tt>defaultOperationNamespace</tt><tt>=</tt><tt><a shape="rect" class="external-link" href="http://apache.org/hello_world_soap_http">http://apache.org/hello_world_soap_http</a></tt> </td></tr>
<tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>synchronous</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>false</tt> <br clear="none" class="atl-forced-newline"> <em>Example</em>: synchronous=true </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>publishedEndpointUrl</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>null</tt> <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> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>properties.XXX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Allows to set custom properties to CXF in the endpoint uri. For example setting <tt>properties.mtom-enabled=true</tt> to enable MTOM. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>allowStreaming</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> New in 2.8.2. 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>skipFaultLogging</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> New in 2.11. This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. </td></tr></tbody></table>
</div>
@@ -1966,7 +1964,7 @@ cxf:bean:cxfEndpoint?wsdlURL=wsdl/hello_
<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 <tt>relayHeaders</tt> should be set to <tt>true</tt>, which is the default value.</p>
-<h5><a shape="rect" name="BookComponentAppendix-AvailableinRelease1.6.1andafter%28onlyinPOJOmode%29"></a>Available in Release 1.6.1 and after (only in POJO mode)</h5>
+<h5><a shape="rect" name="BookComponentAppendix-AvailableonlyinPOJOmode"></a>Available only in POJO mode</h5>
<p>The <tt>relayHeaders=true</tt> 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 <tt>MessageHeadersRelay</tt> interface. A concrete implementation of <tt>MessageHeadersRelay</tt> will be consulted to decide if a header needs to be relayed or not. There is already an implementation of <tt>SoapMessageHeadersRelay</tt> 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 <tt>relayHeaders=true</tt>. If there is a header on the wire, whose name space is unknown to the runtime, then a fall back <tt>DefaultMessageHeadersRelay</tt> will be used, which simply allows all headers to be relayed.</p>
@@ -1993,7 +1991,7 @@ cxf:bean:cxfEndpoint?wsdlURL=wsdl/hello_
<h5><a shape="rect" name="BookComponentAppendix-ChangessinceRelease2.0"></a>Changes since Release 2.0</h5>
-<ul><li><tt>POJO</tt> and <tt>PAYLOAD</tt> modes are supported. In <tt>POJO</tt> 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 <tt>MessageContentList</tt> in POJO mode. The <tt>camel-cxf</tt> component does make any attempt to remove the in-band headers from the <tt>MessageContentList</tt> as it does in 1.6.1. If filtering of in-band headers is required, please use <tt>PAYLOAD</tt> mode or plug in a (pretty straightforward) CXF interceptor/JAXWS Handler to the CXF endpoint.</li><li>The Message Header Relay mechanism has been merged into <tt>CxfHeaderFilterStrategy</tt>. The <tt>relayHeaders</tt> option, its semantics, and default value remain the same, but it is a property of <tt>CxfHeaderFilterStrategy</tt>.<br clear="none">
+<ul><li><tt>POJO</tt> and <tt>PAYLOAD</tt> modes are supported. In <tt>POJO</tt> 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 <tt>MessageContentList</tt> in POJO mode. The <tt>camel-cxf</tt> component does make any attempt to remove the in-band headers from the <tt>MessageContentList</tt>. If filtering of in-band headers is required, please use <tt>PAYLOAD</tt> mode or plug in a (pretty straightforward) CXF interceptor/JAXWS Handler to the CXF endpoint.</li><li>The Message Header Relay mechanism has been merged into <tt>CxfHeaderFilterStrategy</tt>. The <tt>relayHeaders</tt> option, its semantics, and default value remain the same, but it is a property of <tt>CxfHeaderFilterStrategy</tt>.<br clear="none">
Here is an example of configuring it.
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml"><span class="code-tag"><bean id=<span class="code-quote">"dropAllMessageHeadersStrategy"</span> class=<span class="code-quote">"org.apache.camel.component.cxf.common.header.CxfHeaderFilterStrategy"</span>></span>
@@ -2027,7 +2025,7 @@ Here is an example of configuring it.
</pre>
</div></div></li><li>Other than <tt>relayHeaders</tt>, there are new properties that can be configured in <tt>CxfHeaderFilterStrategy</tt>.
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Required </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>relayHeaders</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>boolean</tt> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>true</tt> (1.6.1 behavior) </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>relayAllMessageHeaders</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> All message headers will be propagated (without processing by Message Hea
der Filters) <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Type</em>: <tt>boolean</tt> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>false</tt> (1.6.1 behavior) </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>allowFilterNamespaceClash</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> If two filters overlap in activation namespace, the property control how it should be handled. If the value is <tt>true</tt>, last one wins. If the value is <tt>false</tt>, it will throw an exception <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Type</em>: <tt>boolean</tt> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>false</tt> (1.6.1 behavior) </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Required </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>relayHeaders</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>boolean</tt> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>true</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>relayAllMessageHeaders</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> 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>: <tt>boolean</tt> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>false</tt> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>allowFilterNamespaceClash</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> No </td><td colspan="1" rowspan="1" class="confluenceTd"> If two filters overlap in activation namespace, the property control how it should be handled. If the value is <tt>true</tt>, last one wins. If the value is <tt>false</tt>, it will throw an exception <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> <em>Type</em>: <tt>boolean</tt> <br clear="none" class="atl-forced-newline"> <em>Default</em>: <tt>false</tt> </td></tr></tbody></table>
</div>
@@ -2038,11 +2036,11 @@ Here is an example of configuring it.
<pre class="code-xml">
<beans xmlns=<span class="code-quote">"http://www.springframework.org/schema/beans"</span>
<span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>
- <span class="code-keyword">xmlns:cxf</span>=<span class="code-quote">"http://activemq.apache.org/camel/schema/cxfEndpoint"</span>
+ <span class="code-keyword">xmlns:cxf</span>=<span class="code-quote">"http://camel.apache.org/schema/cxf"</span>
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 ">
+ 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=<span class="code-quote">"routerEndpoint"</span> address=<span class="code-quote">"http://localhost:9003/CamelContext/RouterPort"</span>
serviceClass=<span class="code-quote">"org.apache.hello_world_soap_http.GreeterImpl"</span>/>
<cxf:cxfEndpoint id=<span class="code-quote">"serviceEndpoint"</span> address=<span class="code-quote">"http://localhost:9000/SoapContext/SoapPort"</span>
@@ -2060,19 +2058,7 @@ Here is an example of configuring it.
<span class="code-tag"></beans></span>
</pre>
</div></div>
-<p><b>NOTE</b> In Camel 2.x we change to use {{http:­//camel.apache.org/schema/cxf}} as the CXF endpoint's target namespace.</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<beans xmlns=<span class="code-quote">"http://www.springframework.org/schema/beans"</span>
- <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>
- <span class="code-keyword">xmlns:cxf</span>=<span class="code-quote">"http://camel.apache.org/schema/cxf"</span>
- 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 ">
- ...
-</pre>
-</div></div>
+
<p>Be sure to include the JAX-WS <tt>schemaLocation</tt> 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 <tt><cxf:cxfEndpoint/></tt> tag--these are required because the combined {<tt>namespace}localName</tt> syntax is presently not supported for this tag's attribute values.</p>
<p>The <tt>cxf:cxfEndpoint</tt> element supports many additional attributes:</p>
@@ -2296,7 +2282,7 @@ Error:sendSms: SoapFault exception: [Cli
<p>The <tt>camel-cxf</tt> endpoint producer is based on the <a shape="rect" class="external-link" href="https://svn.apache.org/repos/asf/cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/Client.java">cxf client API</a>. 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.</p>
-<p><b>NOTE</b> After Camel 1.5 , we change the message body from object array to message content list. If you still want to get the object array from the message body, you can get the body using <tt>message.getbody(Object[].class)</tt>, as follows:</p>
+<p>If you want to get the object array from the message body, you can get the body using <tt>message.getbody(Object[].class)</tt>, as follows:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">Exchange senderExchange = <span class="code-keyword">new</span> DefaultExchange(context, ExchangePattern.InOut);
<span class="code-keyword">final</span> List<<span class="code-object">String</span>> params = <span class="code-keyword">new</span> ArrayList<<span class="code-object">String</span>>();
@@ -2323,40 +2309,7 @@ assertEquals(<span class="code-quote">"R
<h3><a shape="rect" name="BookComponentAppendix-HowtodealwiththemessageforacamelcxfendpointinPAYLOADdataformat"></a>How to deal with the message for a camel-cxf endpoint in PAYLOAD data format</h3>
<p><tt>PAYLOAD</tt> means that you process the payload message from the SOAP envelope. You can use the <tt>Header.HEADER_LIST</tt> as the key to set or get the SOAP headers and use the <tt>List<Element></tt> to set or get SOAP body elements.<br clear="none">
-Camel 1.x branch, you can get the <tt>List<Element></tt> 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.</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java"><span class="code-keyword">protected</span> RouteBuilder createRouteBuilder() {
- <span class="code-keyword">return</span> <span class="code-keyword">new</span> RouteBuilder() {
- <span class="code-keyword">public</span> void configure() {
- from(SIMPLE_ENDPOINT_URI + <span class="code-quote">"&dataFormat=PAYLOAD"</span>).to(<span class="code-quote">"log:info"</span>).process(<span class="code-keyword">new</span> Processor() {
- <span class="code-keyword">public</span> void process(<span class="code-keyword">final</span> Exchange exchange) <span class="code-keyword">throws</span> Exception {
- Message inMessage = exchange.getIn();
- <span class="code-keyword">if</span> (inMessage <span class="code-keyword">instanceof</span> CxfMessage) {
- CxfMessage cxfInMessage = (CxfMessage) inMessage;
- CxfMessage cxfOutMessage = (CxfMessage) exchange.getOut();
- List<Element> inElements = cxfInMessage.getMessage().get(List.class);
- List<Element> outElements = <span class="code-keyword">new</span> ArrayList<Element>();
- XmlConverter converter = <span class="code-keyword">new</span> XmlConverter();
- <span class="code-object">String</span> documentString = ECHO_RESPONSE;
- <span class="code-keyword">if</span> (inElements.get(0).getLocalName().equals(<span class="code-quote">"echoBoolean"</span>)) {
- 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);
- }
- }
- });
- }
- };
-}
-</pre>
-</div></div>
-<p><b>Change in 2.0</b>, There is no more <tt>CxfMessage</tt>, we just use the common Camel <tt>DefaultMessageImpl</tt> under layer. <tt>Message.getBody()</tt> will return an <tt>org.apache.camel.component.cxf.CxfPayload</tt> object, which has getters for SOAP message headers and Body elements. This change enables decoupling the native CXF message from the Camel message.</p>
+<tt>Message.getBody()</tt> will return an <tt>org.apache.camel.component.cxf.CxfPayload</tt> object, which has getters for SOAP message headers and Body elements. This change enables decoupling the native CXF message from the Camel message.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java"><span class="code-keyword">protected</span> RouteBuilder createRouteBuilder() {
<span class="code-keyword">return</span> <span class="code-keyword">new</span> RouteBuilder() {
@@ -2413,7 +2366,7 @@ Camel 1.x branch, you can get the <tt>Li
</pre>
</div></div>
-<p><b>In 2.x</b> SOAP headers are propagated to and from Camel Message headers. The Camel 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 insert 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.</p>
+<p>SOAP headers are propagated to and from Camel Message headers. The Camel 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 insert 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.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
@@ -2441,60 +2394,11 @@ Camel 1.x branch, you can get the <tt>Li
</pre>
</div></div>
-<p><b>In 1.x</b> SOAP headers are not propagated to and from Camel Message headers. Users have to go deeper into CXF APIs to access SOAP headers. Also, accessing the SOAP headers in a request message is slight different than in a response message. The InsertRequestOutHeaderProcessor and InsertResponseOutHeaderProcessor are as follow.</p>
-
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> <span class="code-keyword">static</span> class InsertRequestOutHeaderProcessor <span class="code-keyword">implements</span> Processor {
- <span class="code-keyword">public</span> void process(Exchange exchange) <span class="code-keyword">throws</span> Exception {
- CxfMessage message = exchange.getIn().getBody(CxfMessage.class);
- Message cxf = message.getMessage();
- List<SoapHeader> soapHeaders = (List)cxf.get(Header.HEADER_LIST);
-
- <span class="code-comment">// Insert a <span class="code-keyword">new</span> header
-</span> <span class="code-object">String</span> xml = <span class="code-quote">"<?xml version=\"</span>1.0\<span class="code-quote">" encoding=\"</span>utf-8\<span class="code-quote">"?><outofbandHeader "</span>
- + <span class="code-quote">"xmlns=\"</span>http:<span class="code-comment">//cxf.apache.org/outofband/Header\<span class="code-quote">" hdrAttribute=\"</span>testHdrAttribute\<span class="code-quote">" "</span>
-</span> + <span class="code-quote">"xmlns:soap=\"</span>http:<span class="code-comment">//schemas.xmlsoap.org/soap/envelope/\<span class="code-quote">" soap:mustUnderstand=\"</span>1\<span class="code-quote">">"</span>
-</span> + <span class="code-quote">"<name>New_testOobHeader</name><value>New_testOobHeaderValue</value></outofbandHeader>"</span>;
-
- SoapHeader newHeader = <span class="code-keyword">new</span> SoapHeader(soapHeaders.get(0).getName(),
- DOMUtils.readXml(<span class="code-keyword">new</span> StringReader(xml)).getDocumentElement());
- <span class="code-comment">// make sure direction is IN since it is a request message.
-</span> newHeader.setDirection(Direction.DIRECTION_IN);
- <span class="code-comment">//newHeader.setMustUnderstand(<span class="code-keyword">false</span>);
-</span> soapHeaders.add(newHeader);
-
- }
-}
-
-<span class="code-keyword">public</span> <span class="code-keyword">static</span> class InsertResponseOutHeaderProcessor <span class="code-keyword">implements</span> Processor {
- <span class="code-keyword">public</span> void process(Exchange exchange) <span class="code-keyword">throws</span> 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);
-
- <span class="code-comment">// Insert a <span class="code-keyword">new</span> header
-</span> <span class="code-object">String</span> xml = <span class="code-quote">"<?xml version=\"</span>1.0\<span class="code-quote">" encoding=\"</span>utf-8\<span class="code-quote">"?><outofbandHeader "</span>
- + <span class="code-quote">"xmlns=\"</span>http:<span class="code-comment">//cxf.apache.org/outofband/Header\<span class="code-quote">" hdrAttribute=\"</span>testHdrAttribute\<span class="code-quote">" "</span>
-</span> + <span class="code-quote">"xmlns:soap=\"</span>http:<span class="code-comment">//schemas.xmlsoap.org/soap/envelope/\<span class="code-quote">" soap:mustUnderstand=\"</span>1\<span class="code-quote">">"</span>
-</span> + <span class="code-quote">"<name>New_testOobHeader</name><value>New_testOobHeaderValue</value></outofbandHeader>"</span>;
- SoapHeader newHeader = <span class="code-keyword">new</span> SoapHeader(soapHeaders.get(0).getName(),
- DOMUtils.readXml(<span class="code-keyword">new</span> StringReader(xml)).getDocumentElement());
- <span class="code-comment">// make sure direction is OUT since it is a response message.
-</span> newHeader.setDirection(Direction.DIRECTION_OUT);
- <span class="code-comment">//newHeader.setMustUnderstand(<span class="code-keyword">false</span>);
-</span> soapHeaders.add(newHeader);
-
- }
-}
-</pre>
-</div></div>
-
<h3><a shape="rect" name="BookComponentAppendix-HowtogetandsetSOAPheadersinPAYLOADmode"></a>How to get and set SOAP headers in PAYLOAD mode</h3>
<p>We've 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").</p>
-<p><b>In 2.x</b> Once you obtain a CxfPayload object, you can invoke the CxfPayload.getHeaders() method that returns a List of DOM Elements (SOAP headers).</p>
+<p>Once you obtain a CxfPayload object, you can invoke the CxfPayload.getHeaders() method that returns a List of DOM Elements (SOAP headers).</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">from(getRouterEndpointURI()).process(<span class="code-keyword">new</span> Processor() {
@@ -2523,31 +2427,6 @@ Camel 1.x branch, you can get the <tt>Li
</pre>
</div></div>
-<p>*In 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).</p>
-
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">from(routerEndpointURI).process(<span class="code-keyword">new</span> Processor() {
- @SuppressWarnings(<span class="code-quote">"unchecked"</span>)
- <span class="code-keyword">public</span> void process(Exchange exchange) <span class="code-keyword">throws</span> Exception {
- Message inMessage = exchange.getIn();
- CxfMessage message = (CxfMessage) inMessage;
- List<Element> elements = message.getMessage().get(List.class);
- assertNotNull(<span class="code-quote">"We should get the payload elements here"</span> , elements);
- assertEquals(<span class="code-quote">"Get the wrong elements size"</span> , elements.size(), 1);
- assertEquals(<span class="code-quote">"Get the wrong namespace URI"</span> , elements.get(0).getNamespaceURI(), <span class="code-quote">"http:<span class="code-comment">//camel.apache.org/pizza/types"</span>);
-</span>
- List<SoapHeader> headers = CastUtils.<span class="code-keyword">cast</span>((List<?>)message.getMessage().get(Header.HEADER_LIST));
- assertNotNull(<span class="code-quote">"We should get the headers here"</span>, headers);
- assertEquals(<span class="code-quote">"Get the wrong headers size"</span>, headers.size(), 1);
- assertEquals(<span class="code-quote">"Get the wrong namespace URI"</span> , ((Element)(headers.get(0).getObject())).getNamespaceURI(), <span class="code-quote">"http:<span class="code-comment">//camel.apache.org/pizza/types"</span>);
-</span>
- }
-
-})
-.to(serviceEndpointURI);
-</pre>
-</div></div>
-
<h3><a shape="rect" name="BookComponentAppendix-SOAPheadersarenotavailableinMESSAGEmode"></a>SOAP headers are not available in MESSAGE mode</h3>
<p>SOAP headers are not available in MESSAGE mode as SOAP processing is skipped.</p>
@@ -2795,7 +2674,7 @@ Assert.assertEquals(300, image.getHeight
<h3><a shape="rect" name="BookComponentAppendix-SeeAlso"></a>See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html" title="Configuring Camel">Configuring Camel</a></li><li><a shape="rect" href="component.html" title="Component">Component</a></li><li><a shape="rect" href="endpoint.html" title="Endpoint">Endpoint</a></li><li><a shape="rect" href="getting-started.html" title="Getting Started">Getting Started</a></li></ul>
-<h2><a shape="rect" name="BookComponentAppendix-CXFBeanComponent%282.0orlater%29"></a>CXF Bean Component (<b>2.0 or later</b>)</h2>
+<h2><a shape="rect" name="BookComponentAppendix-CXFBeanComponent"></a>CXF Bean Component</h2>
<p>The <b>cxfbean:</b> component allows other Camel endpoints to send exchange and invoke Web service bean objects. (<b>Currently, it only supports JAXRS, JAXWS(new to camel2.1) annotated service bean.</b>)</p>
@@ -3137,7 +3016,7 @@ inMessage.setHeader(CxfConstants.CAMEL_C
<a shape="rect" href="testing.html" title="Testing">Testing</a> of distributed and asynchronous processing is notoriously difficult. The <a shape="rect" href="mock.html" title="Mock">Mock</a>, <a shape="rect" href="test.html" title="Test">Test</a> and <a shape="rect" href="dataset.html" title="DataSet">DataSet</a> endpoints work great with the <a shape="rect" href="testing.html" title="Testing">Camel Testing Framework</a> to simplify your unit and integration testing using <a shape="rect" href="enterprise-integration-patterns.html" title="Enterprise Integration Patterns">Enterprise Integration Patterns</a> and Camel's large range of <a shape="rect" href="components.html" title="Components">Components</a> together with the powerful <a shape="rect" href="bean-integration.html" title="Bean Integration">Bean Integration</a>.
-<p>The DataSet component (available since 1.3.0) provides a mechanism to easily perform load & soak testing of your system. It works by allowing you to create <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/dataset/DataSet.html">DataSet instances</a> both as a source of messages and as a way to assert that the data set is received.</p>
+<p>The DataSet component provides a mechanism to easily perform load & soak testing of your system. It works by allowing you to create <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/dataset/DataSet.html">DataSet instances</a> both as a source of messages and as a way to assert that the data set is received.</p>
<p>Camel will use the <a shape="rect" href="log.html" title="Log">throughput logger</a> when sending dataset's. </p>
@@ -3595,13 +3474,6 @@ spring-event:<span class="code-comment">
</pre>
</div></div>
-<p>If you use Camel 1.x then you may need to remove the // to get it working with the Spring event notification</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-spring-event:<span class="code-keyword">default</span>
-</pre>
-</div></div>
-
<h3><a shape="rect" name="BookComponentAppendix-SeeAlso"></a>See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html" title="Configuring Camel">Configuring Camel</a></li><li><a shape="rect" href="component.html" title="Component">Component</a></li><li><a shape="rect" href="endpoint.html" title="Endpoint">Endpoint</a></li><li><a shape="rect" href="getting-started.html" title="Getting Started">Getting Started</a></li></ul>
@@ -3646,7 +3518,7 @@ Also, the starting directory must not co
<div class="confluenceTableSmall"><div class="table-wrap">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>initialDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Milliseconds before polling the file/directory starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>500</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Milliseconds before the next poll of the file/directory. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>useFixedDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> Controls if fixed delay or fix
ed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html" rel="nofollow">ScheduledExecutorService</a> in JDK for details. In <b>Camel 2.7.x</b> or older the default value is <tt>false</tt>. From <b>Camel 2.8</b> onwards the default value is <tt>true</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>runLoggingLevel</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>TRACE</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>recursive</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If a directory, will look for files in all the sub-directories as well.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delete</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If <tt>true</tt>, the file will be deleted <b>after</b> it is processed </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>noop</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If <tt>true</tt>, the file is not moved or deleted in any way. This option is good for readonly data, or for <a shape="rect" href="etl.html" title="ETL">ETL</a> type requirements. If <tt>noop=true</tt>, Camel will set <tt>idempotent=true</tt> as well, to avoid consuming the same files over and over again. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>preMove</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceT
d"> <a shape="rect" href="expression.html" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">File Language</a>) used to dynamically set the filename when moving it <b>before</b> processing. For example to move in-progress files into the <tt>order</tt> directory set this value to <tt>order</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>move</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>.camel</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <a shape="rect" href="expression.html" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">File Language</a>) used to dynamically set the filename when moving it <b>after</b> processing. To move files into a <tt>.done</tt> subdirectory just enter <tt>.done</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>moveFailed</tt> </td><td colspan="1" rowspan="
1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <a shape="rect" href="expression.html" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">File Language</a>) used to dynamically set a different target directory when moving files after processing (configured via <tt>move</tt> defined above) failed. For example, to move files into a <tt>.error</tt> subdirectory use: <tt>.error</tt>. Note: When moving the files to the “fail” location Camel will <b>handle</b> the error and will not pick up the file again. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>include</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Is used to include files, if filename matches the regex pattern. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>exclude</tt> </td><td colspan="
1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Is used to exclude files, if filename matches the regex pattern. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>antInclude</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Ant style filter inclusion, for example <tt>antInclude=*</tt><tt><b>/</b></tt><tt>.txt</tt>. Multiple inclusions may be specified in comma-delimited format. See <a shape="rect" href="#BookComponentAppendix-FilteringusingANTpathmatcher">below</a> for more details about ant path filters. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>antExclude</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Ant style filter exclusion. If both <tt>antInclude</tt> and <tt>antExclude</t
t> are used, <tt>antExclude</tt> takes precedence over <tt>antInclude</tt>. Multiple exclusions may be specified in comma-delimited format. See <a shape="rect" href="#BookComponentAppendix-FilteringusingANTpathmatcher">below</a> for more details about ant path filters. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>idempotent</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Option to use the <a shape="rect" href="idempotent-consumer.html" title="Idempotent Consumer">Idempotent Consumer</a> EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If <tt>noop=true</tt> then idempotent will be enabled as well to avoid consuming the same files over and over again. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>idempotentRepository</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <t
t>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> A pluggable repository <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/spi/IdempotentRepository.html">org.apache.camel.spi.IdempotentRepository</a> which by default use <tt>MemoryMessageIdRepository</tt> if none is specified and <tt>idempotent</tt> is <tt>true</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>inProgressRepository</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>memory</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> A pluggable in-progress repository <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/spi/IdempotentRepository.html">org.apache.camel.spi.IdempotentRepository</a>. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is us
ed. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>filter</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Pluggable filter as a <tt>org.apache.camel.component.file.GenericFileFilter</tt> class. Will skip files if filter returns <tt>false</tt> in its <tt>accept()</tt> method. More details in section below. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sorter</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Pluggable sorter as a <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html" rel="nofollow">java.util.Comparator<org.apache.camel.component.file.GenericFile></a> class. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sortBy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</
tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Built-in sort using the <a shape="rect" href="file-language.html" title="File Language">File Language</a>. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date. See sorting section below for details. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>readLock</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>markerFile</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. <br clear="none" class="atl-forced-newline">
This option provides the build in strategies: <br clear="none" class="atl-forced-newline"> <tt>markerFile</tt> Camel creates a marker file and then holds a lock on it. This option is <b>not</b> available for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component. <br clear="none" class="atl-forced-newline"> <tt>changed</tt> is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec. to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option <tt>readLockCheckInterval</tt> can be used to set the check frequency. This option is <b>only</b> avail for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component from <b>Camel 2.8</b> onwards. Notice that from <b>Camel 2.10.1</b> onwards the <a shape="rect" href="ftp2.html" title="FTP2">F
TP</a> option <tt>fastExistsCheck</tt> can be enabled to speedup this readLock strategy, if the FTP server support the LIST operation with a full file name (some servers may not). <br clear="none" class="atl-forced-newline"> <tt>fileLock</tt> is for using <tt>java.nio.channels.FileLock</tt>. This option is <b>not</b> avail for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. <br clear="none" class="atl-forced-newline"> <tt>rename</tt> is for using a try to rename the file as a test if we can get exclusive read-lock. <br clear="none" class="atl-forced-newline"> <tt>none</tt> is for no read locks at all. <br clear="none" class="atl-forced-newline">
-Notice from <b>Camel 2.10</b> onwards the read locks <tt>changed</tt>, <tt>fileLock</tt> and <tt>rename</tt> will also use a <tt>markerFile</tt> as well, to ensure not picking up files that may be in process by another Camel consumer running on another node (eg cluster). This is only supported by the file component (not the ftp component). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>readLockTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>10000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. In <b>Camel 2.0</b> the default value is 0. Starting with <b>Camel 2.1</b> the default value is 10000. Currently <tt
>fileLock</tt>, <tt>changed</tt> and <tt>rename</tt> support the timeout. <b>Notice:</b> For <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> the default <tt>readLockTimeout</tt> value is <tt>20000</tt> instead of <tt>10000</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>readLockCheckInterval</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.6:</b> Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the <tt>changed</tt> read lock, you can set a higher interval period to cater for <em>slow writes</em>. The default of 1 sec. may be <em>too fast</em> if the producer is very slow writing the file. For <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> the default <tt>readLockCheckInterval</tt> is <tt>5000</tt>. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>readLockMinLength</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10.1:</b> This option applied only for <tt>readLock=changed</tt>. This option allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>directoryMustExist</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.5:</b> Similar to <tt>startingDirectoryMustExist</tt> but this applies during polling recursive sub directories. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>doneFileName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.6:</b> If provided, Camel will only consume files if a <em>done</em> file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The <em>done</em> file is <b>always</b> expected in the same folder as the original file. See <em>using done file</em> and <em>writing done file</em> sections for examples. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>exclusiveReadLockStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Pluggable read-lock as a <tt>org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy</tt> implementation. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> An integer to
define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. See more details at <a shape="rect" href="batch-consumer.html" title="Batch Consumer">Batch Consumer</a>. <b>Notice:</b> If this option is in use then the <a shape="rect" href="file2.html" title="File2">File</a> and <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> components will limit <b>before</b> any sorting. For example if you have 100000 files and use <tt>maxMessagesPerPoll=500</tt>, then only the first 500 files will be picked up, and then sorted. You can use the <tt>eagerMaxMessagesPerPoll</tt> option and set this to <tt>false</tt> to allow to scan all files first and then sort afterwards. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>eagerMaxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenc
eTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.9.3:</b> Allows for controlling whether the limit from <tt>maxMessagesPerPoll</tt> is eager or not. If eager then the limit is during the scanning of files. Where as <tt>false</tt> would scan all files, and then perform sorting. Setting this option to <tt>false</tt> allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>minDepth</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 0 </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8</b>: The minimum depth to start processing when recursively processing a directory. Using <tt>minDepth=1</tt> means the base directory. Using <tt>minDepth=2</tt> means the first sub directory. This option is supported by <a shape="rect" href="ftp2.html" title="FTP
2">FTP</a> consumer from <b>Camel 2.8.2, 2.9</b> onwards. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxDepth</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>Integer.MAX_VALUE</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> The maximum depth to traverse when recursively processing a directory. This option is supported by <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> consumer from <b>Camel 2.8.2, 2.9</b> onwards. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>processStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> A pluggable <tt>org.apache.camel.component.file.GenericFileProcessStrategy</tt> allowing you to implement your own <tt>readLock</tt> option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special <em>ready</em> file exists.
If this option is set then the <tt>readLock</tt> option does not apply. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>startingDirectoryMustExist</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.5:</b> Whether the starting directory must exist. Mind that the <tt>autoCreate</tt> option is default enabled, which means the starting directory is normally auto created if it doesn't exist. You can disable <tt>autoCreate</tt> and enable this to ensure the starting directory must exist. Will thrown an exception if the directory doesn't exist. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>pollStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.0:</b> A pluggable <tt>org.apache.camel.PollingConsumerPollStrategy</tt> allowing you to provide your custom impl
ementation to control error handling usually occurred during the <tt>poll</tt> operation <b>before</b> an <a shape="rect" href="exchange.html" title="Exchange">Exchange</a> have been created and being routed in Camel. In other words the error occurred while the polling was gathering information, for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at <tt>WARN</tt> level and ignore it. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sendEmptyMessageWhenIdle</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.9:</b> If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.bridgeErrorHandler</tt> </td><td colspan="1" rowspan="1" class="conflu
enceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Allows for bridging the consumer to the Camel routing <a shape="rect" href="error-handler.html" title="Error Handler">Error Handler</a>, which mean any exceptions occurred while trying to pickup files, or the likes, will now be processed as a message and handled by the routing <a shape="rect" href="error-handler.html" title="Error Handler">Error Handler</a>. By default the consumer will use the <tt>org.apache.camel.spi.ExceptionHandler</tt> to deal with exceptions, that by default will be logged at WARN/ERROR level and ignored. See further below on this page fore more details, at section <em>How to use the Camel error handler to deal with exceptions triggered outside the routing engine</em>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>scheduledExecutorService</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" ro
wspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple file consumers. </td></tr></tbody></table>
[... 711 lines stripped ...]