Page History

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-cxf</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

cxf:bean:cxfEndpoint[?options]

cxf://someAddress[?options]

{div:class=confluenceTableSmall}
|| Name || Required || Description ||
| {{wsdlURL}} | No | The location of the WSDL. It is obtained from endpoint address by default. \\ \\ _Example_: [file://local/wsdl/hello.wsdl] or {{wsdl/hello.wsdl}} |
| {{serviceClass}} | Yes | The name of the SEI (Service Endpoint Interface) class. This class can have, but does not require, JSR181 annotations. \\ This option is only required by POJO mode. If the wsdlURL option is provided, serviceClass is not required for PAYLOAD and MESSAGE mode. When wsdlURL option is used without serviceClass, the serviceName and portName (endpointName for Spring configuration) options *MUST* be provided. It is possible to use {{\#}} notation to reference a {{serviceClass}} object instance from the registry. E.g. {{serviceClass=#beanName}}. The {{serviceClass}} for a CXF producer (that is, the {{to}} endpoint) should be a Java interface.\\ *Since 2.8,* it is possible to omit both wsdlURL and serviceClass options for PAYLOAD and MESSAGE mode. When they are omitted, arbitrary XML elements can be put in CxfPayload's body in PAYLOAD mode to facilitate CXF Dispatch Mode. \\ \\ Please be advised that the *referenced object cannot be a Proxy* (Spring AOP Proxy is OK) as it relies on {{Object.getClass().getName()}} method for non Spring AOP Proxy. \\ \\ _Example_: {{org.apache.camel.Hello}} |
| {{serviceName}} | No | The service name this service is implementing, it maps to the {{wsdl:service@name}}. \\ \\ *Required* for camel-cxf consumer since camel-2.2.0 or if more than one {{serviceName}} is present in WSDL. \\ \\ _Example_: \{http:­//org.apache.camel}ServiceName |
| {{portName}} | No | The port name this service is implementing, it maps to the {{wsdl:port@name}}. \\ \\ *Required* for camel-cxf consumer since camel-2.2.0 or if more than one {{portName}} is present under {{serviceName}}. \\ \\ _Example_: \{http:­//org.apache.camel}PortName |
| {{dataFormat}} | No | The data type messages supported by the CXF endpoint. \\ \\ _Default_: {{POJO}} \\ _Example_: {{POJO}}, {{PAYLOAD}}, {{MESSAGE}} |
| {{relayHeaders}} | No | Please see the *Description of* {{{*}relayHeaders{*}}} *option* section for this option.  Should a CXF endpoint relay headers along the route. Currently only available when {{dataFormat=POJO}} \\ \\ _Default_: {{true}} \\ _Example_: {{true}}, {{false}} |
| {{wrapped}} | No | Which kind of operation that CXF  endpoint producer will invoke \\ \\ _Default_: {{false}} \\ _Example_: {{true}}, {{false}} |
| {{wrappedStyle}} | No | *New in 2.5.0* The WSDL style that describes how parameters are represented in the SOAP body. If the value is false, CXF will chose the document-literal unwrapped style, If the value is true, CXF will chose the document-literal wrapped style \\ \\ _Default_: {{Null}} \\ _Example_: {{true}}, {{false}} |
| {{setDefaultBus}} | No | Will set the default bus when CXF endpoint create a bus by itself \\ \\ _Default_: {{false}} \\ _Example_: {{true}}, {{false}} |
| {{bus}} | No | A default bus created by CXF Bus Factory. Use {{\#}} notation to reference a bus object from the registry. The referenced object must be an instance of {{org.apache.cxf.Bus}}. \\ \\ _Example_: {{bus=#busName}} |
| {{cxfBinding}} | No | Use {{\#}} notation to reference a CXF binding object from the registry. The referenced object must be an instance of {{org.apache.camel.component.cxf.CxfBinding}} (use an instance of {{org.apache.camel.component.cxf.DefaultCxfBinding}}). \\ \\ _Example_: {{cxfBinding=#bindingName}} \\ |
| {{headerFilterStrategy}} | No | Use {{\#}} notation to reference a header filter strategy object from the registry. The referenced object must be an instance of {{org.apache.camel.spi.HeaderFilterStrategy}} (use an instance of {{org.apache.camel.component.cxf.CxfHeaderFilterStrategy}}). \\ \\ _Example_: {{headerFilterStrategy=#strategyName}} |
| {{loggingFeatureEnabled}} | No | New in 2.3. This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log. \\ \\ _Default_: {{false}} \\ _Example_: {{loggingFeatureEnabled{}}}{{=true}} |
| {{defaultOperationName}} | No | New in 2.4, this option will set the default operationName that will be used by the CxfProducer which invokes the remote service. \\ \\ _Default_: {{null}} \\ _Example_: {{defaultOperationName{}}}{{=greetMe}} |
| {{defaultOperationNamespace}} | No | New in 2.4. This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service. \\ \\ _Default_: {{null}} \\ _Example_: {{defaultOperationNamespace{}}}{{=}}{{[http://apache.org/hello_world_soap_http]}} |
| {{synchronous}} | No | New in 2.5. This option will let cxf endpoint decide to use sync or async API to do the underlying work. The default value is false which means camel-cxf endpoint will try to use async API by default. \\ \\ _Default_: {{false}} \\ _Example_: synchronous=true |
| {{publishedEndpointUrl}} | No | 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. \\ \\ _Default_: {{null}} \\ _Example_: publshedEndpointUrl=[http://example.com/service] |
| {{properties.XXX}} | No | *Camel 2.8:* Allows to set custom properties to CXF in the endpoint uri. For example setting {{properties.mtom-enabled=true}} to enable MTOM. |
| {{allowStreaming}} | No | 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. | 
| {{skipFaultLogging}} | No | New in 2.11. This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. |
| {{username}} | No | New in *Camel 2.12.3* This option is used to set the basic authentication information of username for the CXF client. |
| {{password}} | No | New in *Camel 2.12.3* This option is used to set the basic authentication information of password for the CXF client. |

The {{serviceName}} and {{portName}} are [QNames|http://en.wikipedia.org/wiki/QName], so if you provide them be sure to prefix them with their \{namespace\} as shown in the examples above.

h4. The descriptions of the dataformats

{div:class=confluenceTableSmall}
|| DataFormat || Description ||
| {{POJO}} | POJOs (Plain old Java objects) are the Java parameters to the method being invoked on the target server.  Both Protocol and Logical JAX-WS handlers are supported. |
| {{PAYLOAD}} | {{PAYLOAD}} is the message payload (the contents of the {{soap:body}}) after message configuration in the CXF endpoint is applied.  Only Protocol JAX-WS handler is supported.  Logical JAX-WS handler is not supported. |
| {{MESSAGE}} | {{MESSAGE}} is the raw message that is received from the transport layer. It is not suppose to touch or change Stream, some of the CXF interceptor 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. |
| {{CXF_MESSAGE}} | New in *Camel 2.8.2*, {{CXF_MESSAGE}} allows for invoking the full capabilities of CXF interceptors by converting the message from the transport layer into a raw SOAP message|

You can determine the data format mode of an exchange by retrieving the exchange property, {{CamelCXFDataFormat}}.  The exchange key constant is defined in {{org.apache.camel.component.cxf.CxfConstants.DATA_FORMAT_PROPERTY}}.
{div}

<cxf:cxfEndpoint ...>
   <cxf:properties>
     <entry key="org.apache.camel.cxf.message.headers.relays">
       <list>
         <ref bean="customHeadersRelay"/>
       </list>
     </entry>
   </cxf:properties>
 </cxf:cxfEndpoint>
 <bean id="customHeadersRelay" class="org.apache.camel.component.cxf.soap.headers.CustomHeadersRelay"/>

<cxf:cxfEndpoint id="testEndpoint" address="http://localhost:9000/router"
     serviceClass="org.apache.camel.component.cxf.HelloService"
     endpointName="s:PortName"
     serviceName="s:ServiceName"
     xmlns:s="http://www.example.com/test">
     <cxf:properties>
       <entry key="dataFormat" value="MESSAGE"/>
       <entry key="setDefaultBus" value="true"/>
     </cxf:properties>
   </cxf:cxfEndpoint>

<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.0.0"
           xmlns:camel-cxf="http://camel.apache.org/schema/blueprint/cxf"
	   xmlns:cxfcore="http://cxf.apache.org/blueprint/core"
           xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">

      <camel-cxf:cxfEndpoint id="routerEndpoint"
                     address="http://localhost:9001/router"
                     serviceClass="org.apache.servicemix.examples.cxf.HelloWorld">
        <camel-cxf:properties>
            <entry key="dataFormat" value="MESSAGE"/>
        </camel-cxf:properties>
     </camel-cxf:cxfEndpoint>

     <camel-cxf:cxfEndpoint id="serviceEndpoint"
			address="http://localhost:9000/SoapContext/SoapPort"
                     serviceClass="org.apache.servicemix.examples.cxf.HelloWorld">
    </camel-cxf:cxfEndpoint>

    <camelContext xmlns="http://camel.apache.org/schema/blueprint">
        <route>
            <from uri="routerEndpoint"/>
            <to uri="log:request"/>
        </route>
    </camelContext>

</blueprint>

<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.0.0"
           xmlns:jaxws="http://cxf.apache.org/blueprint/jaxws"
           xmlns:cxf="http://cxf.apache.org/blueprint/core"
           xmlns:camel="http://camel.apache.org/schema/blueprint"
           xmlns:camelcxf="http://camel.apache.org/schema/blueprint/cxf"
           xsi:schemaLocation="
             http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd
             http://cxf.apache.org/blueprint/jaxws http://cxf.apache.org/schemas/blueprint/jaxws.xsd
             http://cxf.apache.org/blueprint/core http://cxf.apache.org/schemas/blueprint/core.xsd
             ">

    <camelcxf:cxfEndpoint id="reportIncident"
                     address="/camel-example-cxf-blueprint/webservices/incident"
                     wsdlURL="META-INF/wsdl/report_incident.wsdl"
                     serviceClass="org.apache.camel.example.reportincident.ReportIncidentEndpoint">
    </camelcxf:cxfEndpoint>

    <bean id="reportIncidentRoutes" class="org.apache.camel.example.reportincident.ReportIncidentRoutes" />

    <camelContext xmlns="http://camel.apache.org/schema/blueprint">
        <routeBuilder ref="reportIncidentRoutes"/>
    </camelContext>

</blueprint>

Error:sendSms: SoapFault exception: [Client] looks like we got no XML document in [...]

 // set up the response context which force start document
 Map<String, Object> map = new HashMap<String, Object>();
 map.put("org.apache.cxf.stax.force-start-document", Boolean.TRUE);
 exchange.getOut().setHeader(Client.RESPONSE_CONTEXT, map);

        CxfExchange exchange = (CxfExchange)template.send(getJaxwsEndpointUri(), new Processor() {
             public void process(final Exchange exchange) {
                 final List<String> params = new ArrayList<String>();
                 params.add(TEST_MESSAGE);
                 // Set the request context to the inMessage
                 Map<String, Object> requestContext = new HashMap<String, Object>();
                 requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, JAXWS_SERVER_ADDRESS);
                 exchange.getIn().setBody(params);
                 exchange.getIn().setHeader(Client.REQUEST_CONTEXT , requestContext);
                 exchange.getIn().setHeader(CxfConstants.OPERATION_NAME, GREET_ME_OPERATION);
             }
         });
         org.apache.camel.Message out = exchange.getOut();
         // The output is an object array, the first element of the array is the return value
         Object\[\] output = out.getBody(Object\[\].class);
         LOG.info("Received output text: " + output\[0\]);
         // Get the response context form outMessage
         Map<String, Object> responseContext = CastUtils.cast((Map)out.getHeader(Client.RESPONSE_CONTEXT));
         assertNotNull(responseContext);
         assertEquals("Get the wrong wsdl opertion name", "{http://apache.org/hello_world_soap_http}greetMe",
                      responseContext.get("javax.xml.ws.wsdl.operation").toString());