You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ni...@apache.org on 2019/01/22 10:17:14 UTC
[camel] branch master updated: Updated the cxf-component document
links
This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new 39b1708 Updated the cxf-component document links
39b1708 is described below
commit 39b17083f56bc2e3bb74c62af6fe383fa4879fb7
Author: Willem Jiang <ji...@huawei.com>
AuthorDate: Tue Jan 22 18:16:20 2019 +0800
Updated the cxf-component document links
---
.../camel-cxf/src/main/docs/cxf-component.adoc | 97 +++++++++++-----------
1 file changed, 48 insertions(+), 49 deletions(-)
diff --git a/components/camel-cxf/src/main/docs/cxf-component.adoc b/components/camel-cxf/src/main/docs/cxf-component.adoc
index 0410e6b..f9f1c34 100644
--- a/components/camel-cxf/src/main/docs/cxf-component.adoc
+++ b/components/camel-cxf/src/main/docs/cxf-component.adoc
@@ -17,50 +17,50 @@ The *cxf:* component provides integration with
http://cxf.apache.org[Apache CXF] for connecting to http://cxf.apache.org/docs/jax-ws.html[JAX-WS] services
hosted in CXF.
-* link:#CXF-CXFComponent[CXF Component]
-** link:#CXF-URIformat[URI format]
-** link:#CXF-Options[Options]
-*** link:#CXF-Descriptionsofthedataformats[Descriptions of the
+* link:#cxf-component[CXF Component]
+** link:#uri-format[URI format]
+** link:#options[Options]
+*** link:#descriptions-of-the-dataformats[Descriptions of the
dataformats]
-**** link:#CXF-HowtoenableCXFLoggingOutInterceptorinMESSAGEmode[How to
+**** link:#how-to-enable-cxfs-loggingoutinterceptor-in-message-mode[How to
enable CXF's LoggingOutInterceptor in MESSAGE mode]
-*** link:#CXF-DescriptionofrelayHeadersoption[Description of
+*** link:#description-of-relayheaders-option[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
+**** link:#available-only-in-pojo-mode[Available only in POJO mode]
+**** link:#changes-since-release20[Changes since Release 2.0]
+** link:#configure-the-cxf-endpoints-with-spring[Configure the CXF
endpoints with Spring]
-** link:#CXF-ConfiguringtheCXFEndpointswithApacheAriesBlueprint.[Configuring
+** link:#configuring-the-cxf-endpoints-with-apache-aries-blueprint[Configuring
the CXF Endpoints with Apache Aries Blueprint.]
-** link:#CXF-Howtomakethecamel-cxfcomponentuselog4jinsteadofjava.util.logging[How
+** link:#how-to-make-the-camel-cxf-component-use-log4j-instead-of-javautillogging[How
to make the camel-cxf component use log4j instead of java.util.logging]
-** link:#CXF-Howtoletcamel-cxfresponsemessagewithxmlstartdocument[How to
+** link:#how-to-let-camel-cxf-response-message-with-xml-start-document[How to
let camel-cxf response message with xml start document]
-** link:#CXF-HowtooverridetheCXFproduceraddressfrommessageheader[How to
+** link:#how-to-override-the-cxf-producer-address-from-message-header[How to
override the CXF producer address from message header]
-** link:#CXF-Howtoconsumeamessagefromacamel-cxfendpointinPOJOdataformat[How
+** link:#how-to-consume-a-message-from-a-camel-cxf-endpoint-in-pojo-data-format[How
to consume a message from a camel-cxf endpoint in POJO data format]
-** link:#CXF-Howtopreparethemessageforthecamel-cxfendpointinPOJOdataformat[How
+** link:#how-to-prepare-the-message-for-the-camel-cxf-endpoint-in-pojo-data-format[How
to prepare the message for the camel-cxf endpoint in POJO data format]
-** link:#CXF-Howtodealwiththemessageforacamel-cxfendpointinPAYLOADdataformat[How
+** link:#how-to-deal-with-the-message-for-a-camel-cxf-endpoint-in-payload-dataformat[How
to deal with the message for a camel-cxf endpoint in PAYLOAD data
format]
-** link:#CXF-HowtogetandsetSOAPheadersinPOJOmode[How to get and set SOAP
+** link:#how-to-get-and-set-soap-headers-in-pojo-mode[How to get and set SOAP
headers in POJO mode]
-** link:#CXF-HowtogetandsetSOAPheadersinPAYLOADmode[How to get and set
+** link:#how-to-get-and-set-soap-headers-in-payload-mode[How to get and set
SOAP headers in PAYLOAD mode]
-** link:#CXF-SOAPheadersarenotavailableinMESSAGEmode[SOAP headers are
+** link:#soap-headers-are-not-available-in-message-mode[SOAP headers are
not available in MESSAGE mode]
-** link:#CXF-HowtothrowaSOAPFaultfromCamel[How to throw a SOAP Fault
+** link:#how-to-throw-a-soap-fault-from-camel[How to throw a SOAP Fault
from Camel]
-** link:#CXF-Howtopropagateacamel-cxfendpointrequestandresponsecontext[How
+** link:#how-to-propagate-a-camel-cxf-endpoints-request-and-response-context[How
to propagate a camel-cxf endpoint's request and response context]
-** link:#CXF-AttachmentSupport[Attachment Support]
-** link:#CXF-StreamingSupportinPAYLOADmode[Streaming Support in PAYLOAD
+** link:#attachment-support[Attachment Support]
+** link:#streaming-support-in-payload-mode[Streaming Support in PAYLOAD
mode]
-** link:#CXF-UsingthegenericCXFDispatchmode[Using the generic CXF
+** link:#using-the-generic-cxf-dispatch-mode[Using the generic CXF
Dispatch mode]
-** link:#CXF-SeeAlso[See Also]
+** link:#see-also[See Also]
Maven users must add the following dependency to their `pom.xml`
for this component:
@@ -219,7 +219,7 @@ above.
In Apache Camel, the Camel CXF component is the key to integrating routes with Web services. You can use the Camel CXF component to create a CXF endpoint, which can be used in either of the following ways:
* *Consumer* — (at the start of a route) represents a Web service instance, which integrates with the route. The type of payload injected into the route depends on the value of the endpoint's dataFormat option.
-* *Producer* — (at other points in the route) represents a WS client proxy, which converts the current exchange object into an operation invocation on a remote Web service. The format of the current exchange must match the endpoint's dataFormat setting.
+* *Producer* — (at other points in the route) represents a WS client proxy, which converts the current exchange object into an operation invocation on a remote Web service. The format of the current exchange must match the endpoint's dataFormat setting.
[width="100%",cols="50%,50%",options="header",]
|=======================================================================
@@ -249,8 +249,7 @@ exchange property, `CamelCXFDataFormat`. The exchange key constant is
defined in
`org.apache.camel.component.cxf.common.message.CxfConstants.DATA_FORMAT_PROPERTY`.
-[[CXF-HowtoenableCXFLoggingOutInterceptorinMESSAGEmode]]
-How to enable CXF's LoggingOutInterceptor in MESSAGE mode
+#### 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
@@ -263,9 +262,9 @@ following is an example.
-------------------------------------------------------------------------------------------------------
<bean id="loggingOutInterceptor" class="org.apache.cxf.interceptor.LoggingOutInterceptor">
<!-- it really should have been user-prestream but CXF does have such phase! -->
- <constructor-arg value="target/write"/>
+ <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>
@@ -295,8 +294,8 @@ 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
+
+#### 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
@@ -341,8 +340,8 @@ headers here:
https://github.com/apache/camel/blob/master/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/soap/headers/CxfMessageHeadersRelayTest.java[https://github.com/apache/camel/blob/master/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/soap/headers/CxfMessageHeadersRelayTest.java]
-[[CXF-ChangessinceRelease2.0]]
-Changes since Camel Release 2.0
+
+#### Changes since Camel 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
@@ -355,16 +354,16 @@ 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`.
+`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>
-------------------------------------------------------------------------------------------------------
@@ -373,7 +372,7 @@ Then, your endpoint can reference the `CxfHeaderFilterStrategy`.
[source,xml]
-------------------------------------------------------------------------------------------------------
<route>
- <from uri="cxf:bean:routerNoRelayEndpoint?headerFilterStrategy=#dropAllMessageHeadersStrategy"/>
+ <from uri="cxf:bean:routerNoRelayEndpoint?headerFilterStrategy=#dropAllMessageHeadersStrategy"/>
<to uri="cxf:bean:serviceNoRelayEndpoint?headerFilterStrategy=#dropAllMessageHeadersStrategy"/>
</route>
-------------------------------------------------------------------------------------------------------
@@ -390,8 +389,8 @@ defined Message Header Filters:
<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 -->
+
+ <!-- Add custom filter here -->
<bean class="org.apache.camel.component.cxf.soap.headers.CustomHeaderFilter"/>
</list>
</property>
@@ -404,19 +403,19 @@ 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`
+|`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`
+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`
+value is `false`, it will throw an exception
+ _Type_: `boolean`
_Default_: `false`
|=======================================================================
@@ -532,7 +531,7 @@ interceptors, properties and handlers on the CXF
http://cxf.apache.org/docs/jax-ws-configuration.html[JAX-WS
Configuration page].
-*NOTE*
+*NOTE*
You can use cxf:properties to set the camel-cxf endpoint's dataFormat
and setDefaultBus properties from spring configuration file.
@@ -553,7 +552,7 @@ and setDefaultBus properties from spring configuration file.
### 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.
+dependency injection for your CXF endpoints.
The schema utilized is very similar to the spring schema so the
transition is fairly transparent.
@@ -705,7 +704,7 @@ the body using `message.getbody(Object[].class)`, as follows:
`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.
+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