This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 37cc764a9a36eed18d55081cba4469df3348ea16 Author: Alexandros Koufoudakis <akoufouda...@gmail.com> AuthorDate: Mon Jun 24 19:19:40 2019 +0200 The rest of the components. https://issues.apache.org/jira/browse/CAMEL-13480 --- .../src/main/docs/telegram-component.adoc | 2 +- .../camel-test-cdi/src/main/docs/test-cdi.adoc | 2 - .../src/main/docs/test-spring.adoc | 8 +-- .../camel-timer/src/main/docs/timer-component.adoc | 8 +-- .../camel-twitter/src/main/docs/twitter.adoc | 8 +-- .../src/main/docs/undertow-component.adoc | 12 ++-- .../src/main/docs/validator-component.adoc | 18 +---- .../src/main/docs/velocity-component.adoc | 19 +++-- .../camel-vertx/src/main/docs/vertx-component.adoc | 6 +- .../camel-vm/src/main/docs/vm-component.adoc | 21 +----- .../src/main/docs/weather-component.adoc | 2 +- .../camel-web3j/src/main/docs/web3j-component.adoc | 2 +- .../src/main/docs/webhook-component.adoc | 2 +- .../src/main/docs/websocket-jsr356-component.adoc | 5 +- .../src/main/docs/websocket-component.adoc | 13 ++-- .../src/main/docs/xchange-component.adoc | 2 +- .../src/main/docs/secureXML-dataformat.adoc | 2 +- .../src/main/docs/xmlsecurity-component.adoc | 11 ++- .../camel-xmpp/src/main/docs/xmpp-component.adoc | 2 +- .../camel-xpath/src/main/docs/xpath-language.adoc | 8 +-- .../camel-xslt/src/main/docs/xslt-component.adoc | 83 ++-------------------- .../src/main/docs/json-xstream-dataformat.adoc | 5 +- .../src/main/docs/xstream-dataformat.adoc | 4 +- .../src/main/docs/yammer-component.adoc | 2 +- components/camel-zipkin/src/main/docs/zipkin.adoc | 2 +- .../src/main/docs/zookeeper-component.adoc | 4 +- 26 files changed, 64 insertions(+), 189 deletions(-) diff --git a/components/camel-telegram/src/main/docs/telegram-component.adoc b/components/camel-telegram/src/main/docs/telegram-component.adoc index 717b3ff..a5bfb36 100644 --- a/components/camel-telegram/src/main/docs/telegram-component.adoc +++ b/components/camel-telegram/src/main/docs/telegram-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.18* -The *Telegram* component provides access to the https://core.telegram.org/bots/api[Telegram Bot API]. +The Telegram component provides access to the https://core.telegram.org/bots/api[Telegram Bot API]. It allows a Camel-based application to send and receive messages by acting as a Bot, participating in direct conversations with normal users, private and public groups or channels. diff --git a/components/camel-test-cdi/src/main/docs/test-cdi.adoc b/components/camel-test-cdi/src/main/docs/test-cdi.adoc index aae3a9c..4328d5e 100644 --- a/components/camel-test-cdi/src/main/docs/test-cdi.adoc +++ b/components/camel-test-cdi/src/main/docs/test-cdi.adoc @@ -21,8 +21,6 @@ Camel: * JUnit 4 a| -*Available as of Camel 2.17* - The Camel CDI test module (`camel-test-cdi`) provides a JUnit runner that bootstraps a test environment using CDI so that you don't have to be familiar with any CDI testing frameworks and can concentrate on the diff --git a/components/camel-test-spring/src/main/docs/test-spring.adoc b/components/camel-test-spring/src/main/docs/test-spring.adoc index 52c160e..42647fd 100644 --- a/components/camel-test-spring/src/main/docs/test-spring.adoc +++ b/components/camel-test-spring/src/main/docs/test-spring.adoc @@ -18,7 +18,7 @@ We can use Spring for IoC and the Camel http://camel.apache.org/mock.html[Mock] |<<SpringTesting-CamelSpringTestSupport,CamelSpringTestSupport>> a| * JUnit 3.x (deprecated) * JUnit 4.x -* TestNG - *Camel 2.8* +* TestNG a| Provided by: @@ -60,8 +60,8 @@ a| * TestNG - None |<<SpringTesting-CamelEnhancedSpringTest,Camel Enhanced Spring Test>> a| -* JUnit 4.x - *Camel 2.10* -* TestNG - *Camel 2.10* +* JUnit 4.x +* TestNG a| Either: @@ -338,7 +338,7 @@ The test author is responsible for injecting the Camel contexts into the test an CamelContexts do not automatically start. a|CamelContexts do not automatically start. |org.apache.camel.test.spring.UseOverridePropertiesWithPropertiesComponent a|Method a| -*Camel 2.16*:Indicates that the annotated method returns a `java.util.Properties` for use in the test, and that those properties override any existing properties configured on the `PropertiesComponent`. a| +Indicates that the annotated method returns a `java.util.Properties` for use in the test, and that those properties override any existing properties configured on the `PropertiesComponent`. a| a|Override properties |======================================================================= diff --git a/components/camel-timer/src/main/docs/timer-component.adoc b/components/camel-timer/src/main/docs/timer-component.adoc index 1547bbb..4d7c430 100644 --- a/components/camel-timer/src/main/docs/timer-component.adoc +++ b/components/camel-timer/src/main/docs/timer-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.0* -The *timer:* component is used to generate message exchanges when a +The Timer component is used to generate message exchanges when a timer fires You can only consume events from this endpoint. === URI format @@ -28,8 +28,8 @@ See also the <<quartz-component,Quartz>> component that supports much more advanced scheduling. TIP:*Specify time in human friendly format* -In *Camel 2.3* onwards you can specify the time in -xref:how-do-i-specify-time-period-in-a-human-friendly-syntax.adoc[human +You can specify the time in +link:how-do-i-specify-time-period-in-a-human-friendly-syntax.adoc[human friendly syntax]. @@ -136,7 +136,7 @@ to the `Exchange`: |`Exchange.TIMER_FIRED_TIME` |`Date` |The time when the consumer fired. -|`Exchange.TIMER_COUNTER` |`Long` |*Camel 2.8:* The current fire counter. Starts from 1. +|`Exchange.TIMER_COUNTER` |`Long` |The current fire counter. Starts from 1. |=== === Sample diff --git a/components/camel-twitter/src/main/docs/twitter.adoc b/components/camel-twitter/src/main/docs/twitter.adoc index 20dad96..f25f233 100644 --- a/components/camel-twitter/src/main/docs/twitter.adoc +++ b/components/camel-twitter/src/main/docs/twitter.adoc @@ -2,7 +2,7 @@ *Available as of Camel version 2.10* -The camel-twitter consists of 4 components: +The Camel Twitter consists of 4 components: * <<twitter-directmessage-component,Twitter Direct Message>> * <<twitter-search-component,Twitter Search>> @@ -70,14 +70,14 @@ will be executed five times (one for each Status). |`CamelTwitterKeywords` |This header is used by the search producer to change the search key words dynamically. -|`CamelTwitterSearchLanguage` |*Camel 2.11.0:* This header can override +|`CamelTwitterSearchLanguage` |This header can override the option of `lang` which set the search language for the search endpoint dynamically -|`CamelTwitterCount` |*Camel 2.11.0* This header can override the option +|`CamelTwitterCount` |This header can override the option of `count` which sets the max twitters that will be returned. -|`CamelTwitterNumberOfPages` |*Camel 2.11.0* This header can override +|`CamelTwitterNumberOfPages` |This header can override the option of `numberOfPages` which sets how many pages we want to twitter returns. |======================================================================= diff --git a/components/camel-undertow/src/main/docs/undertow-component.adoc b/components/camel-undertow/src/main/docs/undertow-component.adoc index 0125f9d..f9287bd 100644 --- a/components/camel-undertow/src/main/docs/undertow-component.adoc +++ b/components/camel-undertow/src/main/docs/undertow-component.adoc @@ -3,15 +3,15 @@ *Available as of Camel version 2.16* -The *undertow* component provides HTTP and WebSocket based endpoints for consuming +The Undertow component provides HTTP and WebSocket based endpoints for consuming and producing HTTP/WebSocket requests. That is, the Undertow component behaves as a simple Web server. Undertow can also be used as a http client which mean you can also use it with Camel as a producer. -TIP: Since Camel version 2.21, the *undertow* component also supports WebSocket -connections and can thus serve as a drop-in replacement for Camel websocket +Since the component also supports WebSocket +connections, it can serve as a drop-in replacement for Camel websocket component or atmosphere-websocket component. Maven users will need to add the following dependency to their `pom.xml` @@ -155,10 +155,8 @@ The component supports 11 options, which are listed below. === Message Headers Camel uses the same message headers as the <<http-component,HTTP>> -component. - From Camel 2.2, it also uses -`Exchange.HTTP_CHUNKED,CamelHttpChunked` header to turn on or turn off -the chuched encoding on the camel-undertow consumer. +component. It also uses `Exchange.HTTP_CHUNKED,CamelHttpChunked` header to turn on or turn off +the chunked encoding on the camel-undertow consumer. Camel also populates *all* request.parameter and request.headers. For example, given a client request with the URL, diff --git a/components/camel-validator/src/main/docs/validator-component.adoc b/components/camel-validator/src/main/docs/validator-component.adoc index 2484b7b..147351b 100644 --- a/components/camel-validator/src/main/docs/validator-component.adoc +++ b/components/camel-validator/src/main/docs/validator-component.adoc @@ -34,21 +34,7 @@ system which contains the XSD to validate against. For example: * `msv:http://acme.com/cheese.xsd` * `validator:com/mypackage/myschema.xsd` -Maven users will need to add the following dependency to their `pom.xml` -for this component when using *Camel 2.8* or older: - -[source,xml] ----- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-spring</artifactId> - <version>x.x.x</version> - <!-- use the same version as your Camel core version --> -</dependency> ----- - -From Camel 2.9 onwards the Validation component is -provided directly in the camel-core. +The Validation component is provided directly in the camel-core. === Options @@ -148,7 +134,7 @@ supplied on the classpath). === Advanced: JMX method clearCachedSchema -Since *Camel 2.17*, you can force that the cached schema in the +You can force that the cached schema in the validator endpoint is cleared and reread with the next process call with the JMX operation `clearCachedSchema`. You can also use this method to programmatically clear the cache. This method is available on the diff --git a/components/camel-velocity/src/main/docs/velocity-component.adoc b/components/camel-velocity/src/main/docs/velocity-component.adoc index d0dd99a..27b7254 100644 --- a/components/camel-velocity/src/main/docs/velocity-component.adoc +++ b/components/camel-velocity/src/main/docs/velocity-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.2* -The *velocity:* component allows you to process a message using an +The Velocity component allows you to process a message using an http://velocity.apache.org/[Apache Velocity] template. This can be ideal when using Templating to generate responses for requests. @@ -124,10 +124,7 @@ The component supports 4 options, which are listed below. ### Message Headers -The velocity component sets a couple headers on the message (you can't -set these yourself and from Camel 2.1 velocity component will not set -these headers which will cause some side effect on the dynamic template -support): +You can use the following headers on the message: [width="100%",cols="10%,90%",options="header",] |======================================================================= @@ -135,7 +132,7 @@ support): |`CamelVelocityResourceUri` |The *templateName* as a `String` object. -|`CamelVelocitySupplementalContext` |*Camel 2.16:* To add additional information to the used VelocityContext. +|`CamelVelocitySupplementalContext` |To add additional information to the used VelocityContext. The value of this header should be a `Map` with key/values that will added (override any existing key with the same name). + This can be used to pre setup some common key/values you want to reuse @@ -184,7 +181,7 @@ Camel will provide exchange information in the Velocity context (just a |`response` |The Out message (only for InOut message exchange pattern). |======================================================================= -Since Camel-2.14, you can setup a custom Velocity Context yourself by +You can setup a custom Velocity Context yourself by setting the message header *CamelVelocityContext *just like this [source,java] @@ -215,10 +212,10 @@ resource. This allows you to provide a dynamic template at runtime. |======================================================================= |Header |Type |Description -|CamelVelocityResourceUri |String |*Camel 2.1:* A URI for the template resource to use instead of the +|CamelVelocityResourceUri |String |A URI for the template resource to use instead of the endpoint configured. -|CamelVelocityTemplate |String |*Camel 2.1:* The template to use instead of the endpoint configured. +|CamelVelocityTemplate |String |The template to use instead of the endpoint configured. |======================================================================= ### Samples @@ -263,7 +260,7 @@ from("activemq:My.Queue"). to("activemq:Another.Queue"); ----------------------------------------------------------------- -In *Camel 2.1* it's possible to specify what template the component +It's possible to specify what template the component should use dynamically via a header, so for example: [source,java] @@ -273,7 +270,7 @@ from("direct:in"). to("velocity:dummy"); --------------------------------------------------------------------------- -In *Camel 2.1* it's possible to specify a template directly as a header +It's possible to specify a template directly as a header the component should use dynamically via a header, so for example: [source,java] diff --git a/components/camel-vertx/src/main/docs/vertx-component.adoc b/components/camel-vertx/src/main/docs/vertx-component.adoc index 04a3892..23e1d8b 100644 --- a/components/camel-vertx/src/main/docs/vertx-component.adoc +++ b/components/camel-vertx/src/main/docs/vertx-component.adoc @@ -3,13 +3,13 @@ *Available as of Camel version 2.12* -The *vertx* component is for working with the http://vertx.io/[Vertx] +The Vert.x component is for working with the http://vertx.io/[Vertx] https://vertx.io/docs/vertx-core/java/#event_bus[EventBus]. The vertx https://vertx.io/docs/vertx-core/java/#event_bus[EventBus] sends and receives JSON events. -NOTE: From *Camel 2.16* onwards vertx 3 is in use which requires Java 1.8 at +NOTE: The version of Vert.x, used by the component, requires at least Java 1.8 at runtime. Maven users will need to add the following dependency to their `pom.xml` @@ -129,7 +129,7 @@ The component supports 9 options, which are listed below. -*Camel 2.12.3:* Whether to use publish/subscribe instead of point to +Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint. ----------------------------------------------------------------------------------------------- diff --git a/components/camel-vm/src/main/docs/vm-component.adoc b/components/camel-vm/src/main/docs/vm-component.adoc index 83fe36b..26bdec2 100644 --- a/components/camel-vm/src/main/docs/vm-component.adoc +++ b/components/camel-vm/src/main/docs/vm-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.1* -The *vm:* component provides asynchronous +The VM component provides asynchronous http://www.eecs.harvard.edu/~mdw/proj/seda/[SEDA] behavior, exchanging messages on a http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/BlockingQueue.html[BlockingQueue] @@ -30,24 +30,7 @@ camel-core.jar) You can append query options to the URI in the following format: `?option=value&option=value&...` -An exactly identical <<vm-component,VM>> endpoint URI *must* be used for -both the producer and the consumer endpoint. Otherwise, Camel will -create a second <<vm-component,VM>> endpoint despite that the `queueName` -portion of the URI is identical. For example: - -[source,java] ----- -from("direct:foo").to("vm:bar?concurrentConsumers=5"); - -from("vm:bar?concurrentConsumers=5").to("file://output"); ----- - -Notice that we have to use the full URI, including options in both the -producer and consumer. - -In Camel 2.4 this has been fixed so that only the queue name must match. -Using the queue name `bar`, we could rewrite the previous exmple as -follows: +It is sufficient to list all the options for a consumer endpoint only. [source,java] ---- diff --git a/components/camel-weather/src/main/docs/weather-component.adoc b/components/camel-weather/src/main/docs/weather-component.adoc index 95169ad..7842548 100644 --- a/components/camel-weather/src/main/docs/weather-component.adoc +++ b/components/camel-weather/src/main/docs/weather-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.12* -The *weather:* component is used for polling weather information from +The Weather component is used for polling weather information from http://openweathermap.org[Open Weather Map] - a site that provides free global weather and forecast information. The information is returned as a json String object. diff --git a/components/camel-web3j/src/main/docs/web3j-component.adoc b/components/camel-web3j/src/main/docs/web3j-component.adoc index b93d31f..92dd8bf 100644 --- a/components/camel-web3j/src/main/docs/web3j-component.adoc +++ b/components/camel-web3j/src/main/docs/web3j-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.22* -The *Ethereum* blockchain component uses the +The Ethereum blockchain component uses the https://github.com/web3j/web3j[web3j] client API and allows you to interact with Ethereum compatible nodes such as https://github.com/ethereum/go-ethereum/wiki/geth[Geth], https://github.com/paritytech/parity[Parity], https://github.com/jpmorganchase/quorum/wiki[Quorum], https://infura.io[Infura], etc. diff --git a/components/camel-webhook/src/main/docs/webhook-component.adoc b/components/camel-webhook/src/main/docs/webhook-component.adoc index 9752743..270daa7 100644 --- a/components/camel-webhook/src/main/docs/webhook-component.adoc +++ b/components/camel-webhook/src/main/docs/webhook-component.adoc @@ -4,7 +4,7 @@ *Available as of Camel version 3.0* -The *Webhook* meta component allows other Camel components to configure webhooks on a remote webhook provider and +The Webhook meta component allows other Camel components to configure webhooks on a remote webhook provider and listening for them. .The following components currently provide webhook endpoints: diff --git a/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc b/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc index e50213a..c2629e9 100644 --- a/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc +++ b/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc @@ -1,12 +1,9 @@ [[websocket-jsr356-component]] == Javax Websocket Component -*Available as of Camel version 2.23* -*Available as of Camel version 2.23* - *Available as of Camel version 2.23* -The *jsr356* component provides websocket +The JSR356 component provides websocket endpoints for communicating with clients using JSR356 (javax). diff --git a/components/camel-websocket/src/main/docs/websocket-component.adoc b/components/camel-websocket/src/main/docs/websocket-component.adoc index 9e927d9..6c1c716 100644 --- a/components/camel-websocket/src/main/docs/websocket-component.adoc +++ b/components/camel-websocket/src/main/docs/websocket-component.adoc @@ -3,18 +3,13 @@ *Available as of Camel version 2.10* -The *websocket* component provides websocket +The WebSocket component provides websocket endpoints for communicating with clients using websocket. The component uses Eclipse Jetty Server which implements the http://tools.ietf.org/html/rfc6455[IETF] specification (drafts and RFC 6455). It supports the protocols ws:// and wss://. To use wss:// protocol, the SSLContextParameters must be defined. - -*Version currently supported* - -Camel 2.18 uses Jetty 9 - ### URI format [source,java] @@ -165,7 +160,7 @@ The component supports 16 options, which are listed below. ### Message Headers -The websocket component uses 2 headers to indicate to either send +The WebSocket component uses 2 headers to indicate to either send messages back to a single/current client, or to all clients. [width="100%",cols="10%,90%",options="header",] @@ -210,8 +205,8 @@ from("activemq:topic:newsTopic") #### Using the JSSE Configuration Utility -As of Camel 2.10, the WebSocket component supports SSL/TLS configuration -through the xref:camel-configuration-utilities.adoc[Camel JSSE +The WebSocket component supports SSL/TLS configuration +through the link:camel-configuration-utilities.adoc[Camel JSSE Configuration Utility]. This utility greatly decreases the amount of component specific code you need to write and is configurable at the endpoint and component levels. The following examples demonstrate how diff --git a/components/camel-xchange/src/main/docs/xchange-component.adoc b/components/camel-xchange/src/main/docs/xchange-component.adoc index c213acb..3089782 100644 --- a/components/camel-xchange/src/main/docs/xchange-component.adoc +++ b/components/camel-xchange/src/main/docs/xchange-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.21* -The *xchange:* component uses the https://knowm.org/open-source/xchange/[XChange] Java library to provide access to 60+ Bitcoin and Altcoin exchanges. +The XChange component uses the https://knowm.org/open-source/xchange/[XChange] Java library to provide access to 60+ Bitcoin and Altcoin exchanges. It comes with a consistent interface for trading and accessing market data. Camel can get crypto currency market data, query historical data, place market orders and much more. diff --git a/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc b/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc index a1f6c7a..1770f53 100644 --- a/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc +++ b/components/camel-xmlsecurity/src/main/docs/secureXML-dataformat.adoc @@ -65,7 +65,7 @@ The XML Security dataformat supports 13 options, which are listed below. #### Key Cipher Algorithm -As of Camel 2.12.0, the default Key Cipher Algorithm is now +The default Key Cipher Algorithm is now XMLCipher.RSA_OAEP instead of XMLCipher.RSA_v1dot5. Usage of XMLCipher.RSA_v1dot5 is discouraged due to various attacks. Requests that use RSA v1.5 as the key cipher algorithm will be rejected unless it diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc index 0c2573b..a934814 100644 --- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc +++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc @@ -21,7 +21,7 @@ will first try to use the Apache Santuario provider; if it does not find the Santuario provider, it will use the JDK provider. Further, the implementation is DOM based. -Since Camel 2.15.0 we also provide support for *XAdES-BES/EPES* for the +We also provide support for *XAdES-BES/EPES* for the signer endpoint; see subsection "XAdES-BES/EPES for the Signer Endpoint". @@ -50,8 +50,7 @@ http://www.w3.org/TR/xmldsig-core1/#def-SignatureEnveloping[enveloping] XML signature case, the XML Signature contains the signed content. All other cases are called http://www.w3.org/TR/xmldsig-core1/#def-SignatureDetached[detached] XML -signatures. A certain form of detached XML signature is supported since -**2.14.0**. +signatures. In the *enveloped XML signature* case, the supported generated XML signature has the following structure (Variables are surrounded by `[]`). @@ -108,7 +107,7 @@ signature has the structure: </Signature> ---- -As of 2.14.0 *detached XML signatures* with the following structure +*Detached XML signatures* with the following structure are supported (see also sub-chapter XML Signatures as Siblings of Signed Elements): @@ -161,7 +160,7 @@ body of the in-message which can be either a XML document or a plain text. The enveloped, enveloping, or detached (as of 12.14) XML signature(s) will be set to the body of the out-message. * With the verifier endpoint, you can validate an enveloped or -enveloping XML signature or even several detached (as of 2.14.0) XML +enveloping XML signature or even several detached XML signatures contained in the body of the in-message; if the validation is successful, then the original content is extracted from the XML signature and set to the body of the out-message. @@ -476,8 +475,6 @@ or the structure: ### Detached XML Signatures as Siblings of the Signed Elements -**Since 2.14.0** - You can create detached signatures where the signature is a sibling of the signed element. The following example contains two detached signatures. The first signature is for the element `C` and the second diff --git a/components/camel-xmpp/src/main/docs/xmpp-component.adoc b/components/camel-xmpp/src/main/docs/xmpp-component.adoc index a7244a8..806c5a1 100644 --- a/components/camel-xmpp/src/main/docs/xmpp-component.adoc +++ b/components/camel-xmpp/src/main/docs/xmpp-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.0* -The *xmpp:* component implements an XMPP (Jabber) transport. +The XMPP component implements an XMPP (Jabber) transport. Maven users will need to add the following dependency to their `pom.xml` for this component: diff --git a/components/camel-xpath/src/main/docs/xpath-language.adoc b/components/camel-xpath/src/main/docs/xpath-language.adoc index 190d1a3..e4c6fff 100644 --- a/components/camel-xpath/src/main/docs/xpath-language.adoc +++ b/components/camel-xpath/src/main/docs/xpath-language.adoc @@ -76,7 +76,7 @@ namespace is `http://camel.apache.org/schema/spring`. |http://camel.apache.org/xml/out/[http://camel.apache.org/xml/out/] |out |Message |the exchange.out message -|http://camel.apache.org/xml/function/[http://camel.apache.org/xml/function/] |functions |Object |*Camel 2.5:* Additional functions +|http://camel.apache.org/xml/function/[http://camel.apache.org/xml/function/] |functions |Object |Additional functions |http://camel.apache.org/xml/variables/environment-variables[http://camel.apache.org/xml/variables/environment-variables] |env |Object |OS environment variables @@ -124,10 +124,10 @@ exchange: |out:header |the header name |Object |Will return the *out* message header. -|function:properties |key for property |String |*Camel 2.5:* To lookup a property using the +|function:properties |key for property |String |To lookup a property using the <<properties-component,Properties>> component (property placeholders). -|function:simple |simple expression |Object |*Camel 2.5:* To evaluate a <<simple-language,Simple>> expression. +|function:simple |simple expression |Object |To evaluate a <<simple-language,Simple>> expression. |=== CAUTION: `function:properties` and `function:simple` is not supported @@ -136,8 +136,6 @@ Splitter EIP. Here's an example showing some of these functions in use. -And the new functions introduced in Camel 2.5: - === Using XML configuration If you prefer to configure your routes in your Spring diff --git a/components/camel-xslt/src/main/docs/xslt-component.adoc b/components/camel-xslt/src/main/docs/xslt-component.adoc index 2439dcf..2ec0fc3 100644 --- a/components/camel-xslt/src/main/docs/xslt-component.adoc +++ b/components/camel-xslt/src/main/docs/xslt-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.3* -The *xslt:* component allows you to process a message using an +The XSLT component allows you to process a message using an http://www.w3.org/TR/xslt[XSLT] template. This can be ideal when using Templating to generate respopnses for requests. @@ -35,21 +35,7 @@ Documentation] for more detail of the URI syntax. |xslt:http://acme.com/cheese/foo.xsl|Refers to the remote http resource |================================================================= -For *Camel 2.8* or older, 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-spring</artifactId> - <version>x.x.x</version> - <!-- use the same version as your Camel core version --> -</dependency> ----- - -From *Camel 2.9* onwards the <<xslt-component,XSLT>> component is provided -directly in the camel-core. +The <<xslt-component,XSLT>> component is provided directly in the camel-core. === Options @@ -225,19 +211,7 @@ Spring XML]. === Using xsl:include -*Camel 2.2 or older* + -If you use `xsl:include` in your XSL files in *Camel 2.2 or older*, the default `javax.xml.transform.URIResolver` is used. Files will be resolved relative to the -JVM starting folder. - -For example the following include statement will look up the `staff_template.xsl` file starting from the folder where the application was started. - -[source,xml] ----- -<xsl:include href="staff_template.xsl"/> ----- - -*Camel 2.3 or newer* + - For Camel 2.3 or newer, Camel provides its own implementation of `URIResolver`. This allows +Camel provides its own implementation of `URIResolver`. This allows Camel to load included files from the classpath. For example the include file in the following code will be located relative to the starting endpoint. @@ -264,10 +238,7 @@ You can also refer backwards in the include paths. In the following example, the === Using xsl:include and default prefix -In *Camel 2.10.3 and older*, `classpath:` is used as the default prefix. + -If you configure the starting resource to load using `file:` then all subsequent incudes will have to be prefixed with `file:`. - -From *Camel 2.10.4*, Camel will use the prefix from the endpoint configuration as the default prefix. +Camel will use the prefix from the endpoint configuration as the default prefix. You can explicitly specify `file:` or `classpath:` loading. The two loading types can be mixed in a XSLT script, if necessary. @@ -317,16 +288,11 @@ To provide a dynamic stylesheet at runtime you can define a dynamic URI. See xref:how-to-use-a-dynamic-uri-in-to.adoc[How to use a dynamic URI in to()] for more information. -*Available as of Camel 2.9 (removed in 2.11.4, 2.12.3 and 2.13.0)* + - Camel provides the `CamelXsltResourceUri` header which you can use to -define an alternative stylesheet to that configured on the endpoint -URI. This allows you to provide a dynamic stylesheet at runtime. - === Accessing warnings, errors and fatalErrors from XSLT ErrorListener *Available as of Camel 2.14* -From *Camel 2.14*, any warning/error or fatalError is stored on +Any warning/error or fatalError is stored on the current Exchange as a property with the keys `Exchange.XSLT_ERROR`, `Exchange.XSLT_FATAL_ERROR`, or `Exchange.XSLT_WARNING` which allows end users to get hold of any @@ -356,45 +322,6 @@ xsl:message. The exception is stored on the Exchange as a warning with the key `Exchange.XSLT_WARNING.` -=== Notes on using XSLT and Java Versions - -Here are some observations from Sameer, a Camel user, which he kindly -shared with us: - -In case anybody faces issues with the XSLT endpoint please review these -points. - -I was trying to use an xslt endpoint for a simple transformation from -one xml to another using a simple xsl. The output xml kept appearing -(after the xslt processor in the route) with outermost xml tag with no -content within. - -No explanations show up in the DEBUG logs. On the TRACE logs however I -did find some error/warning indicating that the XMLConverter bean could -no be initialized. - -After a few hours of cranking my mind, I had to do the following to get -it to work (thanks to some posts on the users forum that gave some -clue): - -1. Use the transformerFactory option in the route -`("xslt:my-transformer.xsl?transformerFactory=tFactory")` with the -`tFactory` bean having bean defined in the spring context for -`class="org.apache.xalan.xsltc.trax.TransformerFactoryImpl"`. + -2. Added the Xalan jar into my maven pom. - -My guess is that the default xml parsing mechanism supplied within the -JDK (I am using 1.6.0_03) does not work right in this context and does -not throw up any error either. When I switched to Xalan this way it -works. This is not a Camel issue, but might need a mention on the xslt -component page. - -Another note, jdk 1.6.0_03 ships with JAXB 2.0 while Camel needs 2.1. -One workaround is to add the 2.1 jar to the `jre/lib/endorsed` directory -for the jvm or as specified by the container. - -Hope this post saves newbie Camel riders some time. - === See Also * Configuring Camel diff --git a/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc b/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc index bb18363..b04cfef 100644 --- a/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc +++ b/components/camel-xstream/src/main/docs/json-xstream-dataformat.adoc @@ -103,7 +103,7 @@ available to the JRE. ### How to set the XML encoding in Xstream DataFormat? -From Camel 2.2.0, you can set the encoding of XML in Xstream DataFormat +You can set the encoding of XML in Xstream DataFormat by setting the Exchange's property with the key `Exchange.CHARSET_NAME`, or setting the encoding property on Xstream from DSL or Spring config. @@ -118,8 +118,7 @@ from("activemq:My.Queue"). In Camel, one can always use its own processing step in the route to filter and block certain XML documents to be routed to the XStream's -unmarhall step. From Camel 2.16.1, 2.15.5, you can -set http://x-stream.github.io/security.html[XStream's type +unmarhall step. You can set http://x-stream.github.io/security.html[XStream's type permissions] to automatically allow or deny the instantiation of certain types. diff --git a/components/camel-xstream/src/main/docs/xstream-dataformat.adoc b/components/camel-xstream/src/main/docs/xstream-dataformat.adoc index 2673753..0d40f9f 100644 --- a/components/camel-xstream/src/main/docs/xstream-dataformat.adoc +++ b/components/camel-xstream/src/main/docs/xstream-dataformat.adoc @@ -150,7 +150,7 @@ available to the JRE. ### How to set the XML encoding in Xstream DataFormat? -From Camel 2.2.0, you can set the encoding of XML in Xstream DataFormat +You can set the encoding of XML in Xstream DataFormat by setting the Exchange's property with the key `Exchange.CHARSET_NAME`, or setting the encoding property on Xstream from DSL or Spring config. @@ -165,7 +165,7 @@ from("activemq:My.Queue"). In Camel, one can always use its own processing step in the route to filter and block certain XML documents to be routed to the XStream's -unmarhall step. From Camel 2.16.1, 2.15.5, you can +unmarhall step. You can set http://x-stream.github.io/security.html[XStream's type permissions] to automatically allow or deny the instantiation of certain types. diff --git a/components/camel-yammer/src/main/docs/yammer-component.adoc b/components/camel-yammer/src/main/docs/yammer-component.adoc index 3ad7a0a..3cdc503 100644 --- a/components/camel-yammer/src/main/docs/yammer-component.adoc +++ b/components/camel-yammer/src/main/docs/yammer-component.adoc @@ -198,7 +198,7 @@ and topics that the user is following. |yammer:private?[options] |Private messages received by the user. |yammer:received?[options] -|*Camel 2.12.1:* All messages received by the user +|All messages received by the user |======================================================================= diff --git a/components/camel-zipkin/src/main/docs/zipkin.adoc b/components/camel-zipkin/src/main/docs/zipkin.adoc index 03f70c2..face070 100644 --- a/components/camel-zipkin/src/main/docs/zipkin.adoc +++ b/components/camel-zipkin/src/main/docs/zipkin.adoc @@ -3,7 +3,7 @@ *Available as of Camel 2.18* -The camel-zipkin component is used for tracing and timing incoming and +The Camel Zipkin component is used for tracing and timing incoming and outgoing Camel messages using http://zipkin.io/[zipkin]. Events (span) are captured for incoming and outgoing messages being sent diff --git a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc index 6518198..3438120 100644 --- a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc +++ b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc @@ -202,7 +202,7 @@ endpoint await its creation: from("zookeeper://localhost:39913/somepath/somenode?awaitCreation=true").to("mock:result"); ---- -#### Reading from a _znode_ (additional Camel 2.10 onwards) +#### Reading from a _znode_ When data is read due to a `WatchedEvent` received from the ZooKeeper ensemble, the `CamelZookeeperEventType` header holds ZooKeeper's @@ -248,7 +248,7 @@ from("direct:create-and-write-to-znode") .to("zookeeper://localhost:39913/somepath/somenode?create=true"); ---- -Starting *version 2.11* it is also possible to *delete* a node using the +It is also possible to *delete* a node using the header `CamelZookeeperOperation` by setting it to `DELETE`: [source,java]