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 b81fb605317a5446b1c1d0378a1a139035efcb31 Author: Alexandros Koufoudakis <akoufouda...@gmail.com> AuthorDate: Mon Jun 24 14:12:32 2019 +0200 Components "s". https://issues.apache.org/jira/browse/CAMEL-13480 --- .../camel-saga/src/main/docs/saga-component.adoc | 2 +- .../src/main/docs/salesforce-component.adoc | 2 +- .../src/main/docs/sap-netweaver-component.adoc | 2 +- .../src/main/docs/xquery-component.adoc | 2 - .../src/main/docs/scheduler-component.adoc | 2 +- .../camel-seda/src/main/docs/seda-component.adoc | 12 +----- .../src/main/docs/servicenow-component.adoc | 2 +- .../src/main/docs/servlet-component.adoc | 14 +++---- components/camel-shiro/src/main/docs/shiro.adoc | 16 +++----- .../camel-sip/src/main/docs/sip-component.adoc | 2 +- .../camel-slack/src/main/docs/slack-component.adoc | 2 +- .../camel-smpp/src/main/docs/smpp-component.adoc | 44 ++++++++------------- .../camel-snmp/src/main/docs/snmp-component.adoc | 4 +- .../src/main/docs/soapjaxb-dataformat.adoc | 7 +--- .../camel-solr/src/main/docs/solr-component.adoc | 8 ++-- .../src/main/docs/soroush-component.adoc | 2 +- .../src/main/docs/splunk-component.adoc | 2 +- .../src/main/docs/spring-batch-component.adoc | 4 +- .../src/main/docs/spring-boot.adoc | 7 +--- .../main/docs/spring-integration-component.adoc | 2 +- .../src/main/docs/spring-javaconfig.adoc | 13 ++----- .../src/main/docs/spring-ldap-component.adoc | 2 +- .../src/main/docs/spring-redis-component.adoc | 3 +- .../src/main/docs/spring-security.adoc | 6 +-- .../src/main/docs/spring-ws-component.adoc | 12 +++--- .../camel-spring/src/main/docs/spel-language.adoc | 2 +- .../src/main/docs/spring-event-component.adoc | 2 +- components/camel-spring/src/main/docs/spring.adoc | 26 +++---------- .../camel-sql/src/main/docs/sql-component.adoc | 45 ++++++++-------------- .../src/main/docs/sql-stored-component.adoc | 2 +- .../camel-ssh/src/main/docs/ssh-component.adoc | 3 +- .../camel-stax/src/main/docs/stax-component.adoc | 5 +-- .../camel-stomp/src/main/docs/stomp-component.adoc | 2 +- .../src/main/docs/stream-component.adoc | 4 +- .../src/main/docs/string-template-component.adoc | 7 ++-- .../camel-stub/src/main/docs/stub-component.adoc | 2 +- .../src/main/docs/swagger-java.adoc | 9 +---- .../src/main/docs/syslog-dataformat.adoc | 10 ++--- 38 files changed, 101 insertions(+), 192 deletions(-) diff --git a/components/camel-saga/src/main/docs/saga-component.adoc b/components/camel-saga/src/main/docs/saga-component.adoc index c372da0..4008799 100644 --- a/components/camel-saga/src/main/docs/saga-component.adoc +++ b/components/camel-saga/src/main/docs/saga-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.21* -The *saga* component provides a bridge to execute custom actions within a route using the Saga EIP. +The Saga component provides a bridge to execute custom actions within a route using the Saga EIP. The component should be used for advanced tasks, such as deciding to complete or compensate a Saga with completionMode set to *MANUAL*. diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc index a557d80..73f477b 100644 --- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc +++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc @@ -78,7 +78,7 @@ You can append query options to the URI in the following format, === Passing in Salesforce headers and fetching Salesforce response headers -With Camel 2.21 there is support to pass https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/headers.htm[Salesforce headers] +There is support to pass https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/headers.htm[Salesforce headers] via inbound message headers, header names that start with `Sforce` or `x-sfdc` on the Camel message will be passed on in the request, and response headers that start with `Sforce` will be present in the outbound diff --git a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc index 07dd800..ede8a20 100644 --- a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc +++ b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.12* -The *sap-netweaver* integrates with the +The SAP Netweaver integrates with the http://scn.sap.com/community/developer-center/netweaver-gateway[SAP NetWeaver Gateway] using HTTP transports. diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc b/components/camel-saxon/src/main/docs/xquery-component.adoc index ef64bcd..9a2e394 100644 --- a/components/camel-saxon/src/main/docs/xquery-component.adoc +++ b/components/camel-saxon/src/main/docs/xquery-component.adoc @@ -268,8 +268,6 @@ The following example shows how to take a message of an ActiveMQ queue </camelContext> ------------------------------------------------------------------------- -Currently custom functions in XQuery might result in a NullPointerException (Camel 2.18, 2.19 and 2.20). This is expected to be fixed in Camel 2.21 - ### Examples Here is a simple diff --git a/components/camel-scheduler/src/main/docs/scheduler-component.adoc b/components/camel-scheduler/src/main/docs/scheduler-component.adoc index 187dd9f..5887764 100644 --- a/components/camel-scheduler/src/main/docs/scheduler-component.adoc +++ b/components/camel-scheduler/src/main/docs/scheduler-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.15* -The *scheduler:* component is used to generate message exchanges when a +The Scheduler component is used to generate message exchanges when a scheduler fires. This component is similar to the <<timer-component,Timer>> component, but it offers more functionality in terms of scheduling. Also this component uses diff --git a/components/camel-seda/src/main/docs/seda-component.adoc b/components/camel-seda/src/main/docs/seda-component.adoc index eb791a3..ba4088d 100644 --- a/components/camel-seda/src/main/docs/seda-component.adoc +++ b/components/camel-seda/src/main/docs/seda-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.1* -The *seda:* component provides asynchronous +The SEDA component provides asynchronous http://www.eecs.harvard.edu/~mdw/proj/seda/[SEDA] behavior, so that messages are exchanged on a http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/BlockingQueue.html[BlockingQueue] @@ -192,16 +192,6 @@ it is a Request Reply message, we wait for the response. When the consumer on the `seda:input` queue is complete, it copies the response to the original message response. -NOTE: *until 2.2: Works only with 2 endpoints* -Using Request Reply over SEDA -or <<vm-component,VM>> only works with 2 endpoints. You *cannot* chain -endpoints by sending to A -> B -> C etc. Only between A -> B. The reason -is the implementation logic is fairly simple. To support 3+ endpoints -makes the logic much more complex to handle ordering and notification -between the waiting threads properly. -This has been improved in *Camel 2.3* onwards, which allows you to chain -as many endpoints as you like. - === Concurrent consumers By default, the SEDA endpoint uses a single consumer thread, but you can diff --git a/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc b/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc index 5abdb91..064ab0c 100644 --- a/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc +++ b/components/camel-servicenow/camel-servicenow-component/src/main/docs/servicenow-component.adoc @@ -5,7 +5,7 @@ The ServiceNow component provides access to ServiceNow platform through their REST API. -NOTE: From Camel 2.18.1 the component supports multiple version of ServiceNow platform with default to Helsinki. Supported version are <<ServiceNow-Fuji>> and <<ServiceNow-Helsinki>> +The component supports multiple version of ServiceNow platform with default to Helsinki. Supported version are <<ServiceNow-Fuji>> and <<ServiceNow-Helsinki>> Maven users will need to add the following dependency to their pom.xml diff --git a/components/camel-servlet/src/main/docs/servlet-component.adoc b/components/camel-servlet/src/main/docs/servlet-component.adoc index f95ac88..e613cd9 100644 --- a/components/camel-servlet/src/main/docs/servlet-component.adoc +++ b/components/camel-servlet/src/main/docs/servlet-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.0* -The *servlet:* component provides HTTP based +The Servlet component provides HTTP based endpoints for consuming HTTP requests that arrive at a HTTP endpoint that is bound to a published Servlet. @@ -212,7 +212,7 @@ And in your Camel endpoints then include the servlet name as well </route> --------------------------------------------------- -From *Camel 2.11* onwards Camel will detect this duplicate and fail to +Camel detects this duplicate and fail to start the application. You can control to ignore this duplicate by setting the servlet init-parameter ignoreDuplicateServletName to true as follows: @@ -236,8 +236,7 @@ side-effects. === Sample -NOTE: From Camel 2.7 onwards it's easier to use <<servlet-component,Servlet>> in -Spring web applications. See +Use <<servlet-component,Servlet>> in Spring web applications for simplicity's sake. See <<ServletTomcatExample-ServletTomcatExample,Servlet Tomcat Example>> for details. In this sample, we define a route that exposes a HTTP service at @@ -338,7 +337,7 @@ like this: ==== Sample when using OSGi -From *Camel 2.6.0*, you can publish the +You can publish the https://github.com/apache/camel/blob/master/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/CamelHttpTransportServlet.java[CamelHttpTransportServlet] as an OSGi service with Blueprint like this: @@ -407,7 +406,7 @@ Then use this service in your Camel route like this: </blueprint> ------------------------------------------------------------------------- -For versions prior to Camel 2.6 you can use an `Activator` to publish +You can use an `Activator` to publish the https://github.com/apache/camel/blob/master/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/CamelHttpTransportServlet.java[CamelHttpTransportServlet] on the OSGi platform: @@ -488,8 +487,7 @@ public final class ServletActivator implements BundleActivator, BundleContextAwa ------------------------------------------------------------------------- ==== Usage with Spring-Boot - -From *Camel 2.19.0* onwards, the _camel-servlet-starter_ library binds automatically all the rest endpoints under the `/camel/*` context path. +The _camel-servlet-starter_ library binds automatically all the rest endpoints under the `/camel/*` context path. The following table summarizes the additional configuration properties available in the _camel-servlet-starter_ library. The automatic mapping of the Camel servlet can also be disabled. diff --git a/components/camel-shiro/src/main/docs/shiro.adoc b/components/camel-shiro/src/main/docs/shiro.adoc index 7d777a6..de32138 100644 --- a/components/camel-shiro/src/main/docs/shiro.adoc +++ b/components/camel-shiro/src/main/docs/shiro.adoc @@ -3,7 +3,7 @@ *Available as of Camel 2.5* -The *shiro-security* component in Camel is a security focused component, +The Shiro Security component in Camel is a security focused component, based on the Apache Shiro security project. Apache Shiro is a powerful and flexible open-source security framework @@ -120,7 +120,7 @@ ShiroSecurityPolicy object, then authorization is deemed as not required. Note that the default is that authorization is granted if any of the Permission Objects in the list are applicable. -|`rolesList` |`none` |List<String> |*Camel 2.13:* A List of roles required in order for an authenticated +|`rolesList` |`none` |List<String> |A List of roles required in order for an authenticated user to be authorized to perform further action i.e continue further on the route. If no roles list or permissions list (see above) is provided to the ShiroSecurityPolicy object, then authorization is deemed as not @@ -130,15 +130,15 @@ of the roles in the list are applicable. |`cipherService` |`AES` |org.apache.shiro.crypto.CipherService |Shiro ships with AES & Blowfish based CipherServices. You may use one these or pass in your own Cipher implementation -|`base64` |`false` |`boolean` |*Camel 2.12:* To use base64 encoding for the security token header, +|`base64` |`false` |`boolean` |To use base64 encoding for the security token header, which allows transferring the header over <<jms-component,JMS>> etc. This option must also be set on `ShiroSecurityTokenInjector` as well. -|`allPermissionsRequired` |`false` |`boolean` |*Camel 2.13:* The default is that authorization is granted if any of the +|`allPermissionsRequired` |`false` |`boolean` |The default is that authorization is granted if any of the Permission Objects in the permissionsList parameter are applicable. Set this to true to require all of the Permissions to be met. -|`allRolesRequired` |`false` |`boolean` |*Camel 2.13:* The default is that authorization is granted if any of the +|`allRolesRequired` |`false` |`boolean` |The default is that authorization is granted if any of the roles in the rolesList parameter are applicable. Set this to true to require all of the roles to be met. |======================================================================= @@ -266,12 +266,6 @@ ProducerTemplate in Camel along with a SecurityToken } ------------------------------------------------------------------------------------------------- -[[ShiroSecurity-SendingMessagestoroutessecuredbyaShiroSecurityPolicymucheasierfromCamel2.12onwards]] -=== Sending Messages to routes secured by a ShiroSecurityPolicy (much easier from Camel 2.12 onwards) - -From *Camel 2.12* onwards its even easier as you can provide the subject -in two different ways. - [[ShiroSecurity-UsingShiroSecurityToken]] === Using ShiroSecurityToken diff --git a/components/camel-sip/src/main/docs/sip-component.adoc b/components/camel-sip/src/main/docs/sip-component.adoc index e1164a3..a41e7d3 100644 --- a/components/camel-sip/src/main/docs/sip-component.adoc +++ b/components/camel-sip/src/main/docs/sip-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.5* -The *sip* component in Camel is a communication component, based on the +The SIP component in Camel is a communication component, based on the Jain SIP implementation (available under the JCP license). Session Initiation Protocol (SIP) is an IETF-defined signaling protocol, diff --git a/components/camel-slack/src/main/docs/slack-component.adoc b/components/camel-slack/src/main/docs/slack-component.adoc index 4d84bf0..b66682f 100644 --- a/components/camel-slack/src/main/docs/slack-component.adoc +++ b/components/camel-slack/src/main/docs/slack-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.16* -The *slack* component allows you to connect to an instance +The Slack component allows you to connect to an instance of http://www.slack.com/[Slack] and delivers a message contained in the message body via a pre established https://api.slack.com/incoming-webhooks[Slack incoming diff --git a/components/camel-smpp/src/main/docs/smpp-component.adoc b/components/camel-smpp/src/main/docs/smpp-component.adoc index 026bd6a..235923f 100644 --- a/components/camel-smpp/src/main/docs/smpp-component.adoc +++ b/components/camel-smpp/src/main/docs/smpp-component.adoc @@ -12,7 +12,7 @@ The Camel component currently operates as an http://en.wikipedia.org/wiki/ESME[ESME] (External Short Messaging Entity) and not as an SMSC itself. -Starting with*Camel 2.9* you are also able to execute ReplaceSm, +You are also able to execute ReplaceSm, QuerySm, SubmitMulti, CancelSm and DataSm. Maven users will need to add the following dependency to their `pom.xml` @@ -156,7 +156,7 @@ If no *username* is provided, then Camel will provide the default value `smppclient`. + If no *port* number is provided, then Camel will provide the default value `2775`. + - *Camel 2.3:* If the protocol name is "smpps", camel-smpp with try to +If the protocol name is "smpps", camel-smpp with try to use SSLSocket to init a connection to the server. You can append query options to the URI in the following format, @@ -385,8 +385,7 @@ specified in chapter 7.1.1. in the smpp specification v3.4. |`CamelSmppValidityPeriod` |`String`/`Date` |*only for SubmitSm, SubmitMulti and ReplaceSm* The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. If it's -provided as `Date`, it's interpreted as absolute time. *Camel 2.9.1 -onwards:* It can be defined in absolute time format or relative time +provided as `Date`, it's interpreted as absolute time or relative time format if you provide it as `String` as specified in chapter 7.1.1 in the smpp specification v3.4. @@ -397,16 +396,11 @@ existing message provided that the source address, destination address and service type match the same fields in the new message. The following values are defined: `0`, Don't replace and `1`, Replace -|`CamelSmppAlphabet` / `CamelSmppDataCoding` |`Byte` |*Camel 2.5* *For SubmitSm, SubmitMulti and ReplaceSm* (Prior to *Camel -2.9* use `CamelSmppDataCoding` instead of `CamelSmppAlphabet`.) The data +|`CamelSmppAlphabet` / `CamelSmppDataCoding` |`Byte` |*For SubmitSm, SubmitMulti and ReplaceSm* The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option `alphabet` settings above. -|`CamelSmppOptionalParameters` |`Map<String, String>` |*Deprecated and will be removed in Camel 2.13.0/3.0.0* + - *Camel 2.10.5 and 2.11.1 onwards and only for SubmitSm, SubmitMulti and -DataSm* The optional parameters send back by the SMSC. - -|`CamelSmppOptionalParameter` |`Map<Short, Object>` |*Camel 2.10.7 and 2.11.2 onwards and only for SubmitSm, SubmitMulti and +|`CamelSmppOptionalParameter` |`Map<Short, Object>` |*only for SubmitSm, SubmitMulti and DataSm* The optional parameter which are send to the SMSC. The value is converted in the following way: `String` -> `org.jsmpp.bean.OptionalParameter.COctetString`, `byte[]` -> `org.jsmpp.bean.OptionalParameter.OctetString`, @@ -415,7 +409,7 @@ converted in the following way: `String` -> `org.jsmpp.bean.OptionalParameter.CO `Short` -> `org.jsmpp.bean.OptionalParameter.Short`, `null` -> `org.jsmpp.bean.OptionalParameter.Null` -|CamelSmppEncoding |String |*Camel 2.14.1 and Camel 2.15.0 onwards and**only for SubmitSm, +|CamelSmppEncoding |String |*only for SubmitSm, SubmitMulti and DataSm*. Specifies the encoding (character set name) of the bytes in the message body. If the message body is a string then this is not relevant because Java Strings are always Unicode. If the @@ -423,7 +417,7 @@ body is a byte array then this header can be used to indicate that it is ISO-8859-1 or some other value. Default value is specified by the endpoint configuration parameter _encoding_ -|CamelSmppSplittingPolicy |String |*Camel 2.14.1 and Camel 2.15.0 onwards and**only for SubmitSm, +|CamelSmppSplittingPolicy |String |*only for SubmitSm, SubmitMulti and DataSm*. Specifies the policy for message splitting for this exchange. Possible values are described in the endpoint configuration parameter _splittingPolicy_ @@ -436,23 +430,19 @@ response from the SMSC in the message header |======================================================================= |Header |Type |Description -|`CamelSmppId` |`List<String>`/`String` |The id to identify the submitted short message(s) for later use. *From -Camel 2.9.0*: In case of a ReplaceSm, QuerySm, CancelSm and DataSm this +|`CamelSmppId` |`List<String>`/`String` |The id to identify the submitted short message(s) for later use. +In case of a ReplaceSm, QuerySm, CancelSm and DataSm this header vaule is a `String`. In case of a SubmitSm or SubmitMultiSm this header vaule is a `List<String>`. -|`CamelSmppSentMessageCount` |`Integer` |*From Camel 2.9 onwards only for SubmitSm and SubmitMultiSm* The total +|`CamelSmppSentMessageCount` |`Integer` |*only for SubmitSm and SubmitMultiSm* The total number of messages which has been sent. -|`CamelSmppError` |`Map<String, List<Map<String, Object>>>` |*From Camel 2.9 onwards only for SubmitMultiSm* The errors which +|`CamelSmppError` |`Map<String, List<Map<String, Object>>>` |*only for SubmitMultiSm* The errors which occurred by sending the short message(s) the form `Map<String, List<Map<String, Object>>>` (messageID : (destAddr : address, error : errorCode)). -|`CamelSmppOptionalParameters` |`Map<String, String>` |*Deprecated and will be removed in Camel 2.13.0/3.0.0* -*From Camel 2.11.1 onwards only for DataSm* The optional parameters -which are returned from the SMSC by sending the message. - -|`CamelSmppOptionalParameter` |`Map<Short, Object>` |*From Camel 2.10.7, 2.11.2 onwards only for DataSm* The optional +|`CamelSmppOptionalParameter` |`Map<Short, Object>` |*only for DataSm* The optional parameter which are returned from the SMSC by sending the message. The key is the `Short` code for the optional parameter. The value is converted in the following way: @@ -574,17 +564,13 @@ values defined above. address parameters. Use the `sourceAddrTon` URI option values defined above. -|`CamelSmppMessageType` |`String` |*Camel 2.6 onwards*: Identifies the type of an incoming message: +|`CamelSmppMessageType` |`String` |Identifies the type of an incoming message: `AlertNotification`: an SMSC alert notification, `DataSm`: an SMSC data short message, `DeliveryReceipt`: an SMSC delivery receipt, `DeliverSm`: an SMSC deliver short message -|`CamelSmppOptionalParameters` |`Map<String, Object>` |*Deprecated and will be removed in Camel 2.13.0/3.0.0* -*Camel 2.10.5 onwards and only for DeliverSm* The optional parameters -send back by the SMSC. - -|`CamelSmppOptionalParameter` |`Map<Short, Object>` |*Camel 2.10.7, 2.11.2 onwards and only for DeliverSm* The optional +|`CamelSmppOptionalParameter` |`Map<Short, Object>` |*only for DeliverSm* The optional parameters send back by the SMSC. The key is the `Short` code for the optional parameter. The value is converted in the following way: `org.jsmpp.bean.OptionalParameter.COctetString` -> `String`, @@ -610,7 +596,7 @@ with a nested exception, org.jsmpp.extra.NegativeResponseException. Call NegativeResponseException.getCommandStatus() to obtain the exact SMPP negative response code, the values are explained in the SMPP specification 3.4, section 5.1.3. + - *Camel 2.8 onwards*: When the SMPP consumer receives a `DeliverSm` or +When the SMPP consumer receives a `DeliverSm` or `DataSm` short message and the processing of these messages fails, you can also throw a `ProcessRequestException` instead of handle the failure. In this case, this exception is forwarded to the underlying diff --git a/components/camel-snmp/src/main/docs/snmp-component.adoc b/components/camel-snmp/src/main/docs/snmp-component.adoc index 2a3519a..6baaba3 100644 --- a/components/camel-snmp/src/main/docs/snmp-component.adoc +++ b/components/camel-snmp/src/main/docs/snmp-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.1* -The *snmp:* component gives you the ability to poll SNMP capable devices +The SNMP component gives you the ability to poll SNMP capable devices or receiving traps Maven users will need to add the following dependency to their `pom.xml` @@ -221,7 +221,7 @@ Setting up a trap receiver (*Note that no OID info is needed here!*): snmp:127.0.0.1:162?protocol=udp&type=TRAP ----------------------------------------- -*From Camel 2.10.0*, you can get the community of SNMP TRAP with message +You can get the community of SNMP TRAP with message header 'securityName', + peer address of the SNMP TRAP with message header 'peerAddress'. diff --git a/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc b/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc index 9e739c2..f725057 100644 --- a/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc +++ b/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc @@ -7,11 +7,6 @@ SOAP is a Data Format which uses JAXB2 and JAX-WS annotations to marshal and unmarshal SOAP payloads. It provides the basic features of Apache CXF without need for the CXF Stack. -*Supported SOAP versions* - -SOAP 1.1 is supported by default. SOAP 1.2 is supported from Camel 2.11 -onwards. - *Namespace prefix mapping* See <<jaxb-dataformat,JAXB>> for details how you can control namespace @@ -267,6 +262,6 @@ following dependency to your pom. <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-soap</artifactId> - <version>2.3.0</version> + <version>x.y.z</version> </dependency> ------------------------------------- diff --git a/components/camel-solr/src/main/docs/solr-component.adoc b/components/camel-solr/src/main/docs/solr-component.adoc index 0f5c02b..ade35b1 100644 --- a/components/camel-solr/src/main/docs/solr-component.adoc +++ b/components/camel-solr/src/main/docs/solr-component.adoc @@ -22,8 +22,6 @@ for this component: ### URI format -*NOTE:* solrs and solrCloud are new added since *Camel 2.14*. - [source,java] -------------------------------------- solr://host[:port]/solr?[options] @@ -142,16 +140,16 @@ http://lucene.apache.org/solr/api/org/apache/solr/client/solrj/impl/StreamingUpd |INSERT/INSERT_STREAMING |File |adds an index using the given File (using ContentStreamUpdateRequest) -|INSERT/INSERT_STREAMING |SolrInputDocument |*Camel 2.9.2* updates index based on the given SolrInputDocument +|INSERT/INSERT_STREAMING |SolrInputDocument |updates index based on the given SolrInputDocument -|INSERT/INSERT_STREAMING |String XML |*Camel 2.9.2* updates index based on the given XML (must follow +|INSERT/INSERT_STREAMING |String XML |updates index based on the given XML (must follow SolrInputDocument format) |ADD_BEAN |bean instance |adds an index based on values in an http://wiki.apache.org/solr/Solrj#Directly_adding_POJOs_to_Solr[annotated bean] -|ADD_BEANS |collection<bean> |*Camel 2.15* adds index based on a collection of +|ADD_BEANS |collection<bean> |adds index based on a collection of http://wiki.apache.org/solr/Solrj#Directly_adding_POJOs_to_Solr[annotated bean] diff --git a/components/camel-soroush/src/main/docs/soroush-component.adoc b/components/camel-soroush/src/main/docs/soroush-component.adoc index 8738780..a443565 100644 --- a/components/camel-soroush/src/main/docs/soroush-component.adoc +++ b/components/camel-soroush/src/main/docs/soroush-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 3.0* -The *Soroush* component provides access to the https://soroush-app.ir/developer.html[Soroush Bot API]. +The Soroush component provides access to the https://soroush-app.ir/developer.html[Soroush Bot API]. It allows a Camel-based application to send and receive messages by acting as a Bot, i.e. participating in direct conversation with normal users and send and receive message and files A Soroush Bot must be created before using this component, following the diff --git a/components/camel-splunk/src/main/docs/splunk-component.adoc b/components/camel-splunk/src/main/docs/splunk-component.adoc index 7cafcfe..e544954 100644 --- a/components/camel-splunk/src/main/docs/splunk-component.adoc +++ b/components/camel-splunk/src/main/docs/splunk-component.adoc @@ -213,7 +213,7 @@ placeholder for such data, and should be in the message body for the producer. Likewise it will be returned in the body per search result for the consumer. -As of Camel 2.16.0 you can send raw data to Splunk by setting the raw +You can send raw data to Splunk by setting the raw option on the producer endpoint. This is useful for eg. json/xml and other payloads where Splunk has build in support. diff --git a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc index dd7636a..9ebb0f5 100644 --- a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc +++ b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.10* -The *spring-batch:* component and support classes provide integration +The Spring Batch component and support classes provide integration bridge between Camel and http://www.springsource.org/spring-batch[Spring Batch] infrastructure. @@ -170,7 +170,7 @@ explicitly. from("direct:startBatch").to("spring-batch:myJob?jobLauncherRef=myJobLauncher"); -------------------------------------------------------------------------------- -Starting from the Camel *2.11.1* `JobExecution` instance returned by the +A `JobExecution` instance returned by the `JobLauncher` is forwarded by the `SpringBatchProducer` as the output message. You can use the `JobExecution` instance to perform some operations using the Spring Batch API directly. diff --git a/components/camel-spring-boot/src/main/docs/spring-boot.adoc b/components/camel-spring-boot/src/main/docs/spring-boot.adoc index ca72b1d..230b5c2 100644 --- a/components/camel-spring-boot/src/main/docs/spring-boot.adoc +++ b/components/camel-spring-boot/src/main/docs/spring-boot.adoc @@ -3,8 +3,6 @@ *Available as of Camel 2.15* -NOTE: Spring Boot 2 is supported since Camel 2.22 (summer 2018). Previous versions of Camel support Spring Boot 1.x only. - Spring Boot component provides auto-configuration for Apache Camel. Our opinionated auto-configuration of the Camel context auto-detects Camel routes available in the Spring context and registers the key Camel @@ -488,8 +486,7 @@ camel.springboot.type-conversion = false [[SpringBoot-Keepingapplicationalive]] === Keeping the application alive -This feature is available starting from Camel *2.15.2*. Camel -applications having this feature enabled launch a new thread on startup for the sole purpose of +Camel applications having this feature enabled launch a new thread on startup for the sole purpose of keeping the application alive by preventing JVM termination. It means that after you start a Camel application with Spring Boot, your application waits for a Ctrl+C signal and does not exit immediately. @@ -509,7 +506,7 @@ usually don't need to use this feature because the application is kept alive by By default you can put Camel XML routes in the classpath under the directory camel, which camel-spring-boot will auto detect and include. -From *Camel 2.17* onwards you can configure the directory name or turn +You can configure the directory name or turn this off using the configuration option [source,text] diff --git a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc index 6fada37..0303c6a 100644 --- a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc +++ b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.4* -The *spring-integration:* component provides a bridge for Camel +The Spring Integration component provides a bridge for Camel components to talk to http://www.springsource.org/spring-integration[spring integration endpoints]. diff --git a/components/camel-spring-javaconfig/src/main/docs/spring-javaconfig.adoc b/components/camel-spring-javaconfig/src/main/docs/spring-javaconfig.adoc index be18e71..654f64b 100644 --- a/components/camel-spring-javaconfig/src/main/docs/spring-javaconfig.adoc +++ b/components/camel-spring-javaconfig/src/main/docs/spring-javaconfig.adoc @@ -55,7 +55,7 @@ public class MyRouteConfiguration extends CamelConfiguration { } -------------------------------------------------------------------- -Starting from Camel 2.13.0 you can skip the *routes()* definition, and +You can skip the *routes()* definition, and fall back to the *RouteBuilder* instances located in the Spring context. [source,java] @@ -69,23 +69,16 @@ public class MyRouteConfiguration extends CamelConfiguration { [[SpringJavaConfig-Testing]] === Testing -Since *Camel 2.11.0* you can use the `CamelSpringJUnit4ClassRunner` with +You can use the `CamelSpringJUnit4ClassRunner` with `CamelSpringDelegatingTestContextLoader`. This is the recommended way to test Java Config and Camel integration. If you wish to create a collection of *RouteBuilder* instances then derive from the *CamelConfiguration* helper class and implement the -*routes()* method. Keep in mind that (starting from the Camel 2.13.0) if +*routes()* method. Keep in mind that if you don't override *routes()* method, then *CamelConfiguration* will use all *RouteBuilder* instances available in the Spring context. -The following -http://svn.apache.org/repos/asf/camel/trunk/components/camel-spring-javaconfig/src/test/java/org/apache/camel/spring/javaconfig/patterns/FilterTest.java[example -using Java Config] demonstrates how to test Java Config integration with -Camel 2.10 and lower. Keep in mind that `JavaConfigContextLoader` is -deprecated and could be removed in the future versions of Camel on the -behalf of the `CamelSpringDelegatingTestContextLoader`. - The *@ContextConfiguration* annotation tells the Spring Testing framework to load the *ContextConfig* class as the configuration to use. This class derives diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc index c5d9e0b..d12d1b0 100644 --- a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc +++ b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.11* -The *spring-ldap:* component provides a Camel wrapper for +The Spring LDAP component provides a Camel wrapper for http://www.springsource.org/ldap[Spring LDAP]. Maven users will need to add the following dependency to their `pom.xml` diff --git a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc index 67a1eb4..2689937 100644 --- a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc +++ b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc @@ -419,8 +419,7 @@ Maven users will need to add the following dependency to their pom.xml. </dependency> ----------------------------------------------- -where `${camel-version`} must be replaced by the actual version of Camel -(2.11 or higher). +where `${camel-version`} must be replaced by the actual version of Camel. ### See Also diff --git a/components/camel-spring-security/src/main/docs/spring-security.adoc b/components/camel-spring-security/src/main/docs/spring-security.adoc index 608adb5..267d74a 100644 --- a/components/camel-spring-security/src/main/docs/spring-security.adoc +++ b/components/camel-spring-security/src/main/docs/spring-security.adoc @@ -3,7 +3,7 @@ *Available as of Camel 2.3* -The *camel-spring-security* component provides role-based authorization +The Camel Spring Security component provides role-based authorization for Camel routes. It leverages the authentication and user services provided by http://static.springsource.org/spring-security/site/index.html[Spring @@ -46,7 +46,7 @@ context |`accessDecisionManager` |`accessDecisionManager` |The name of the Spring Security `AccessDecisionManager` object in the context -|`authenticationAdapter` |DefaultAuthenticationAdapter |*Camel 2.4* The name of a *camel-spring-security* +|`authenticationAdapter` |DefaultAuthenticationAdapter |The name of a *camel-spring-security* `AuthenticationAdapter` object in the context that is used to convert a `javax.security.auth.Subject` into a Spring Security `Authentication` instance. @@ -190,7 +190,7 @@ for this component: <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-spring-security</artifactId> - <version>2.4.0</version> + <version>x.y.z</version> </dependency> ------------------------------------------------- diff --git a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc index d9f862d..34ff452 100644 --- a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc +++ b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.6* -The *spring-ws:* component allows you to integrate with +The Spring WS component allows you to integrate with http://static.springsource.org/spring-ws/sites/1.5/[Spring Web Services]. It offers both _client_-side support, for accessing web services, and _server_-side support for creating your own contract-first @@ -26,10 +26,8 @@ for this component: ==== *Dependencies* -As of Camel 2.8 this component ships with Spring-WS 2.0.x which (like -the rest of Camel) requires Spring 3.0.x. -Earlier Camel versions shipped Spring-WS 1.5.9 which is compatible with -Spring 2.5.x and 3.0.x. In order to run earlier versions of +This component ships with Spring-WS 2.0.x which (like +the rest of Camel) requires Spring 3.0.x. In order to run earlier versions of `camel-spring-ws` on Spring 2.5.x you need to add the `spring-webmvc` module from Spring 2.5.x. In order to run Spring-WS 1.5.9 on Spring 3.0.x you need to exclude the OXM module from Spring 3.0.x as this @@ -198,7 +196,7 @@ part of the endpoint URI |`CamelSpringWebserviceSoapAction` |String |Header to specify the SOAP action of the message, overrides `soapAction` option if present -|CamelSpringWebserviceSoapHeader |Source |*Camel 2.11.1:* Use this header to specify/access the SOAP headers of +|CamelSpringWebserviceSoapHeader |Source |Use this header to specify/access the SOAP headers of the message. |`CamelSpringWebserviceAddressingAction` |URI |Use this header to specify the WS-Addressing action of the message, @@ -291,7 +289,7 @@ test]. ### The header and attachment propagation Spring WS Camel supports propagation of the headers and attachments into -Spring-WS WebServiceMessage response since version *2.10.3*. The +Spring-WS WebServiceMessage response. The endpoint will use so called "hook" the MessageFilter (default implementation is provided by BasicMessageFilter) to propagate the exchange headers and attachments into WebServiceMessage response. Now diff --git a/components/camel-spring/src/main/docs/spel-language.adoc b/components/camel-spring/src/main/docs/spel-language.adoc index 8f6a30e..a966c12 100644 --- a/components/camel-spring/src/main/docs/spel-language.adoc +++ b/components/camel-spring/src/main/docs/spel-language.adoc @@ -7,7 +7,7 @@ Camel allows https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions[Spring Expression Language (SpEL)] to be used as an Expression or Predicate in the DSL or XML Configuration. -NOTE: It is recommended to use SpEL in Spring runtimes. However from Camel 2.21 onwards you can +NOTE: It is recommended to use SpEL in Spring runtimes. However, you can use SpEL in other runtimes (there may be functionality SpEL cannot do when not running in a Spring runtime) === Variables diff --git a/components/camel-spring/src/main/docs/spring-event-component.adoc b/components/camel-spring/src/main/docs/spring-event-component.adoc index ce08175..a166da2 100644 --- a/components/camel-spring/src/main/docs/spring-event-component.adoc +++ b/components/camel-spring/src/main/docs/spring-event-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.4* -The *spring-event:* component provides access to the Spring +The Spring Event component provides access to the Spring `ApplicationEvent` objects. This allows you to publish `ApplicationEvent` objects to a Spring `ApplicationContext` or to consume them. You can then use diff --git a/components/camel-spring/src/main/docs/spring.adoc b/components/camel-spring/src/main/docs/spring.adoc index 9ce2fa7..dc76de0 100644 --- a/components/camel-spring/src/main/docs/spring.adoc +++ b/components/camel-spring/src/main/docs/spring.adoc @@ -27,8 +27,7 @@ framework to simplify your unit and integration testing using xref:enterprise-integration-patterns.adoc[Enterprise Integration Patterns] and Camel's powerful <<mock-component,Mock>> and <<test-component,Test>> endpoints -* From *Camel 2.15* onwards Camel supports Spring Boot using -the `camel-spring-boot` component. +Camel supports Spring Boot using the `camel-spring-boot` component. === Using Spring to configure the CamelContext @@ -47,20 +46,6 @@ instances. === Adding Camel Schema -For Camel 1.x you need to use the following namespace: - -[source,java] ----------------------------------------------- -http://activemq.apache.org/camel/schema/spring ----------------------------------------------- - -with the following schema location: - -[source,java] ---------------------------------------------------------------- -http://activemq.apache.org/camel/schema/spring/camel-spring.xsd ---------------------------------------------------------------- - You need to add Camel to the `schemaLocation` declaration [source,java] @@ -158,10 +143,10 @@ using `<routeBuilder ref="theBeanId"/>` or the `<contextScan>` feature. ==== Using <packageScan> -In Camel 2.0 this has been extended to allow selective inclusion and +The component allows selective inclusion and exclusion of discovered route classes using Ant like path matching. In spring this is specified by adding a <packageScan/> tag. The tag must -contain one or more 'package' elements (similar to 1.x), and optionally +contain one or more 'package' elements, and optionally one or more 'includes' or 'excludes' elements specifying patterns to be applied to the fully qualified names of the discovered classes. e.g. @@ -250,14 +235,13 @@ application if some of the routes are in separate XML files. You may also want to store common and reusable routes in other XML files, which you can simply import when needed. -In *Camel 2.3* it is now possible to define routes outside +It is possible to define routes outside `<camelContext/>` which you do in a new `<routeContext/>` tag. *Notice:* When you use <routeContext> then they are separated, and cannot reuse existing <onException>, <intercept>, <dataFormats> and similar cross cutting functionality defined in the <camelContext>. In -other words the <routeContext> is currently isolated. This may change in -Camel 3.x. +other words the <routeContext> is currently isolated. For example we could have a file named `myCoolRoutes.xml` which contains a couple of routes as shown: diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc index 728e20f..fbc3270 100644 --- a/components/camel-sql/src/main/docs/sql-component.adoc +++ b/components/camel-sql/src/main/docs/sql-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.4* -The *sql:* component allows you to work with databases using JDBC +The SQL component allows you to work with databases using JDBC queries. The difference between this component and <<jdbc-component,JDBC>> component is that in case of SQL the query is a property of the endpoint and it uses message payload as parameters passed to the query. @@ -34,10 +34,6 @@ pattern. See further below. === URI format -WARNING: From Camel 2.11 onwards this component can create both consumer (e.g. -`from()`) and producer endpoints (e.g. `to()`). -In previous versions, it could only act as a producer. - TIP: This component can be used as a http://camel.apache.org/transactional-client.html[Transactional Client]. @@ -48,7 +44,7 @@ The SQL component uses the following endpoint URI notation: sql:select * from table where id=# order by name[?options] ---- -From Camel 2.11 onwards you can use named parameters by using +You can use named parameters by using :`#name_of_the_parameter` style as shown: [source,text] @@ -64,7 +60,7 @@ given precedence: If a named parameter cannot be resolved, then an exception is thrown. -From *Camel 2.14* onward you can use Simple expressions as parameters as +You can use Simple expressions as parameters as shown: [source,text] @@ -77,7 +73,7 @@ SQL query is substituted with the `pass:[#]` symbol, because the `?` symbol is used to specify options for the endpoint. The `?` symbol replacement can be configured on endpoint basis. -From *Camel 2.17* onwards you can externalize your SQL queries to files +You can externalize your SQL queries to files in the classpath or file system as shown: [source,text] @@ -252,7 +248,7 @@ message body changes slightly – instead of an iterator of parameters, the component expects an iterator that contains the parameter iterators; the size of the outer iterator determines the batch size. -From Camel 2.16 onwards you can use the option useMessageBodyForSql that +You can use the option useMessageBodyForSql that allows to use the message body as the SQL statement, and then the SQL parameters must be provided in a header with the key SqlConstants.SQL_PARAMETERS. This allows the SQL component to work @@ -282,7 +278,7 @@ from("jms:order.inbox") === Using StreamList -From*Camel 2.18* onwards the producer supports outputType=StreamList +The producer supports outputType=StreamList that uses an iterator to stream the output of the query. This allows to process the data in a streaming fashion which for example can be used by the Splitter EIP to process each row one at a time, @@ -317,14 +313,14 @@ outputType=StreamList. `Integer` object. This header is not provided when using outputType=StreamList. -|`CamelSqlQuery` |*Camel 2.8:* Query to execute. This query takes precedence over the +|`CamelSqlQuery` |Query to execute. This query takes precedence over the query specified in the endpoint URI. Note that query parameters in the header _are_ represented by a `?` instead of a `pass:[#]` symbol |=== When performing `insert` operations, the SQL Component stores the rows with the generated keys and number of these rown in the following -message headers (*Available as of Camel 2.12.4, 2.13.1*): +message headers: [width="100%",cols="10%,90%",options="header",] |=== @@ -439,7 +435,7 @@ bean methods as in this example. *Available as of Camel 2.17* -From Camel 2.17 onwards the SQL producer allows to use SQL queries with +The SQL producer allows to use SQL queries with IN statements where the IN values is dynamic computed. For example from the message body or a header etc. @@ -503,20 +499,22 @@ from("direct:query") === Using the JDBC based idempotent repository -*Available as of Camel 2.7*: In this section we will use the JDBC based +*Available as of Camel 2.7* + +In this section we will use the JDBC based idempotent repository. [TIP] ==== *Abstract class* -From Camel 2.9 onwards there is an abstract class +There is an abstract class `org.apache.camel.processor.idempotent.jdbc.AbstractJdbcMessageIdRepository` you can extend to build custom JDBC idempotent repository. ==== First we have to create the database table which will be used by the -idempotent repository. For *Camel 2.7*, we use the following schema: +idempotent repository. We use the following schema: [source,sql] ---- @@ -525,7 +523,7 @@ messageId VARCHAR(100) ) ---- -In *Camel 2.8*, we added the createdAt column: +We added the createdAt column: [source,sql] ---- @@ -542,7 +540,7 @@ Because the syntax for this constraint differs from database to database, we do ==== Customize the JdbcMessageIdRepository -Starting with *Camel 2.9.1* you have a few options to tune the +You have a few options to tune the `org.apache.camel.processor.idempotent.jdbc.JdbcMessageIdRepository` for your needs: @@ -581,15 +579,6 @@ the second one is the message id (`String`). *Available as of Camel 2.6* -[NOTE] -==== -*Using JdbcAggregationRepository in Camel 2.6* - -In Camel 2.6, the JdbcAggregationRepository is provided in the -`camel-jdbc-aggregator` component. From Camel 2.7 onwards, the -`JdbcAggregationRepository` is provided in the `camel-sql` component. -==== - `JdbcAggregationRepository` is an `AggregationRepository` which on the fly persists the aggregated messages. This ensures that you will not loose messages, as the default aggregator will use an in memory only @@ -752,7 +741,7 @@ Here is the declaration for Oracle: ==== Optimistic locking -From *Camel 2.12* onwards you can turn on `optimisticLocking` and use +You can turn on `optimisticLocking` and use this JDBC based aggregation repository in a clustered environment where multiple Camel applications shared the same database for the aggregation repository. If there is a race condition there JDBC driver will throw a diff --git a/components/camel-sql/src/main/docs/sql-stored-component.adoc b/components/camel-sql/src/main/docs/sql-stored-component.adoc index e002488..f881d83 100644 --- a/components/camel-sql/src/main/docs/sql-stored-component.adoc +++ b/components/camel-sql/src/main/docs/sql-stored-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *sql-stored:* component allows you to work with databases using JDBC +The SQL Stored component allows you to work with databases using JDBC Stored Procedure queries. This component is an extension to the xref:sql-component.adoc[SQL Component] but specialized for calling stored procedures. diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc index 8e9cc2c..23aceb5 100644 --- a/components/camel-ssh/src/main/docs/ssh-component.adoc +++ b/components/camel-ssh/src/main/docs/ssh-component.adoc @@ -247,8 +247,7 @@ An example of using Public Key authentication is provided in Certificate Dependencies You will need to add some additional runtime dependencies if you use -certificate based authentication. The dependency versions shown are as -of Camel 2.11, you may need to use later versions depending what version +certificate based authentication. You may need to use later versions depending what version of Camel you are using. [source,xml] diff --git a/components/camel-stax/src/main/docs/stax-component.adoc b/components/camel-stax/src/main/docs/stax-component.adoc index aa08aa4..c207944 100644 --- a/components/camel-stax/src/main/docs/stax-component.adoc +++ b/components/camel-stax/src/main/docs/stax-component.adoc @@ -36,8 +36,7 @@ example: stax:org.superbiz.FooContentHandler ----------------------------------- -From *Camel 2.11.1* onwards you can lookup a -`org.xml.sax.ContentHandler` bean from the Registry +You can lookup a `org.xml.sax.ContentHandler` bean from the Registry using the # syntax as shown: [source,java] @@ -238,7 +237,7 @@ from("file:target/in") Where `stax` is a static method on `org.apache.camel.component.stax.StAXBuilder` which you can static import in the Java code. The stax builder is by default namespace aware -on the XMLReader it uses. From *Camel 2.11.1* onwards you can turn this +on the XMLReader it uses. You can turn this off by setting the boolean parameter to false, as shown below: [source,java] diff --git a/components/camel-stomp/src/main/docs/stomp-component.adoc b/components/camel-stomp/src/main/docs/stomp-component.adoc index c3a4416..9d45236 100644 --- a/components/camel-stomp/src/main/docs/stomp-component.adoc +++ b/components/camel-stomp/src/main/docs/stomp-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.12* -The *stomp:* component is used for communicating with +The Stomp component is used for communicating with http://stomp.github.io/[Stomp] compliant message brokers, like http://activemq.apache.org[Apache ActiveMQ] or http://activemq.apache.org/apollo/[ActiveMQ Apollo] diff --git a/components/camel-stream/src/main/docs/stream-component.adoc b/components/camel-stream/src/main/docs/stream-component.adoc index 2f0f93c..6f7ac46 100644 --- a/components/camel-stream/src/main/docs/stream-component.adoc +++ b/components/camel-stream/src/main/docs/stream-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.3* -The *stream:* component provides access to the `System.in`, `System.out` +The Stream component provides access to the `System.in`, `System.out` and `System.err` streams as well as allowing streaming of file and URL. Maven users will need to add the following dependency to their `pom.xml` @@ -146,7 +146,7 @@ The component supports 3 options, which are listed below. === Message content -The *stream:* component supports either `String` or `byte[]` for writing +The Stream component supports either `String` or `byte[]` for writing to streams. Just add either `String` or `byte[]` content to the `message.in.body`. Messages sent to the *stream:* producer in binary mode are not followed by the newline character (as opposed to the diff --git a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc index c31c341..22132c2 100644 --- a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc +++ b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.2* -The *string-template:* component allows you to process a message using a +The String Template component allows you to process a message using a http://www.stringtemplate.org/[String Template]. This can be ideal when using Templating to generate responses for requests. @@ -130,7 +130,7 @@ This scenario can be used in production when the resource never changes. ### StringTemplate Attributes -Since Camel 2.14, you can define the custom context map by setting the +You can define the custom context map by setting the message header "*CamelStringTemplateVariableMap*" just like the below code. @@ -160,8 +160,7 @@ from("activemq:My.Queue"). In this sample we want to use a string template to send an order confirmation email. The email template is laid out in `StringTemplate` -as: This example works for *camel 2.11.0*. If your camel version is less -than 2.11.0, the variables should be started and ended with $. +as: [source,java] -------------------------------------------- diff --git a/components/camel-stub/src/main/docs/stub-component.adoc b/components/camel-stub/src/main/docs/stub-component.adoc index de0e921..ee147c6 100644 --- a/components/camel-stub/src/main/docs/stub-component.adoc +++ b/components/camel-stub/src/main/docs/stub-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.10* -The *stub:* component provides a simple way to stub out any physical +The Stub component provides a simple way to stub out any physical endpoints while in development or testing, allowing you for example to run a route without needing to actually connect to a specific <<mail-component,SMTP>> or <<mail-component,Http>> endpoint. Just add *stub:* diff --git a/components/camel-swagger-java/src/main/docs/swagger-java.adoc b/components/camel-swagger-java/src/main/docs/swagger-java.adoc index 77ec5ba..2bc03cb 100644 --- a/components/camel-swagger-java/src/main/docs/swagger-java.adoc +++ b/components/camel-swagger-java/src/main/docs/swagger-java.adoc @@ -22,8 +22,6 @@ their `pom.xml` for this component: The camel-swagger-java module can be used from the REST components (without the need for servlet) -NOTE: The camel-swagger-java component requires JMX enabled when using Camel 2.x. - === Using Swagger in rest-dsl You can enable the swagger api from the rest-dsl by configuring the @@ -84,12 +82,7 @@ false. |host |String |To setup the hostname. If not configured camel-swagger-java will calculate the name as localhost based. -|schemas |String |The protocol schemes to use. Multiple values can be separated by comma -such as "http,https". The default value is "http". This option is -*deprecated* from Camel 2.17 onwards due it should have been named -schemes. - -|schemes |String |*Camel 2.17:* The protocol schemes to use. Multiple values can be +|schemes |String |The protocol schemes to use. Multiple values can be separated by comma such as "http,https". The default value is "http". |base.path |String |*Required*: To setup the base path where the REST services is available. diff --git a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc index 39388af..8a56504 100644 --- a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc +++ b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.6* -The *syslog* dataformat is used for working with +The Syslog dataformat is used for working with http://www.ietf.org/rfc/rfc3164.txt[RFC3164] and RFC5424 messages. This component supports the following: @@ -13,11 +13,11 @@ This component supports the following: SyslogMessage model objects. * Type Converter from/to SyslogMessage and String -* Integration with the xref:mina2-component.adoc[Mina2 Component] component. -* Integration with the xref:netty4-component.adoc[Netty4 Component] component. -* *Camel 2.14:* Encoder and decoder for +* Integration with the <<mina2-component,camel-mina>> component. +* Integration with the <<netty-component,camel-netty>> component. +* Encoder and decoder for the xref:netty4-component.adoc[Netty4 Component] component. -* *Camel 2.14:* Support for RFC5424 also. +* Support for RFC5424 also. Maven users will need to add the following dependency to their `pom.xml` for this component: