You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2016/08/16 08:03:54 UTC
[30/51] [partial] camel git commit: CAMEL-9541: Use -component as
suffix for component docs.
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-cxf/src/main/docs/cxf.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cxf/src/main/docs/cxf.adoc b/components/camel-cxf/src/main/docs/cxf.adoc
deleted file mode 100644
index ba16233..0000000
--- a/components/camel-cxf/src/main/docs/cxf.adoc
+++ /dev/null
@@ -1,934 +0,0 @@
-[[CXF-CXFComponent]]
-CXF Component
-~~~~~~~~~~~~~
-
-NOTE:When using CXF as a consumer, the link:cxf-bean-component.html[CXF Bean
-Component] allows you to factor out how message payloads are received
-from their processing as a RESTful or SOAP web service. This has the
-potential of using a multitude of transports to consume web services.
-The bean component's configuration is also simpler and provides the
-fastest method to implement web services using Camel and CXF.
-
-TIP:When using CXF in streaming modes (see DataFormat option), then also
-read about link:stream-caching.html[Stream caching].
-
-The *cxf:* component provides integration with
-http://cxf.apache.org[Apache CXF] for connecting to JAX-WS services
-hosted in CXF.
-
-* link:#CXF-CXFComponent[CXF Component]
-** link:#CXF-URIformat[URI format]
-** link:#CXF-Options[Options]
-*** link:#CXF-Thedescriptionsofthedataformats[The descriptions of the
-dataformats]
-**** link:#CXF-HowtoenableCXFLoggingOutInterceptorinMESSAGEmode[How to
-enable CXF's LoggingOutInterceptor in MESSAGE mode]
-*** link:#CXF-DescriptionofrelayHeadersoption[Description of
-relayHeaders option]
-**** link:#CXF-AvailableonlyinPOJOmode[Available only in POJO mode]
-**** link:#CXF-ChangessinceRelease2.0[Changes since Release 2.0]
-** link:#CXF-ConfiguretheCXFendpointswithSpring[Configure the CXF
-endpoints with Spring]
-**
-link:#CXF-ConfiguringtheCXFEndpointswithApacheAriesBlueprint.[Configuring
-the CXF Endpoints with Apache Aries Blueprint.]
-**
-link:#CXF-Howtomakethecamel-cxfcomponentuselog4jinsteadofjava.util.logging[How
-to make the camel-cxf component use log4j instead of java.util.logging]
-** link:#CXF-Howtoletcamel-cxfresponsemessagewithxmlstartdocument[How to
-let camel-cxf response message with xml start document]
-** link:#CXF-HowtooverridetheCXFproduceraddressfrommessageheader[How to
-override the CXF producer address from message header]
-**
-link:#CXF-Howtoconsumeamessagefromacamel-cxfendpointinPOJOdataformat[How
-to consume a message from a camel-cxf endpoint in POJO data format]
-**
-link:#CXF-Howtopreparethemessageforthecamel-cxfendpointinPOJOdataformat[How
-to prepare the message for the camel-cxf endpoint in POJO data format]
-**
-link:#CXF-Howtodealwiththemessageforacamel-cxfendpointinPAYLOADdataformat[How
-to deal with the message for a camel-cxf endpoint in PAYLOAD data
-format]
-** link:#CXF-HowtogetandsetSOAPheadersinPOJOmode[How to get and set SOAP
-headers in POJO mode]
-** link:#CXF-HowtogetandsetSOAPheadersinPAYLOADmode[How to get and set
-SOAP headers in PAYLOAD mode]
-** link:#CXF-SOAPheadersarenotavailableinMESSAGEmode[SOAP headers are
-not available in MESSAGE mode]
-** link:#CXF-HowtothrowaSOAPFaultfromCamel[How to throw a SOAP Fault
-from Camel]
-**
-link:#CXF-Howtopropagateacamel-cxfendpointrequestandresponsecontext[How
-to propagate a camel-cxf endpoint's request and response context]
-** link:#CXF-AttachmentSupport[Attachment Support]
-** link:#CXF-StreamingSupportinPAYLOADmode[Streaming Support in PAYLOAD
-mode]
-** link:#CXF-UsingthegenericCXFDispatchmode[Using the generic CXF
-Dispatch mode]
-** link:#CXF-SeeAlso[See Also]
-
-Maven users will need to add the following dependency to their `pom.xml`
-for this component:
-
-[source,xml]
-------------------------------------------------------------
-<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>
-------------------------------------------------------------
-
-[Tip]
-====
-CXF dependencies
-
-If you want to learn about CXF dependencies you can checkout the
-`WHICH-JARS` text file.
-
-====
-
-[[CXF-URIformat]]
-URI format
-^^^^^^^^^^
-
-[source,java]
-------------------------------
-cxf:bean:cxfEndpoint[?options]
-------------------------------
-
-Where *cxfEndpoint* represents a bean ID that references a bean in the
-Spring bean registry. With this URI format, most of the endpoint details
-are specified in the bean definition.
-
-[source,java]
----------------------------
-cxf://someAddress[?options]
----------------------------
-
-Where *someAddress* specifies the CXF endpoint's address. With this URI
-format, most of the endpoint details are specified using options.
-
-For either style above, you can append options to the URI as follows:
-
-[source,java]
----------------------------------------------------------------------
-cxf:bean:cxfEndpoint?wsdlURL=wsdl/hello_world.wsdl&dataFormat=PAYLOAD
----------------------------------------------------------------------
-
-[[CXF-Options]]
-Options
-^^^^^^^
-
-
-// component options: START
-The CXF component supports 2 options which are listed below.
-
-
-
-{% raw %}
-[width="100%",cols="2s,1m,8",options="header"]
-|=======================================================================
-| Name | Java Type | Description
-| allowStreaming | Boolean | This option controls whether the CXF component when running in PAYLOAD mode 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.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-|=======================================================================
-{% endraw %}
-// component options: END
-
-
-
-
-// endpoint options: START
-The CXF component supports 35 endpoint options which are listed below:
-
-{% raw %}
-[width="100%",cols="2s,1,1m,1m,5",options="header"]
-|=======================================================================
-| Name | Group | Default | Java Type | Description
-| beanId | common | | String | To lookup an existing configured CxfEndpoint. Must used bean: as prefix.
-| address | service | | String | The service publish address.
-| dataFormat | common | POJO | DataFormat | The data type messages supported by the CXF endpoint.
-| wrappedStyle | common | | Boolean | 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
-| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-| defaultOperationName | producer | | String | This option will set the default operationName that will be used by the CxfProducer which invokes the remote service.
-| defaultOperationNamespace | producer | | String | This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service.
-| hostnameVerifier | producer | | HostnameVerifier | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry.
-| sslContextParameters | producer | | SSLContextParameters | The Camel SSL setting reference. Use the notation to reference the SSL Context.
-| wrapped | producer | false | boolean | Which kind of operation that CXF endpoint producer will invoke
-| allowStreaming | advanced | | Boolean | This option controls whether the CXF component when running in PAYLOAD mode 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.
-| bus | advanced | | Bus | To use a custom configured CXF Bus.
-| continuationTimeout | advanced | 30000 | long | This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport.
-| cxfBinding | advanced | | CxfBinding | To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
-| cxfEndpointConfigurer | advanced | | CxfEndpointConfigurer | This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configureServerClient method of CxfEndpointConfigurer.
-| defaultBus | advanced | false | boolean | Will set the default bus when CXF endpoint create a bus by itself
-| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
-| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-| mergeProtocolHeaders | advanced | false | boolean | Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393.
-| mtomEnabled | advanced | false | boolean | To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode.
-| properties | advanced | | Map | To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults properties.faultStackTraceEnabled=true
-| skipPayloadMessagePartCheck | advanced | false | boolean | Sets whether SOAP message validation should be disabled.
-| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-| loggingFeatureEnabled | logging | false | boolean | This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log.
-| loggingSizeLimit | logging | 49152 | int | To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit.
-| skipFaultLogging | logging | false | boolean | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches.
-| password | security | | String | This option is used to set the basic authentication information of password for the CXF client.
-| username | security | | String | This option is used to set the basic authentication information of username for the CXF client.
-| bindingId | service | | String | The bindingId for the service model to use.
-| portName | service | | String | The endpoint name this service is implementing it maps to the wsdl:portname. In the format of ns:PORT_NAME where ns is a namespace prefix valid at this scope.
-| publishedEndpointUrl | service | | String | This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd
-| serviceClass | service | | Class<?> | The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not.
-| serviceName | service | | String | The service name this service is implementing it maps to the wsdl:servicename.
-| wsdlURL | service | | String | The location of the WSDL. Can be on the classpath file system or be hosted remotely.
-|=======================================================================
-{% endraw %}
-// endpoint options: END
-
-
-The `serviceName` and `portName` are
-http://en.wikipedia.org/wiki/QName[QNames], so if you provide them be
-sure to prefix them with their \{namespace} as shown in the examples
-above.
-
-[[CXF-Thedescriptionsofthedataformats]]
-The descriptions of the dataformats
-+++++++++++++++++++++++++++++++++++
-
-[width="100%",cols="50%,50%",options="header",]
-|=======================================================================
-|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
-interceptors will be removed if you are using this kind of DataFormat so
-you can't see any soap headers after the camel-cxf consumer and JAX-WS
-handler is not supported.
-
-|`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`.
-
-[[CXF-HowtoenableCXFLoggingOutInterceptorinMESSAGEmode]]
-How to enable CXF's LoggingOutInterceptor in MESSAGE mode
-
-CXF's `LoggingOutInterceptor` outputs outbound message that goes on the
-wire to logging system (Java Util Logging). Since the
-`LoggingOutInterceptor` is in `PRE_STREAM` phase (but `PRE_STREAM` phase
-is removed in `MESSAGE` mode), you have to configure
-`LoggingOutInterceptor` to be run during the `WRITE` phase. The
-following is an example.
-
-[source,xml]
--------------------------------------------------------------------------------------------------------
-<bean id="loggingOutInterceptor" class="org.apache.cxf.interceptor.LoggingOutInterceptor">
- <!-- it really should have been user-prestream but CXF does have such phase! -->
- <constructor-arg value="target/write"/>
-</bean>
-
-<cxf:cxfEndpoint id="serviceEndpoint" address="http://localhost:${CXFTestSupport.port2}/LoggingInterceptorInMessageModeTest/helloworld"
- serviceClass="org.apache.camel.component.cxf.HelloService">
- <cxf:outInterceptors>
- <ref bean="loggingOutInterceptor"/>
- </cxf:outInterceptors>
- <cxf:properties>
- <entry key="dataFormat" value="MESSAGE"/>
- </cxf:properties>
-</cxf:cxfEndpoint>
--------------------------------------------------------------------------------------------------------
-
-[[CXF-DescriptionofrelayHeadersoption]]
-Description of relayHeaders option
-++++++++++++++++++++++++++++++++++
-
-There are _in-band_ and _out-of-band_ on-the-wire headers from the
-perspective of a JAXWS WSDL-first developer.
-
-The _in-band_ headers are headers that are explicitly defined as part of
-the WSDL binding contract for an endpoint such as SOAP headers.
-
-The _out-of-band_ headers are headers that are serialized over the wire,
-but are not explicitly part of the WSDL binding contract.
-
-Headers relaying/filtering is bi-directional.
-
-When a route has a CXF endpoint and the developer needs to have
-on-the-wire headers, such as SOAP headers, be relayed along the route to
-be consumed say by another JAXWS endpoint, then `relayHeaders` should be
-set to `true`, which is the default value.
-
-[[CXF-AvailableonlyinPOJOmode]]
-Available only in POJO mode
-
-The `relayHeaders=true` 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 `MessageHeadersRelay` interface.
-A concrete implementation of `MessageHeadersRelay` will be consulted to
-decide if a header needs to be relayed or not. There is already an
-implementation of `SoapMessageHeadersRelay` which binds itself to
-well-known SOAP name spaces. Currently only out-of-band headers are
-filtered, and in-band headers will always be relayed when
-`relayHeaders=true`. If there is a header on the wire, whose name space
-is unknown to the runtime, then a fall back `DefaultMessageHeadersRelay`
-will be used, which simply allows all headers to be relayed.
-
-The `relayHeaders=false` setting asserts that all headers in-band and
-out-of-band will be dropped.
-
-You can plugin your own `MessageHeadersRelay` implementations overriding
-or adding additional ones to the list of relays. In order to override a
-preloaded relay instance just make sure that your `MessageHeadersRelay`
-implementation services the same name spaces as the one you looking to
-override. Also note, that the overriding relay has to service all of the
-name spaces as the one you looking to override, or else a runtime
-exception on route start up will be thrown as this would introduce an
-ambiguity in name spaces to relay instance mappings.
-
-[source,xml]
--------------------------------------------------------------------------------------------------------
-<cxf:cxfEndpoint ...>
- <cxf:properties>
- <entry key="org.apache.camel.cxf.message.headers.relays">
- <list>
- <ref bean="customHeadersRelay"/>
- </list>
- </entry>
- </cxf:properties>
- </cxf:cxfEndpoint>
- <bean id="customHeadersRelay" class="org.apache.camel.component.cxf.soap.headers.CustomHeadersRelay"/>
--------------------------------------------------------------------------------------------------------
-
-Take a look at the tests that show how you'd be able to relay/drop
-headers here:
-
-https://svn.apache.org/repos/asf/camel/branches/camel-1.x/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/soap/headers/CxfMessageHeadersRelayTest.java[https://svn.apache.org/repos/asf/camel/branches/camel-1.x/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/soap/headers/CxfMessageHeadersRelayTest.java]
-
-[[CXF-ChangessinceRelease2.0]]
-Changes since Release 2.0
-
-* `POJO` and `PAYLOAD` modes are supported. In `POJO` 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 `MessageContentList` in POJO
-mode. The `camel-cxf` component does make any attempt to remove the
-in-band headers from the `MessageContentList`. If filtering of in-band
-headers is required, please use `PAYLOAD` mode or plug in a (pretty
-straightforward) CXF interceptor/JAXWS Handler to the CXF endpoint.
-* The Message Header Relay mechanism has been merged into
-`CxfHeaderFilterStrategy`. The `relayHeaders` option, its semantics, and
-default value remain the same, but it is a property of
-`CxfHeaderFilterStrategy`.
- Here is an example of configuring it.
-
-[source,xml]
--------------------------------------------------------------------------------------------------------
-<bean id="dropAllMessageHeadersStrategy" class="org.apache.camel.component.cxf.common.header.CxfHeaderFilterStrategy">
-
- <!-- Set relayHeaders to false to drop all SOAP headers -->
- <property name="relayHeaders" value="false"/>
-
-</bean>
--------------------------------------------------------------------------------------------------------
-
-Then, your endpoint can reference the `CxfHeaderFilterStrategy`.
-
-[source,xml]
--------------------------------------------------------------------------------------------------------
-<route>
- <from uri="cxf:bean:routerNoRelayEndpoint?headerFilterStrategy=#dropAllMessageHeadersStrategy"/>
- <to uri="cxf:bean:serviceNoRelayEndpoint?headerFilterStrategy=#dropAllMessageHeadersStrategy"/>
-</route>
--------------------------------------------------------------------------------------------------------
-
-* The `MessageHeadersRelay` interface has changed slightly and has been
-renamed to `MessageHeaderFilter`. It is a property of
-`CxfHeaderFilterStrategy`. Here is an example of configuring user
-defined Message Header Filters:
-
-[source,xml]
--------------------------------------------------------------------------------------------------------
-<bean id="customMessageFilterStrategy" class="org.apache.camel.component.cxf.common.header.CxfHeaderFilterStrategy">
- <property name="messageHeaderFilters">
- <list>
- <!-- SoapMessageHeaderFilter is the built in filter. It can be removed by omitting it. -->
- <bean class="org.apache.camel.component.cxf.common.header.SoapMessageHeaderFilter"/>
-
- <!-- Add custom filter here -->
- <bean class="org.apache.camel.component.cxf.soap.headers.CustomHeaderFilter"/>
- </list>
- </property>
-</bean>
--------------------------------------------------------------------------------------------------------
-
-* Other than `relayHeaders`, there are new properties that can be
-configured in `CxfHeaderFilterStrategy`.
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Name |Required |Description
-|`relayHeaders` |No |All message headers will be processed by Message Header Filters
- _Type_: `boolean`
- _Default_: `true`
-
-|`relayAllMessageHeaders` | No |All message headers will be propagated (without processing by Message
-Header Filters)
- _Type_: `boolean`
- _Default_: `false`
-
-|`allowFilterNamespaceClash` |No |If two filters overlap in activation namespace, the property control how
-it should be handled. If the value is `true`, last one wins. If the
-value is `false`, it will throw an exception
- _Type_: `boolean`
- _Default_: `false`
-|=======================================================================
-
-[[CXF-ConfiguretheCXFendpointswithSpring]]
-Configure the CXF endpoints with Spring
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-You can configure the CXF endpoint with the Spring configuration file
-shown below, and you can also embed the endpoint into the `camelContext`
-tags. When you are invoking the service endpoint, you can set the
-`operationName` and `operationNamespace` headers to explicitly state
-which operation you are calling.
-
-[source,xml]
-----------------------------------------------------------------------------------------------------------------
-<beans xmlns="http://www.springframework.org/schema/beans"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns:cxf="http://camel.apache.org/schema/cxf"
- xsi:schemaLocation="
- http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
- http://camel.apache.org/schema/cxf http://camel.apache.org/schema/cxf/camel-cxf.xsd
- http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd">
- <cxf:cxfEndpoint id="routerEndpoint" address="http://localhost:9003/CamelContext/RouterPort"
- serviceClass="org.apache.hello_world_soap_http.GreeterImpl"/>
- <cxf:cxfEndpoint id="serviceEndpoint" address="http://localhost:9000/SoapContext/SoapPort"
- wsdlURL="testutils/hello_world.wsdl"
- serviceClass="org.apache.hello_world_soap_http.Greeter"
- endpointName="s:SoapPort"
- serviceName="s:SOAPService"
- xmlns:s="http://apache.org/hello_world_soap_http" />
- <camelContext id="camel" xmlns="http://camel.apache.org/schema/spring">
- <route>
- <from uri="cxf:bean:routerEndpoint" />
- <to uri="cxf:bean:serviceEndpoint" />
- </route>
- </camelContext>
- </beans>
-----------------------------------------------------------------------------------------------------------------
-
-Be sure to include the JAX-WS `schemaLocation` attribute specified on
-the root beans element. This allows CXF to validate the file and is
-required. Also note the namespace declarations at the end of the
-`<cxf:cxfEndpoint/>` tag--these are required because the combined
-\{`namespace}localName` syntax is presently not supported for this tag's
-attribute values.
-
-The `cxf:cxfEndpoint` element supports many additional attributes:
-
-[width="100%",cols="50%,50%",options="header",]
-|=======================================================================
-|Name |Value
-
-|`PortName` |The endpoint name this service is implementing, it maps to the
-`wsdl:port@name`. In the format of `ns:PORT_NAME` where `ns` is a
-namespace prefix valid at this scope.
-
-|`serviceName` |The service name this service is implementing, it maps to the
-`wsdl:service@name`. In the format of `ns:SERVICE_NAME` where `ns` is a
-namespace prefix valid at this scope.
-
-|`wsdlURL` |The location of the WSDL. Can be on the classpath, file system, or be
-hosted remotely.
-
-|`bindingId` |The `bindingId` for the service model to use.
-
-|`address` |The service publish address.
-
-|`bus` |The bus name that will be used in the JAX-WS endpoint.
-
-|`serviceClass` |The class name of the SEI (Service Endpoint Interface) class which could
-have JSR181 annotation or not.
-|=======================================================================
-
-It also supports many child elements:
-
-[width="100%",cols="50%,50%",options="header",]
-|=======================================================================
-|Name |Value
-
-|`cxf:inInterceptors` |The incoming interceptors for this endpoint. A list of `<bean>` or
-`<ref>`.
-
-|`cxf:inFaultInterceptors` |The incoming fault interceptors for this endpoint. A list of `<bean>` or
-`<ref>`.
-
-|`cxf:outInterceptors` |The outgoing interceptors for this endpoint. A list of `<bean>` or
-`<ref>`.
-
-|`cxf:outFaultInterceptors` |The outgoing fault interceptors for this endpoint. A list of `<bean>` or
-`<ref>`.
-
-|`cxf:properties` | A properties map which should be supplied to the JAX-WS endpoint. See
-below.
-
-|`cxf:handlers` |A JAX-WS handler list which should be supplied to the JAX-WS endpoint.
-See below.
-
-|`cxf:dataBinding` |You can specify the which `DataBinding` will be use in the endpoint.
-This can be supplied using the Spring `<bean class="MyDataBinding"/>`
-syntax.
-
-|`cxf:binding` |You can specify the `BindingFactory` for this endpoint to use. This can
-be supplied using the Spring `<bean class="MyBindingFactory"/>` syntax.
-
-|`cxf:features` |The features that hold the interceptors for this endpoint. A list of
-beans or refs
-
-|`cxf:schemaLocations` |The schema locations for endpoint to use. A list of schemaLocations
-
-|`cxf:serviceFactory` |The service factory for this endpoint to use. This can be supplied using
-the Spring `<bean class="MyServiceFactory"/>` syntax
-|=======================================================================
-
-You can find more advanced examples that show how to provide
-interceptors, properties and handlers on the CXF
-https://cwiki.apache.org/CXF20DOC/JAX-WS+Configuration[JAX-WS
-Configuration page].
-
-*NOTE*
- You can use cxf:properties to set the camel-cxf endpoint's dataFormat
-and setDefaultBus properties from spring configuration file.
-
-[source,xml]
--------------------------------------------------------------------------
-<cxf:cxfEndpoint id="testEndpoint" address="http://localhost:9000/router"
- serviceClass="org.apache.camel.component.cxf.HelloService"
- endpointName="s:PortName"
- serviceName="s:ServiceName"
- xmlns:s="http://www.example.com/test">
- <cxf:properties>
- <entry key="dataFormat" value="MESSAGE"/>
- <entry key="setDefaultBus" value="true"/>
- </cxf:properties>
- </cxf:cxfEndpoint>
--------------------------------------------------------------------------
-
-[[CXF-ConfiguringtheCXFEndpointswithApacheAriesBlueprint.]]
-Configuring the CXF Endpoints with Apache Aries Blueprint.
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Since camel 2.8 there is support for utilizing aries blueprint
-dependency injection for your CXF endpoints.
- The schema utilized is very similar to the spring schema so the
-transition is fairly transparent.
-
-Example
-
-[source,xml]
-------------------------------------------------------------------------------------------------------------------------------------
-<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.0.0"
- xmlns:camel-cxf="http://camel.apache.org/schema/blueprint/cxf"
- xmlns:cxfcore="http://cxf.apache.org/blueprint/core"
- xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
-
- <camel-cxf:cxfEndpoint id="routerEndpoint"
- address="http://localhost:9001/router"
- serviceClass="org.apache.servicemix.examples.cxf.HelloWorld">
- <camel-cxf:properties>
- <entry key="dataFormat" value="MESSAGE"/>
- </camel-cxf:properties>
- </camel-cxf:cxfEndpoint>
-
- <camel-cxf:cxfEndpoint id="serviceEndpoint"
- address="http://localhost:9000/SoapContext/SoapPort"
- serviceClass="org.apache.servicemix.examples.cxf.HelloWorld">
- </camel-cxf:cxfEndpoint>
-
- <camelContext xmlns="http://camel.apache.org/schema/blueprint">
- <route>
- <from uri="routerEndpoint"/>
- <to uri="log:request"/>
- </route>
- </camelContext>
-
-</blueprint>
-------------------------------------------------------------------------------------------------------------------------------------
-
-Currently the endpoint element is the first supported CXF
-namespacehandler.
-
-You can also use the bean references just as in spring
-
-[source,xml]
-----------------------------------------------------------------------------------------------------------------
-<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.0.0"
- xmlns:jaxws="http://cxf.apache.org/blueprint/jaxws"
- xmlns:cxf="http://cxf.apache.org/blueprint/core"
- xmlns:camel="http://camel.apache.org/schema/blueprint"
- xmlns:camelcxf="http://camel.apache.org/schema/blueprint/cxf"
- xsi:schemaLocation="
- http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd
- http://cxf.apache.org/blueprint/jaxws http://cxf.apache.org/schemas/blueprint/jaxws.xsd
- http://cxf.apache.org/blueprint/core http://cxf.apache.org/schemas/blueprint/core.xsd
- ">
-
- <camelcxf:cxfEndpoint id="reportIncident"
- address="/camel-example-cxf-blueprint/webservices/incident"
- wsdlURL="META-INF/wsdl/report_incident.wsdl"
- serviceClass="org.apache.camel.example.reportincident.ReportIncidentEndpoint">
- </camelcxf:cxfEndpoint>
-
- <bean id="reportIncidentRoutes" class="org.apache.camel.example.reportincident.ReportIncidentRoutes" />
-
- <camelContext xmlns="http://camel.apache.org/schema/blueprint">
- <routeBuilder ref="reportIncidentRoutes"/>
- </camelContext>
-
-</blueprint>
-----------------------------------------------------------------------------------------------------------------
-
-[[CXF-Howtomakethecamel-cxfcomponentuselog4jinsteadofjava.util.logging]]
-How to make the camel-cxf component use log4j instead of java.util.logging
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-CXF's default logger is `java.util.logging`. If you want to change it to
-log4j, proceed as follows. Create a file, in the classpath, named
-`META-INF/cxf/org.apache.cxf.logger`. This file should contain the
-fully-qualified name of the class,
-`org.apache.cxf.common.logging.Log4jLogger`, with no comments, on a
-single line.
-
-[[CXF-Howtoletcamel-cxfresponsemessagewithxmlstartdocument]]
-How to let camel-cxf response message with xml start document
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If you are using some SOAP client such as PHP, you will get this kind of
-error, because CXF doesn't add the XML start document "<?xml
-version="1.0" encoding="utf-8"?>"
-
-[source,java]
----------------------------------------------------------------------------------------
-Error:sendSms: SoapFault exception: [Client] looks like we got no XML document in [...]
----------------------------------------------------------------------------------------
-
-To resolved this issue, you just need to tell StaxOutInterceptor to
-write the XML start document for you.
-
-You can add a customer interceptor like this and configure it into you
-camel-cxf endpont
-
-Or adding a message header for it like this if you are using *Camel
-2.4*.
-
-[source,java]
--------------------------------------------------------------------
- // 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);
--------------------------------------------------------------------
-
-[[CXF-HowtooverridetheCXFproduceraddressfrommessageheader]]
-How to override the CXF producer address from message header
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The�`camel-cxf`�producer supports to override the services address by
-setting the message with the key of "CamelDestinationOverrideUrl".
-
-[source,java]
-----------------------------------------------------------------------------------------------
- // set up the service address from the message header to override the setting of CXF endpoint
- exchange.getIn().setHeader(Exchange.DESTINATION_OVERRIDE_URL, constant(getServiceAddress()));
-----------------------------------------------------------------------------------------------
-
-[[CXF-Howtoconsumeamessagefromacamel-cxfendpointinPOJOdataformat]]
-How to consume a message from a camel-cxf endpoint in POJO data format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The `camel-cxf` endpoint consumer POJO data format is based on the
-http://cwiki.apache.org/CXF20DOC/invokers.html[cxf invoker], so the
-message header has a property with the name of
-`CxfConstants.OPERATION_NAME` and the message body is a list of the SEI
-method parameters.
-
-[[CXF-Howtopreparethemessageforthecamel-cxfendpointinPOJOdataformat]]
-How to prepare the message for the camel-cxf endpoint in POJO data format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The `camel-cxf` endpoint producer is based on the
-https://svn.apache.org/repos/asf/cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/Client.java[cxf
-client API]. First you need to specify the operation name in the message
-header, then add the method parameters to a list, and initialize the
-message with this parameter list. The response message's body is a
-messageContentsList, you can get the result from that list.
-
-If you don't specify the operation name in the message header,
-`CxfProducer` will try to use the `defaultOperationName `from
-`CxfEndpoint`, if there is no `defaultOperationName` set on
-`CxfEndpoint`, it will pickup the first operationName from the Operation
-list.
-
-If you want to get the object array from the message body, you can get
-the body using `message.getbody(Object[].class)`, as follows:
-
-[[CXF-Howtodealwiththemessageforacamel-cxfendpointinPAYLOADdataformat]]
-How to deal with the message for a camel-cxf endpoint in PAYLOAD data format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-`PAYLOAD` means that you process the payload message from the SOAP
-envelope. You can use the `Header.HEADER_LIST` as the key to set or get
-the SOAP headers and use the `List<Element>` to set or get SOAP body
-elements.
- `Message.getBody()` will return an
-`org.apache.camel.component.cxf.CxfPayload` object, which has getters
-for SOAP message headers and Body elements. This change enables
-decoupling the native CXF message from the Camel message.
-
-[[CXF-HowtogetandsetSOAPheadersinPOJOmode]]
-How to get and set SOAP headers in POJO mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-`POJO` means that the data format is a "list of Java objects" when the
-Camel-cxf endpoint produces or consumes Camel exchanges. Even though
-Camel expose message body as POJOs in this mode, Camel-cxf still
-provides access to read and write SOAP headers. However, since CXF
-interceptors remove in-band SOAP headers from Header list after they
-have been processed, only out-of-band SOAP headers are available to
-Camel-cxf in POJO mode.
-
-The following example illustrate how to get/set SOAP headers. Suppose we
-have a route that forwards from one Camel-cxf endpoint to another. That
-is, SOAP Client -> Camel -> CXF service. We can attach two processors to
-obtain/insert SOAP headers at (1) before request goes out to the CXF
-service and (2) before response comes back to the SOAP Client. Processor
-(1) and (2) in this example are InsertRequestOutHeaderProcessor and
-InsertResponseOutHeaderProcessor. Our route looks like this:
-
-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.
-
-[[CXF-HowtogetandsetSOAPheadersinPAYLOADmode]]
-How to get and set SOAP headers in PAYLOAD mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-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").
-
-Once you obtain a CxfPayload object, you can invoke the
-CxfPayload.getHeaders() method that returns a List of DOM Elements (SOAP
-headers).
-
-Since Camel 2.16.0, you can also use the same way as described in
-sub-chapter "How to get and set SOAP headers in POJO mode" to set or get
-the SOAP headers. So, you can use now the
-header�"org.apache.cxf.headers.Header.list" to get and set a list of
-SOAP headers.This does also mean that if you have a route�that forwards
-from one Camel-cxf endpoint to another (SOAP Client -> Camel -> CXF
-service), now also the SOAP headers sent by the SOAP client are
-forwarded to the CXF service. If you do not want that these headers are
-forwarded you have to remove them in the Camel header
-"org.apache.cxf.headers.Header.list".
-
-[[CXF-SOAPheadersarenotavailableinMESSAGEmode]]
-SOAP headers are not available in MESSAGE mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-SOAP headers are not available in MESSAGE mode as SOAP processing is
-skipped.
-
-[[CXF-HowtothrowaSOAPFaultfromCamel]]
-How to throw a SOAP Fault from Camel
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If you are using a `camel-cxf` endpoint to consume the SOAP request, you
-may need to throw the SOAP Fault from the camel context. +
- Basically, you can use the `throwFault` DSL to do that; it works for
-`POJO`, `PAYLOAD` and `MESSAGE` data format. +
- You can define the soap fault like this
-
-Then throw it as you like
-
-If your CXF endpoint is working in the `MESSAGE` data format, you could
-set the the SOAP Fault message in the message body and set the response
-code in the message header.
-
-Same for using POJO data format. You can set the SOAPFault on the out
-body and also indicate it's a fault by calling Message.setFault(true):
-
-[[CXF-Howtopropagateacamel-cxfendpointrequestandresponsecontext]]
-How to propagate a camel-cxf endpoint's request and response context
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-https://svn.apache.org/repos/asf/cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/Client.java[cxf
-client API] provides a way to invoke the operation with request and
-response context. If you are using a `camel-cxf` endpoint producer to
-invoke the outside web service, you can set the request context and get
-response context with the following code:
-
-[source,java]
--------------------------------------------------------------------------------------------------------------
- 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());
--------------------------------------------------------------------------------------------------------------
-
-[[CXF-AttachmentSupport]]
-Attachment Support
-^^^^^^^^^^^^^^^^^^
-
-*POJO Mode:* Both SOAP with Attachment and MTOM are supported (see
-example in Payload Mode for enabling MTOM).� However, SOAP with
-Attachment is not tested.� Since attachments are marshalled and
-unmarshalled into POJOs, users typically do not need to deal with the
-attachment themself.� Attachments are propagated to Camel message's
-attachments if the MTOM is not enabled, since 2.12.3.� So, it is
-possible to retreive attachments by Camel Message API
-
-[source,java]
---------------------------------------------
-DataHandler Message.getAttachment(String id)
---------------------------------------------
-
-*Payload Mode:* MTOM is supported since 2.1. Attachments can be
-retrieved by Camel Message APIs mentioned above. SOAP with Attachment
-(SwA) is supported and attachments can be retrieved since 2.5. SwA is
-the default (same as setting the CXF endpoint property "mtom-enabled" to
-false).�
-
-To enable MTOM, set the CXF endpoint property "mtom-enabled" to _true_.
-(I believe you can only do it with Spring.)
-
-You can produce a Camel message with attachment to send to a CXF
-endpoint in Payload mode.
-
-You can also consume a Camel message received from a CXF endpoint in
-Payload mode.
-
-*Message Mode:* Attachments are not supported as it does not process the
-message at all.
-
-*CXF_MESSAGE Mode*: MTOM is supported, and Attachments can be retrieved
-by Camel Message APIs mentioned above. Note that when receiving a
-multipart (i.e. MTOM) message the default SOAPMessage to String
-converter will provide the complete multipart payload on the body. If
-you require just the SOAP XML as a String, you can set the message body
-with message.getSOAPPart(), and Camel convert can do the rest of work
-for you.
-
-[[CXF-StreamingSupportinPAYLOADmode]]
-Streaming Support in PAYLOAD mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-In 2.8.2, the camel-cxf component now supports streaming of incoming
-messages when using PAYLOAD mode. Previously, the incoming messages
-would have been completely DOM parsed. For large messages, this is time
-consuming and uses a significant amount of memory. Starting in 2.8.2,
-the incoming messages can remain as a javax.xml.transform.Source while
-being routed and, if nothing modifies the payload, can then be directly
-streamed out to the target destination. For common "simple proxy" use
-cases (example: from("cxf:...").to("cxf:...")), this can provide very
-significant performance increases as well as significantly lowered
-memory requirements.
-
-However, there are cases where streaming may not be appropriate or
-desired. Due to the streaming nature, invalid incoming XML may not be
-caught until later in the processing chain. Also, certain actions may
-require the message to be DOM parsed anyway (like WS-Security or message
-tracing and such) in which case the advantages of the streaming is
-limited. At this point, there are two ways to control the streaming:
-
-* Endpoint property: you can add "allowStreaming=false" as an endpoint
-property to turn the streaming on/off.
-
-* Component property: the CxfComponent object also has an allowStreaming
-property that can set the default for endpoints created from that
-component.
-
-Global system property: you can add a system property of
-"org.apache.camel.component.cxf.streaming" to "false" to turn if off.
-That sets the global default, but setting the endpoint property above
-will override this value for that endpoint.
-
-[[CXF-UsingthegenericCXFDispatchmode]]
-Using the generic CXF Dispatch mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-From 2.8.0, the camel-cxf component supports the generic
-https://cxf.apache.org/docs/jax-ws-dispatch-api.html[CXF dispatch
-mode]�that can transport messages of arbitrary structures (i.e., not
-bound to a specific XML schema). To use this mode, you simply omit
-specifying the wsdlURL and serviceClass attributes of the CXF endpoint.
-
-[source,xml]
--------------------------------------------------------------------------------------------
-<cxf:cxfEndpoint id="testEndpoint" address="http://localhost:9000/SoapContext/SoapAnyPort">
- <cxf:properties>
- <entry key="dataFormat" value="PAYLOAD"/>
- </cxf:properties>
- </cxf:cxfEndpoint>
--------------------------------------------------------------------------------------------
-
-It is noted that the default CXF dispatch client does not send a
-specific SOAPAction header. Therefore, when the target service requires
-a specific SOAPAction value, it is supplied in the Camel header using
-the key SOAPAction (case-insensitive).
-
-�
-
-[[CXF-SeeAlso]]
-See Also
-^^^^^^^^
-
-* link:configuring-camel.html[Configuring Camel]
-* link:component.html[Component]
-* link:endpoint.html[Endpoint]
-* link:getting-started.html[Getting Started]
-
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-cxf/src/main/docs/cxfrs-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cxf/src/main/docs/cxfrs-component.adoc b/components/camel-cxf/src/main/docs/cxfrs-component.adoc
new file mode 100644
index 0000000..06fa687
--- /dev/null
+++ b/components/camel-cxf/src/main/docs/cxfrs-component.adoc
@@ -0,0 +1,368 @@
+[[CXFRS-CXFRSComponent]]
+CXFRS Component
+~~~~~~~~~~~~~~~
+
+[Note]
+====
+
+
+When using CXF as a consumer, the link:cxf-bean-component.html[CXF Bean
+Component] allows you to factor out how message payloads are received
+from their processing as a RESTful or SOAP web service. This has the
+potential of using a multitude of transports to consume web services.
+The bean component's configuration is also simpler and provides the
+fastest method to implement web services using Camel and CXF.
+
+====
+
+The *cxfrs:* component provides integration with
+http://cxf.apache.org[Apache CXF] for connecting to JAX-RS 1.1 and 2.0
+services hosted in CXF.
+
+Maven users will need to add the following dependency to their pom.xml
+for this component:
+
+[source,xml]
+-------------------------------------------------------------------------------------
+<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>
+-------------------------------------------------------------------------------------
+
+[[CXFRS-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+-----------------------
+cxfrs://address?options
+-----------------------
+
+Where *address* represents the CXF endpoint's address
+
+[source,java]
+---------------------
+cxfrs:bean:rsEndpoint
+---------------------
+
+Where *rsEndpoint* represents the spring bean's name which presents the
+CXFRS client or server
+
+For either style above, you can append options to the URI as follows:
+
+[source,java]
+------------------------------------------------------------------
+cxfrs:bean:cxfEndpoint?resourceClasses=org.apache.camel.rs.Example
+------------------------------------------------------------------
+
+[[CXFRS-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The CXF-RS component supports 1 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+// endpoint options: START
+The CXF-RS component supports 29 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| beanId | common | | String | To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix.
+| address | common | | String | The service publish address.
+| features | common | | List | Set the feature list to the CxfRs endpoint.
+| loggingFeatureEnabled | common | false | boolean | This option enables CXF Logging Feature which writes inbound and outbound REST messages to log.
+| loggingSizeLimit | common | | int | To limit the total size of number of bytes the logger will output when logging feature has been enabled.
+| modelRef | common | | String | This option is used to specify the model file which is useful for the resource class without annotation. When using this option then the service class can be omitted to emulate document-only endpoints
+| providers | common | | String | Set custom JAX-RS provider(s) list to the CxfRs endpoint. You can specify a string with a list of providers to lookup in the registy separated by comma.
+| resourceClasses | common | | List | The resource classes which you want to export as REST service. Multiple classes can be separated by comma.
+| schemaLocations | common | | List | Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON.
+| skipFaultLogging | common | false | boolean | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches.
+| bindingStyle | consumer | Default | BindingStyle | Sets how requests and responses will be mapped to/from Camel. Two values are possible: SimpleConsumer: This binding style processes request parameters multiparts etc. and maps them to IN headers IN attachments and to the message body. It aims to eliminate low-level processing of org.apache.cxf.message.MessageContentsList. It also also adds more flexibility and simplicity to the response mapping. Only available for consumers. Default: The default style. For consumers this passes on a MessageContentsList to the route requiring low-level processing in the route. This is the traditional binding style which simply dumps the org.apache.cxf.message.MessageContentsList coming in from the CXF stack onto the IN message body. The user is then responsible for processing it according to the contract defined by the JAX-RS method signature. Custom: allows you to specify a custom binding through the binding option.
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| hostnameVerifier | producer | | HostnameVerifier | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry.
+| sslContextParameters | producer | | SSLContextParameters | The Camel SSL setting reference. Use the notation to reference the SSL Context.
+| throwExceptionOnFailure | producer | true | boolean | This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207.
+| httpClientAPI | producer (advanced) | true | boolean | If it is true the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false the CxfRsProducer will use the ProxyClientAPI to invoke the service
+| ignoreDeleteMethodMessageBody | producer (advanced) | false | boolean | This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API.
+| maxClientCacheSize | producer (advanced) | 10 | int | This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider.
+| binding | advanced | | CxfRsBinding | To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
+| bus | advanced | | Bus | To use a custom configured CXF Bus.
+| continuationTimeout | advanced | 30000 | long | This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport.
+| cxfRsEndpointConfigurer | advanced | | CxfRsEndpointConfigurer | This option could apply the implementation of org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configureServer/Client method of CxfEndpointConfigurer.
+| defaultBus | advanced | false | boolean | Will set the default bus when CXF endpoint create a bus by itself
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+| performInvocation | advanced | false | boolean | When the option is true Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing.
+| propagateContexts | advanced | false | boolean | When the option is true JAXRS UriInfo HttpHeaders Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties. These contexts can be used to analyze the current requests using JAX-RS API.
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+You can also configure the CXF REST endpoint through the spring
+configuration. Since there are lots of difference between the CXF REST
+client and CXF REST Server, we provide different configuration for
+them. Please check out the
+http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/schema/cxfEndpoint.xsd[schema
+file] and https://cwiki.apache.org/CXF20DOC/JAX-RS[CXF JAX-RS
+documentation] for more information.
+
+[[CXFRS-HowtoconfiguretheRESTendpointinCamel]]
+How to configure the REST endpoint in Camel
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In
+http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/schema/cxfEndpoint.xsd[camel-cxf
+schema file], there are two elements for the REST endpoint definition.
+*cxf:rsServer* for REST consumer, *cxf:rsClient* for REST producer. +
+ You can find a Camel REST service route configuration example here.
+
+[[CXFRS-HowtooverridetheCXFproduceraddressfrommessageheader]]
+How to override the CXF producer address from message header
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The�`camel-cxfrs`�producer supports to override the services address by
+setting the message with the key of "CamelDestinationOverrideUrl".
+
+[source,java]
+----------------------------------------------------------------------------------------------
+ // set up the service address from the message header to override the setting of CXF endpoint
+ exchange.getIn().setHeader(Exchange.DESTINATION_OVERRIDE_URL, constant(getServiceAddress()));
+----------------------------------------------------------------------------------------------
+
+[[CXFRS-ConsumingaRESTRequest-SimpleBindingStyle]]
+Consuming a REST Request - Simple Binding Style
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+*Available as of Camel 2.11*
+
+The `Default` binding style is rather low-level, requiring the user to
+manually process the `MessageContentsList` object coming into the route.
+Thus, it tightly couples the route logic with the method signature and
+parameter indices of the JAX-RS operation. Somewhat inelegant, difficult
+and error-prone.
+
+In contrast, the `SimpleConsumer` binding style performs the following
+mappings, in order to *make the request data more accessible* to you
+within the Camel Message:
+
+* JAX-RS Parameters (@HeaderParam, @QueryParam, etc.) are injected as IN
+message headers. The header name matches the value of the annotation.
+* The request entity (POJO or other type) becomes the IN message body.
+If a single entity cannot be identified in the JAX-RS method signature,
+it falls back to the original `MessageContentsList`.
+* Binary `@Multipart` body parts become IN message attachments,
+supporting `DataHandler`, `InputStream`, `DataSource` and CXF's
+`Attachment` class.
+* Non-binary `@Multipart` body parts are mapped as IN message headers.
+The header name matches the Body Part name.
+
+Additionally, the following rules apply to the *Response mapping*:
+
+* If the message body type is different to `javax.ws.rs.core.Response`
+(user-built response), a new `Response` is created and the message body
+is set as the entity (so long it's not null). The response status code
+is taken from the `Exchange.HTTP_RESPONSE_CODE` header, or defaults to
+200 OK if not present.
+* If the message body type is equal to `javax.ws.rs.core.Response`, it
+means that the user has built a custom response, and therefore it is
+respected and it becomes the final response.
+* In all cases, Camel headers permitted by custom or default
+`HeaderFilterStrategy` are added to the HTTP response.
+
+[[CXFRS-EnablingtheSimpleBindingStyle]]
+Enabling the Simple Binding Style
++++++++++++++++++++++++++++++++++
+
+This binding style can be activated by setting the `bindingStyle`
+parameter in the consumer endpoint to value `SimpleConsumer`:
+
+[source,java]
+---------------------------------------------------------
+ from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
+ .to("log:TEST?showAll=true");
+---------------------------------------------------------
+
+[[CXFRS-Examplesofrequestbindingwithdifferentmethodsignatures]]
+Examples of request binding with different method signatures
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Below is a list of method signatures along with the expected result from
+the Simple binding.
+
+*`public Response doAction(BusinessObject request);`* +
+ Request payload is placed in IN message body, replacing the original
+MessageContentsList.
+
+*`public Response doAction(BusinessObject request, @HeaderParam("abcd") String abcd, @QueryParam("defg") String defg);`*
+ Request payload placed in IN message body, replacing the original
+MessageContentsList. Both request params mapped as IN message headers
+with names abcd and defg.
+
+*`public Response doAction(@HeaderParam("abcd") String abcd, @QueryParam("defg") String defg);`*
+ Both request params mapped as IN message headers with names abcd and
+defg. The original MessageContentsList is preserved, even though it only
+contains the 2 parameters.
+
+*`public Response doAction(@Multipart(value="body1") BusinessObject request, @Multipart(value="body2") BusinessObject request2);`*
+ The first parameter is transferred as a header with name body1, and the
+second one is mapped as header body2. The original MessageContentsList
+is preserved as the IN message body.
+
+*`public Response doAction(InputStream abcd);`*
+ The InputStream is unwrapped from the MessageContentsList and preserved
+as the IN message body.
+
+*`public Response doAction(DataHandler abcd);`*
+ The DataHandler is unwrapped from the MessageContentsList and preserved
+as the IN message body.
+
+[[CXFRS-MoreexamplesoftheSimpleBindingStyle]]
+More examples of the Simple Binding Style
++++++++++++++++++++++++++++++++++++++++++
+
+Given a JAX-RS resource class with this method:
+
+[source,java]
+------------------------------------------------------------------------------------------------------------------------------------------------
+ @POST @Path("/customers/{type}")
+ public Response newCustomer(Customer customer, @PathParam("type") String type, @QueryParam("active") @DefaultValue("true") boolean active) {
+ return null;
+ }
+------------------------------------------------------------------------------------------------------------------------------------------------
+
+Serviced by the following route:
+
+[source,java]
+--------------------------------------------------------------------------------------------
+ from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
+ .recipientList(simple("direct:${header.operationName}"));
+
+ from("direct:newCustomer")
+ .log("Request: type=${header.type}, active=${header.active}, customerData=${body}");
+--------------------------------------------------------------------------------------------
+
+The following HTTP request with XML payload (given that the Customer DTO
+is JAXB-annotated):
+
+[source,xml]
+-------------------------------------
+POST /customers/gold?active=true
+
+Payload:
+<Customer>
+ <fullName>Raul Kripalani</fullName>
+ <country>Spain</country>
+ <project>Apache Camel</project>
+</Customer>
+-------------------------------------
+
+Will print the message:
+
+[source,xml]
+----------------------------------------------------------------------------------
+Request: type=gold, active=true, customerData=<Customer.toString() representation>
+----------------------------------------------------------------------------------
+
+For more examples on how to process requests and write responses can be
+found
+https://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/jaxrs/simplebinding/[here].
+
+[[CXFRS-ConsumingaRESTRequest-DefaultBindingStyle]]
+Consuming a REST Request - Default Binding Style
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The�https://cwiki.apache.org/CXF20DOC/JAX-RS[CXF JAXRS front end]
+implements the https://jsr311.java.net/[JAX-RS (JSR-311) API], so we can
+export the resources classes as a REST service. And we leverage the
+http://cwiki.apache.org/confluence/display/CXF20DOC/Invokers[CXF Invoker
+API] to turn a REST request into a normal Java object method
+invocation. +
+ Unlike the link:restlet.html[Camel Restlet]�component, you don't need
+to specify the URI template within your endpoint, CXF takes care of the
+REST request URI to resource class method mapping according to the
+JSR-311 specification. All you need to do in Camel is delegate this
+method request to a right processor or endpoint.
+
+Here is an example of a CXFRS route...
+
+And the corresponding resource class used to configure the endpoint...
+
+INFO:*Note about resource classes*
+
+By default, JAX-RS resource classes are *only*used to configure JAX-RS
+properties. Methods will *not* be executed during routing of messages to
+the endpoint. Instead, it is the responsibility of the route to do all
+processing.
+
+Note that starting from Camel 2.15 it is also sufficient to provide an
+interface only as opposed to a no-op service implementation class for
+the default mode.
+
+Starting from Camel 2.15, if a *performInvocation* option is enabled,
+the service implementation will be invoked first, the response will be
+set on the Camel exchange and the route execution will continue as
+usual. This can be useful for integrating the existing JAX-RS implementations into Camel routes and
+for post-processing JAX-RS Responses in custom processors.
+
+[[CXFRS-HowtoinvoketheRESTservicethroughcamel-cxfrsproducer]]
+How to invoke the REST service through camel-cxfrs producer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The�https://cwiki.apache.org/CXF20DOC/JAX-RS[CXF JAXRS front end]
+implements
+https://cwiki.apache.org/CXF20DOC/JAX-RS+Client+API#JAX-RSClientAPI-Proxy-basedAPI[a
+proxy-based client API], with this API you can invoke the remote REST
+service through a proxy. The�`camel-cxfrs` producer is based on this
+https://cwiki.apache.org/CXF20DOC/JAX-RS+Client+API#JAX-RSClientAPI-Proxy-basedAPI[proxy
+API]. +
+ You just need to specify the operation name in the message header and
+prepare the parameter in the message body, the camel-cxfrs�producer will
+generate right REST request for you.
+
+Here is an example:
+
+The�https://cwiki.apache.org/CXF20DOC/JAX-RS[CXF JAXRS front end] also
+provides
+https://cwiki.apache.org/confluence/display/CXF20DOC/JAX-RS+Client+API#JAX-RSClientAPI-CXFWebClientAPI[a
+http centric client API].�You can also invoke this API from
+`camel-cxfrs` producer. You need to specify the
+http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Exchange.html#HTTP_PATH[HTTP_PATH]
+and
+the�http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Exchange.html#HTTP_METHOD[HTTP_METHOD]�and
+let the�producer use the http centric client API by using the URI option
+*httpClientAPI* or by setting the message header
+http://camel.apache.org/maven/current/camel-cxf/apidocs/org/apache/camel/component/cxf/CxfConstants.html#CAMEL_CXF_RS_USING_HTTP_API[CxfConstants.CAMEL_CXF_RS_USING_HTTP_API].
+You can turn the response object to the type class specified with the
+message
+header�http://camel.apache.org/maven/current/camel-cxf/apidocs/org/apache/camel/component/cxf/CxfConstants.html#CAMEL_CXF_RS_RESPONSE_CLASS[CxfConstants.CAMEL_CXF_RS_RESPONSE_CLASS].
+
+From Camel 2.1, we also support to specify the query parameters from
+cxfrs URI for the CXFRS http centric client.
+
+Error formatting macro: snippet: java.lang.IndexOutOfBoundsException:
+Index: 20, Size: 20
+
+To support the Dynamical routing, you can override the URI's query
+parameters by using the CxfConstants.CAMEL_CXF_RS_QUERY_MAP header to
+set the parameter map for it.