http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-quartz2/src/main/docs/quartz2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-quartz2/src/main/docs/quartz2-component.adoc b/components/camel-quartz2/src/main/docs/quartz2-component.adoc index 2ad143b..71a3e1e 100644 --- a/components/camel-quartz2/src/main/docs/quartz2-component.adoc +++ b/components/camel-quartz2/src/main/docs/quartz2-component.adoc @@ -1,4 +1,4 @@ -# Quartz2 Component +## Quartz2 Component *Available as of Camel 2.12.0* @@ -24,9 +24,7 @@ for this component: remain on old Quartz 1.x, please + use the old link:quartz.html[Quartz] component instead. -[[Quartz2-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------------------- @@ -44,9 +42,7 @@ name. You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Quartz2-Options]] -Options -^^^^^^^ +### Options @@ -130,9 +126,7 @@ to the <camelContext> that this id is unique, as this is required by the `QuartzScheduler` in the OSGi container. If you do not set any `id` on <camelContext> then a unique id is auto assigned, and there is no problem. -[[Quartz2-Configuringquartz.propertiesfile]] -Configuring quartz.properties file -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Configuring quartz.properties file By default Quartz will look for a `quartz.properties` file in the `org/quartz` directory of the classpath. If you are using WAR @@ -160,9 +154,7 @@ To do this you can configure this in Spring XML as follows </bean> ------------------------------------------------------------------------------- -[[Quartz2-EnablingQuartzschedulerinJMX]] -Enabling Quartz scheduler in JMX -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Enabling Quartz scheduler in JMX You need to configure the quartz scheduler properties to enable JMX. + That is typically setting the option @@ -172,9 +164,7 @@ configuration file. From Camel 2.13 onwards Camel will automatic set this option to true, unless explicit disabled. -[[Quartz2-StartingtheQuartzscheduler]] -Starting the Quartz scheduler -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Starting the Quartz scheduler The link:quartz2.html[Quartz2] component offers an option to let the Quartz scheduler be started delayed, or not auto started at all. @@ -188,9 +178,7 @@ This is an example: </bean> ------------------------------------------------------------------------------ -[[Quartz2-Clustering]] -Clustering -^^^^^^^^^^ +### Clustering If you use Quartz in clustered mode, e.g. the `JobStore` is clustered. Then the link:quartz2.html[Quartz2] component will *not* pause/remove @@ -200,9 +188,7 @@ to keep running on the other nodes in the cluster. *Note*: When running in clustered node no checking is done to ensure unique job name/group for endpoints. -[[Quartz2-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers Camel adds the getters from the Quartz Execution Context as header values. The following headers are added: + @@ -214,9 +200,7 @@ values. The following headers are added: + The `fireTime` header contains the `java.util.Date` of when the exchange was fired. -[[Quartz2-UsingCronTriggers]] -Using Cron Triggers -^^^^^^^^^^^^^^^^^^^ +### Using Cron Triggers Quartz supports http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/crontrigger[Cron-like @@ -249,9 +233,7 @@ valid URI syntax: |`+` | _Space_ |======================================================================= -[[Quartz2-Specifyingtimezone]] -Specifying time zone -^^^^^^^^^^^^^^^^^^^^ +### Specifying time zone The Quartz Scheduler allows you to configure time zone per trigger. For example to use a timezone of your country, then you can do as follows: @@ -263,9 +245,7 @@ quartz2://groupName/timerName?cron=0+0/5+12-18+?+*+MON-FRI&trigger.timeZone=Euro The timeZone value is the values accepted by `java.util.TimeZone`. -[[Quartz2-UsingQuartzScheduledPollConsumerScheduler]] -Using QuartzScheduledPollConsumerScheduler -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### Using QuartzScheduledPollConsumerScheduler The link:quartz2.html[Quartz2] component provides a link:polling-consumer.html[Polling Consumer] scheduler which allows to @@ -325,9 +305,7 @@ use the following as well: .to("bean:process"); -------------------------------------------------------------------- -[[Quartz2-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -335,5 +313,4 @@ See Also * link:getting-started.html[Getting Started] * link:quartz.html[Quartz] -* link:timer.html[Timer] - +* link:timer.html[Timer] \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-quickfix/src/main/docs/quickfix-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-quickfix/src/main/docs/quickfix-component.adoc b/components/camel-quickfix/src/main/docs/quickfix-component.adoc index 7b09d03..aa0f021 100644 --- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc +++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc @@ -1,8 +1,6 @@ -# QuickFix Component +## QuickFix Component [[ConfluenceContent]] -[[Quickfix-QuickFIXJComponent]] -QuickFIX/J Component -~~~~~~~~~~~~~~~~~~~~ +### QuickFIX/J Component The *quickfix* component adapts the http://www.quickfixj.org/[QuickFIX/J] FIX engine for using in Camel . @@ -32,9 +30,7 @@ for this component: </dependency> ---- -[[Quickfix-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source] ---- @@ -69,9 +65,7 @@ quickfix:config.cfg?sessionID=FIX.4.2:MyTradingCompany->SomeExchange quickfix:config.cfg?sessionID=FIX.4.2:MyTradingCompany->SomeExchange&lazyCreateEngine=true ---- -[[Quickfix-Endpoints]] -Endpoints -~~~~~~~~~ +### Endpoints FIX sessions are endpoints for the *quickfix* component. An endpoint URI may specify a single session or all sessions managed by a specific @@ -87,9 +81,7 @@ include the session-related fields in the FIX message being sent. If a session is specified in the URI then the component will automatically inject the session-related fields into the FIX message. -[[Quickfix-Options]] -Options -~~~~~~~ +### Options // component options: START The QuickFix component supports 5 options which are listed below. @@ -127,9 +119,7 @@ The QuickFix component supports 7 endpoint options which are listed below: {% endraw %} // endpoint options: END -[[Quickfix-ExchangeFormat]] -Exchange Format -^^^^^^^^^^^^^^^ +### Exchange Format The exchange headers include information to help with exchange filtering, routing and other processing. The following headers are @@ -157,9 +147,7 @@ dictionary to parse certain types of messages (with repeating groups, for example). By injecting a DataDictionary header in the route after receiving a message string, the FIX engine can properly parse the data. -[[Quickfix-QuickFIXJConfigurationExtensions]] -QuickFIX/J Configuration Extensions -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### QuickFIX/J Configuration Extensions When using QuickFIX/J directly, one typically writes code to create instances of logging adapters, message stores and communication @@ -174,9 +162,7 @@ QuickFIX/J configuration, see the http://www.quickfixj.org/quickfixj/usermanual/usage/configuration.html[QFJ user manual]. -[[Quickfix-CommunicationConnectors]] -Communication Connectors -++++++++++++++++++++++++ +#### Communication Connectors When the component detects an initiator or acceptor session setting in the QuickFIX/J configuration file it will automatically create the @@ -205,9 +191,7 @@ and must be placed in the settings default section. `ThreadedSocketAcceptor` |======================================================================= -[[Quickfix-Logging]] -Logging -+++++++ +#### Logging The QuickFIX/J logger implementation can be specified by including the following settings in the default section of the configuration file. The @@ -234,9 +218,7 @@ will cause this log to be used. |`JdbcDriver` |Use a `JdbcLog` |======================================================================= -[[Quickfix-MessageStore]] -Message Store -+++++++++++++ +#### Message Store The QuickFIX/J message store implementation can be specified by including the following settings in the default section of the @@ -255,18 +237,14 @@ QuickFIX/J settings file. |`SleepycatDatabaseDir` |Use a `SleepcatStore` |============================================= -[[Quickfix-MessageFactory]] -Message Factory -+++++++++++++++ +#### Message Factory A message factory is used to construct domain objects from raw FIX messages. The default message factory is `DefaultMessageFactory`. However, advanced applications may require a custom message factory. This can be set on the QuickFIX/J component. -[[Quickfix-JMX]] -JMX -+++ +#### JMX [width="100%",cols="10%,90%",options="header",] |============================================ @@ -274,9 +252,7 @@ JMX |`UseJmx` |if `Y`, then enable QuickFIX/J JMX |============================================ -[[Quickfix-OtherDefaults]] -Other Defaults -++++++++++++++ +#### Other Defaults The component provides some default settings for what are normally required settings in QuickFIX/J configuration files. `SessionStartTime` @@ -284,9 +260,7 @@ and `SessionEndTime` default to "00:00:00", meaning the session will not be automatically started and stopped. The `HeartBtInt` (heartbeat interval) defaults to 30 seconds. -[[Quickfix-MinimalInitiatorConfigurationExample]] -Minimal Initiator Configuration Example -+++++++++++++++++++++++++++++++++++++++ +#### Minimal Initiator Configuration Example [source] ---- @@ -297,9 +271,7 @@ SenderCompID=YOUR_SENDER TargetCompID=YOUR_TARGET ---- -[[Quickfix-UsingtheInOutMessageExchangePattern]] -Using the InOut Message Exchange Pattern -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using the InOut Message Exchange Pattern *Camel 2.8+* @@ -311,9 +283,7 @@ be a single request message and single reply message to the request. Examples include an OrderStatusRequest message and UserRequest. -[[Quickfix-ImplementingInOutExchangesforConsumers]] -Implementing InOut Exchanges for Consumers -++++++++++++++++++++++++++++++++++++++++++ +#### Implementing InOut Exchanges for Consumers Add "exchangePattern=InOut" to the QuickFIX/J enpoint URI. The `MessageOrderStatusService` in @@ -329,9 +299,7 @@ to the requestor session. .bean(new MarketOrderStatusService()); ---- -[[Quickfix-ImplementingInOutExchangesforProducers]] -Implementing InOut Exchanges for Producers -++++++++++++++++++++++++++++++++++++++++++ +#### Implementing InOut Exchanges for Producers For producers, sending a message will block until a reply is received or a timeout occurs. There @@ -367,9 +335,7 @@ exchange.setProperty(QuickfixjProducer.CORRELATION_CRITERIA_KEY, .withField(OrderID.FIELD, request.getString(OrderID.FIELD))); ---- -[[Quickfix-Example]] -Example -+++++++ +#### Example The source code contains an example called `RequestReplyExample` that demonstrates the InOut exchanges @@ -385,9 +351,7 @@ provided as the web response. The Spring configuration have changed from Camel 2.9 onwards. See further below for example. -[[Quickfix-SpringConfiguration]] -Spring Configuration -^^^^^^^^^^^^^^^^^^^^ +### Spring Configuration *Camel 2.6 - 2.8.x* @@ -462,9 +426,7 @@ settings for both sessions. include::../../test/resources/org/apache/camel/component/quickfixj/QuickfixjSpringTest-context.xml[tags=e1] ---- -[[Quickfix-Exceptionhandling]] -Exception handling -^^^^^^^^^^^^^^^^^^ +### Exception handling QuickFIX/J behavior can be modified if certain exceptions are thrown during processing of a message. If a `RejectLogon` exception is thrown @@ -481,9 +443,7 @@ being processed __synchronously__. If it is processed asynchronously (on another thread), the FIX engine will immediately send the unmodified outgoing message when it's callback method returns. -[[Quickfix-FIXSequenceNumberManagement]] -FIX Sequence Number Management -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### FIX Sequence Number Management If an application exception is thrown during _synchronous_ exchange processing, this will cause QuickFIX/J to not increment incoming FIX @@ -508,9 +468,7 @@ sending messages. See the FIX protocol specifications and the QuickFIX/J documentation for more details about FIX sequence number management. -[[Quickfix-RouteExamples]] -Route Examples -^^^^^^^^^^^^^^ +### Route Examples Several examples are included in the QuickFIX/J component source code (test subdirectories). One of these examples implements a trival trade @@ -546,9 +504,7 @@ from("quickfix:examples/inprocess.cfg?sessionID=FIX.4.2:TRADER->MARKET"). bean(new MyTradeExecutionProcessor()); ---- -[[Quickfix-QuickFIXJComponentPriortoCamel2.5]] -QuickFIX/J Component Prior to Camel 2.5 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### QuickFIX/J Component Prior to Camel 2.5 The *quickfix* component is an implementation of the http://www.quickfixj.org/[QuickFIX/J] engine for Java . This engine @@ -559,9 +515,7 @@ standard. *Note:* The component can be used to send/receives messages to a FIX server. -[[Quickfix-URIformat.1]] -URI format -^^^^^^^^^^ +### URI format [source] ---- @@ -581,9 +535,7 @@ The quickfix-server endpoint must be used to receive from FIX server FIX messages and quickfix-client endpoint in the case that you want to send messages to a FIX gateway. -[[Quickfix-Exchangedataformat]] -Exchange data format -^^^^^^^^^^^^^^^^^^^^ +### Exchange data format The QuickFIX/J engine is like CXF component a messaging bus using MINA as protocol layer to create the socket connection with the FIX engine @@ -602,9 +554,7 @@ dataformat] to transform the FIX message into your own java POJO When a message must be send to QuickFix, then you must create a QuickFix.Message instance. -[[Quickfix-Lazycreatingengines]] -Lazy creating engines -^^^^^^^^^^^^^^^^^^^^^ +### Lazy creating engines From *Camel 2.12.3* onwards, you can configure the QuickFixComponent to lazy create and start the engines, which then only start these @@ -612,9 +562,7 @@ on-demand. For example you can use this when you have multiple Camel applications in a cluster with master/slaves. And want the slaves to be standby. -[[Quickfix-Samples]] -Samples -^^^^^^^ +### Samples Direction : to FIX gateway @@ -638,11 +586,9 @@ Direction : from FIX gateway </route> ---- -[[Quickfix-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] +* link:getting-started.html[Getting Started] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc index 15e99e4..cf8a122 100644 --- a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc +++ b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc @@ -1,4 +1,4 @@ -# RabbitMQ Component +## RabbitMQ Component *Available as of Camel 2.12* @@ -20,9 +20,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[RabbitMQ-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------------------------- @@ -35,9 +33,7 @@ RabbitMQ client default (5672). The exchange name determines which exchange produced messages will sent to. In the case of consumers, the exchange name determines which exchange the queue will bind to. -[[RabbitMQ-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -122,9 +118,7 @@ See http://www.rabbitmq.com/releases/rabbitmq-java-client/current-javadoc/com/rabbitmq/client/ConnectionFactory.html[http://www.rabbitmq.com/releases/rabbitmq-java-client/current-javadoc/com/rabbitmq/client/ConnectionFactory.html] and the AMQP specification for more information on connection options. -[[RabbitMQ-Customconnectionfactory]] -Custom connection factory -~~~~~~~~~~~~~~~~~~~~~~~~~ +### Custom connection factory [source,xml] ---------------------------------------------------------------------------------------- @@ -210,18 +204,14 @@ producer will also set the headers for downstream processors once the exchange has taken place. Any headers set prior to production that the producer sets will be overriden. -[[RabbitMQ-MessageBody]] -Message Body -^^^^^^^^^^^^ +### Message Body The component will use the camel exchange in body as the rabbit mq message body. The camel exchange in object must be convertible to a byte array. Otherwise the producer will throw an exception of unsupported body type. -[[RabbitMQ-Samples]] -Samples -^^^^^^^ +### Samples To receive messages from a queue that is bound to an exchange A with the routing key B, @@ -246,12 +236,9 @@ To send messages to an exchange called C ...to("rabbitmq://localhost/B") ------------------------------- -[[RabbitMQ-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - +* link:getting-started.html[Getting Started] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-restlet/src/main/docs/restlet-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-restlet/src/main/docs/restlet-component.adoc b/components/camel-restlet/src/main/docs/restlet-component.adoc index 55d6abe..99e7c47 100644 --- a/components/camel-restlet/src/main/docs/restlet-component.adoc +++ b/components/camel-restlet/src/main/docs/restlet-component.adoc @@ -1,4 +1,4 @@ -# Restlet Component +## Restlet Component The *Restlet* component provides http://www.restlet.org[Restlet] based link:endpoint.html[endpoints] for consuming and producing RESTful @@ -17,9 +17,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Restlet-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ---------------------------- @@ -57,9 +55,7 @@ synchronous=true as option on the endpoint uris, Or set it on the RestletComponent as a global option so all endpoints inherit this option. -[[Restlet-Options]] -Options -^^^^^^^ +### Options @@ -133,9 +129,7 @@ The Restlet component supports 22 endpoint options which are listed below: // endpoint options: END -[[Restlet-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= @@ -185,21 +179,15 @@ create responses using the API from Restlet. See examples below. the List of CacheDirective of Restlet from the camel message header. |======================================================================= -[[Restlet-MessageBody]] -Message Body -^^^^^^^^^^^^ +### Message Body Camel will store the restlet response from the external server on the OUT body. All headers from the IN message will be copied to the OUT message, so that headers are preserved during routing. -[[Restlet-Samples]] -Samples -^^^^^^^ +### Samples -[[Restlet-RestletEndpointwithAuthentication]] -Restlet Endpoint with Authentication -++++++++++++++++++++++++++++++++++++ +#### Restlet Endpoint with Authentication The following route starts a `restlet` consumer endpoint that listens for `POST` requests on http://localhost:8080. The processor creates a @@ -237,9 +225,7 @@ The sample client gets a response like the following: received [<order foo='1'/>] as an order id = 89531 -------------------------------------------------- -[[Restlet-SinglerestletendpointtoservicemultiplemethodsandURItemplates]] -Single restlet endpoint to service multiple methods and URI templates -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Single restlet endpoint to service multiple methods and URI templates It is possible to create a single route to service multiple HTTP methods using the `restletMethods` option. This snippet also shows how to @@ -264,9 +250,7 @@ The `restletUriPatterns=#uriTemplates` option references the </util:list> -------------------------------------------------------- -[[Restlet-UsingRestletAPItopopulateresponse]] -Using Restlet API to populate response -++++++++++++++++++++++++++++++++++++++ +#### Using Restlet API to populate response *Available as of Camel 2.8* @@ -277,9 +261,7 @@ the response from an inlined Camel link:processor.html[Processor]: *Generating response using Restlet Response API* -[[Restlet-Configuringmaxthreadsoncomponent]] -Configuring max threads on component -++++++++++++++++++++++++++++++++++++ +#### Configuring max threads on component To configure the max threads options you must do this on the component, such as: @@ -291,9 +273,7 @@ such as: </bean> ------------------------------------------------------------------------------- -[[Restlet-UsingtheRestletservletwithinawebapp]] -Using the Restlet servlet within a webapp -+++++++++++++++++++++++++++++++++++++++++ +#### Using the Restlet servlet within a webapp *Available as of Camel 2.8* + There are @@ -386,12 +366,9 @@ well: </repository> -------------------------------------------------- -[[Restlet-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - +* link:getting-started.html[Getting Started] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-rmi/src/main/docs/rmi-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rmi/src/main/docs/rmi-component.adoc b/components/camel-rmi/src/main/docs/rmi-component.adoc index 83f6b5c..f550f54 100644 --- a/components/camel-rmi/src/main/docs/rmi-component.adoc +++ b/components/camel-rmi/src/main/docs/rmi-component.adoc @@ -1,4 +1,4 @@ -# RMI Component +## RMI Component The *rmi:* component binds link:exchange.html[Exchange]s to the RMI protocol (JRMP). @@ -24,9 +24,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[RMI-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------------------------------------------ @@ -43,9 +41,7 @@ rmi://localhost:1099/path/to/service You can append query options to the URI in the following format, `?option=value&option=value&...` -[[RMI-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -75,9 +71,7 @@ The RMI component supports 9 endpoint options which are listed below: // endpoint options: END -[[RMI-Using]] -Using -^^^^^ +### Using To call out to an existing RMI service registered in an RMI registry, create a route similar to the following: @@ -110,12 +104,9 @@ In XML DSL you can do as follows from *Camel 2.7* onwards: </camel:route> ------------------------------------------------------------------------------------------------------------------------ -[[RMI-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - +* link:getting-started.html[Getting Started] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-routebox/src/main/docs/routebox-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-routebox/src/main/docs/routebox-component.adoc b/components/camel-routebox/src/main/docs/routebox-component.adoc index 23139f7..12a61fc 100644 --- a/components/camel-routebox/src/main/docs/routebox-component.adoc +++ b/components/camel-routebox/src/main/docs/routebox-component.adoc @@ -1,4 +1,4 @@ -# RouteBox Component +## RouteBox Component *Available as of Camel 2.6* @@ -49,9 +49,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Routebox-TheneedforaCamelRouteboxendpoint]] -The need for a Camel Routebox endpoint -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### The need for a Camel Routebox endpoint The routebox component is designed to ease integration in complex environments needing @@ -87,9 +85,7 @@ delegate requests to inner fine grained routes to achieve a specific integration objective, collect the final inner result, and continue to progress to the next step along the coarse-grained route. -[[Routebox-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------- @@ -99,9 +95,7 @@ routebox:routeboxname[?options] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Routebox-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -140,18 +134,14 @@ The RouteBox component supports 18 endpoint options which are listed below: // endpoint options: END -[[Routebox-SendingReceivingMessagestofromtheroutebox]] -Sending/Receiving Messages to/from the routebox -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Sending/Receiving Messages to/from the routebox Before sending requests it is necessary to properly configure the routebox by loading the required URI parameters into the Registry as shown below. In the case of Spring, if the necessary beans are declared correctly, the registry is automatically populated by Camel. -[[Routebox-Step1:LoadinginnerroutedetailsintotheRegistry]] -Step 1: Loading inner route details into the Registry -+++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Step 1: Loading inner route details into the Registry [source,java] ------------------------------------------------------------------------------------------------------------ @@ -188,9 +178,7 @@ private JndiRegistry createInnerRegistry() throws Exception { CamelContext context = new DefaultCamelContext(createRegistry()); ------------------------------------------------------------------------------------------------------------ -[[Routebox-Step2:OptionalyusingaDispatchStrategyinsteadofaDispatchMap]] -Step 2: Optionaly using a Dispatch Strategy instead of a Dispatch Map -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Step 2: Optionaly using a Dispatch Strategy instead of a Dispatch Map Using a dispatch Strategy involves implementing the interface _org.apache.camel.component.routebox.strategy.RouteboxDispatchStrategy_ @@ -220,9 +208,7 @@ public class SimpleRouteDispatchStrategy implements RouteboxDispatchStrategy { } ------------------------------------------------------------------------------------------------------------------------------------------------- -[[Routebox-Step2:Launchingarouteboxconsumer]] -Step 2: Launching a routebox consumer -+++++++++++++++++++++++++++++++++++++ +#### Step 2: Launching a routebox consumer When creating a route consumer, note that the # entries in the routeboxUri are matched to the created inner registry, routebuilder list @@ -252,9 +238,7 @@ public void testRouteboxRequests() throws Exception { } ---------------------------------------------------------------------------------------------------------------------- -[[Routebox-Step3:Usingarouteboxproducer]] -Step 3: Using a routebox producer -+++++++++++++++++++++++++++++++++ +#### Step 3: Using a routebox producer When sending requests to the routebox, it is not necessary for producers do not need to know the inner route endpoint URI and they can simply @@ -276,4 +260,4 @@ from ("direct:sendToMapBasedRoutebox") .setHeader("ROUTE_DISPATCH_KEY", constant("addToCatalog")) .to("routebox:multipleRoutes?innerRegistry=#registry&routeBuilders=#routes&dispatchMap=#map") .to("log:Routes operation performed?showAll=true"); ------------------------------------------------------------------------------------------------------------ +----------------------------------------------------------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-rss/src/main/docs/rss-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rss/src/main/docs/rss-component.adoc b/components/camel-rss/src/main/docs/rss-component.adoc index 79e56c1..460170a 100644 --- a/components/camel-rss/src/main/docs/rss-component.adoc +++ b/components/camel-rss/src/main/docs/rss-component.adoc @@ -1,4 +1,4 @@ -# RSS Component +## RSS Component The *rss:* component is used for polling RSS feeds. Camel will default poll the feed every 60th seconds. @@ -24,9 +24,7 @@ version] of http://rometools.github.io/rome/[ROME] hosted on ServiceMix to solve some OSGi https://issues.apache.org/jira/browse/SMX4-510[class loading issues]. -[[RSS-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ---------- @@ -38,9 +36,7 @@ Where `rssUri` is the URI to the RSS feed to poll. You can append query options to the URI in the following format, `?option=value&option=value&...` -[[RSS-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -89,9 +85,7 @@ The RSS component supports 28 endpoint options which are listed below: // endpoint options: END -[[RSS-Exchangedatatypes]] -Exchange data types -^^^^^^^^^^^^^^^^^^^ +### Exchange data types Camel initializes the In body on the Exchange with a ROME `SyndFeed`. Depending on the value of the `splitEntries` flag, Camel returns either @@ -106,9 +100,7 @@ a `SyndFeed` with one `SyndEntry` or a `java.util.List` of `SyndEntrys`. |`splitEntries` |`false` |The entire list of entries from the current feed is set in the exchange. |======================================================================= -[[RSS-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers [width="100%",cols="10%,90%",options="header",] |======================================================================= @@ -117,9 +109,7 @@ Message Headers |`CamelRssFeed` |The entire `SyncFeed` object. |======================================================================= -[[RSS-RSSDataformat]] -RSS Dataformat -^^^^^^^^^^^^^^ +### RSS Dataformat The RSS component ships with an RSS dataformat that can be used to convert between String (as XML) and ROME RSS model objects. @@ -140,9 +130,7 @@ understand them as well, for example if the feed uses `alt=rss`, then you can for example do `from("rss:http://someserver.com/feeds/posts/default?alt=rss&splitEntries=false&consumer.delay=1000";).to("bean:rss");` -[[RSS-Filteringentries]] -Filtering entries -^^^^^^^^^^^^^^^^^ +### Filtering entries You can filter out entries quite easily using XPath, as shown in the data format section above. You can also exploit Camel's @@ -152,14 +140,11 @@ would be: The custom bean for this would be: -[[RSS-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] -* link:atom.html[Atom] - +* link:atom.html[Atom] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-rss/src/main/docs/rss-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rss/src/main/docs/rss-dataformat.adoc b/components/camel-rss/src/main/docs/rss-dataformat.adoc index b43e2cc..1275169 100644 --- a/components/camel-rss/src/main/docs/rss-dataformat.adoc +++ b/components/camel-rss/src/main/docs/rss-dataformat.adoc @@ -1,4 +1,4 @@ -# RSS DataFormat +## RSS DataFormat The RSS component ships with an RSS dataformat that can be used to convert between String (as XML) and ROME RSS model objects. @@ -18,9 +18,7 @@ understand them as well, for example if the feed uses `alt=rss`, then you can for example do `from("rss:http://someserver.com/feeds/posts/default?alt=rss&splitEntries=false&consumer.delay=1000";).to("bean:rss");` -[[RSS-RSSDataformat-Options]] -Options -^^^^^^^ +### Options // dataformat options: START The RSS dataformat supports 1 options which are listed below. @@ -34,6 +32,4 @@ The RSS dataformat supports 1 options which are listed below. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. |======================================================================= {% endraw %} -// dataformat options: END - - +// dataformat options: END \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc ---------------------------------------------------------------------- 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 b68ff28..b8b2657 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 @@ -1,4 +1,4 @@ -# Salesforce Component +## Salesforce Component *Available as of Camel 2.12* @@ -20,9 +20,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Salesforce-URIformat]] -URI format -^^^^^^^^^^ +### URI format The URI scheme for a salesforce component is as follows @@ -34,18 +32,14 @@ salesforce:topic?options You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Salesforce-SupportedSalesforceAPIs]] -Supported Salesforce APIs -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Supported Salesforce APIs The component supports the following Salesforce APIs Producer endpoints can use the following APIs. Most of the APIs process one record at a time, the Query API can retrieve multiple Records. -[[Salesforce-RestAPI]] -Rest API -++++++++ +#### Rest API * getVersions - Gets supported Salesforce REST API versions * getResources - Gets available Salesforce REST Resource endpoints @@ -86,9 +80,7 @@ list of errors while creating the new object. ...to("salesforce:upsertSObject?sObjectIdName=Name")... ----------------------------------------------------------- -[[Salesforce-RestBulkAPI]] -Rest Bulk API -+++++++++++++ +#### Rest Bulk API Producer endpoints can use the following APIs. All Job data formats, i.e. xml, csv, zip/xml, and zip/csv are supported. + @@ -124,9 +116,7 @@ error. ...to("salesforce:createBatchJob").. ---------------------------------------- -[[Salesforce-RestStreamingAPI]] -Rest Streaming API -++++++++++++++++++ +#### Rest Streaming API Consumer endpoints can use the following sytax for streaming endpoints to receive Salesforce notifications on create/update. @@ -145,13 +135,9 @@ To subscribe to an existing topic from("salesforce:CamelTestTopic&sObjectName=Merchandise__c")... ------------------------------------------------------------------- -[[Salesforce-Examples]] -Examples -~~~~~~~~ +### Examples -[[Salesforce-UploadingadocumenttoaContentWorkspace]] -Uploading a document to a ContentWorkspace -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Uploading a document to a ContentWorkspace Create the ContentVersion in Java, using a Processor instance: @@ -191,9 +177,7 @@ Give the output from the processor to the Salesforce component: .to("salesforce:createSObject"); ----------------------------------------------------------------------------------------------------- -[[Salesforce-LimitsAPI]] -Using Salesforce Limits API -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### Using Salesforce Limits API With `salesforce:limits` operation you can fetch of API limits from Salesforce and then act upon that data received. The result of `salesforce:limits` operation is mapped to `org.apache.camel.component.salesforce.api.dto.Limits` @@ -221,9 +205,7 @@ from("direct:querySalesforce") .endChoice() ----------------------------------------------------------------------------------------------------- -[[Salesforce-Approval]] -Working with approvals -^^^^^^^^^^^^^^^^^^^^^^ +### Working with approvals All the properties are named exactly the same as in the Salesforce REST API prefixed with `approval.`. You can set approval properties by setting `approval.PropertyName` of the Endpoint these will be used as template -- meaning @@ -268,9 +250,7 @@ body.put("nextApproverIds", userId); final ApprovalResult result = template.requestBody("direct:example1", body, ApprovalResult.class); ----------------------------------------------------------------------------------------------------- -[[Salesforce-RecentItems]] -Using Salesforce Recent Items API -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### Using Salesforce Recent Items API To fetch the recent items use `salesforce:recent` operation. This operation returns an `java.util.List` of `org.apache.camel.component.salesforce.api.dto.RecentItem` objects (`List<RecentItem>`) that in turn contain @@ -285,8 +265,7 @@ from("direct:fetchRecentItems") .log("${body.name} at ${body.attributes.url}"); ----------------------------------------------------------------------------------------------------- -Working with approvals -^^^^^^^^^^^^^^^^^^^^^^ +### Working with approvals All the properties are named exactly the same as in the Salesforce REST API prefixed with `approval.`. You can set approval properties by setting `approval.PropertyName` of the Endpoint these will be used as template -- meaning @@ -331,9 +310,7 @@ body.put("nextApproverIds", userId); final ApprovalResult result = template.requestBody("direct:example1", body, ApprovalResult.class); ----------------------------------------------------------------------------------------------------- -[[Salesforce-CompositeAPI-Tree]] -Using Salesforce Composite API to submit SObject tree -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### Using Salesforce Composite API to submit SObject tree To create up to 200 records including parent-child relationships use `salesforce:composite-tree` operation. This requires an instance of `org.apache.camel.component.salesforce.api.dto.composite.SObjectTree` in the input @@ -375,9 +352,7 @@ final List<SObjectNode> succeeded = result.get(false); final String firstId = succeeded.get(0).getId(); ----------------------------------------------------------------------------------------------------- -[[Salesforce-CompositeAPI-Batch]] -Using Salesforce Composite API to submit multiple requests in a batch -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### Using Salesforce Composite API to submit multiple requests in a batch The Composite API batch operation (`composite-batch`) allows you to accumulate multiple requests in a batch and then submit them in one go, saving the round trip cost of multiple individual requests. Each response is then received in a list of responses with the order perserved, so that the n-th requests response is in the n-th place of the response. @@ -434,16 +409,12 @@ final Object updateResultData = deleteResult.getResult(); // probably null ----------------------------------------------------------------------------------------------------- -[[Salesforce-CamelSalesforceMavenPlugin]] -Camel Salesforce Maven Plugin -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### Camel Salesforce Maven Plugin This Maven plugin generates DTOs for the Camel link:salesforce.html[Salesforce]. -[[Salesforce-Options]] -Options -^^^^^^^ +### Options @@ -560,12 +531,9 @@ The generated DTOs use Jackson and XStream annotations. All Salesforce field types are supported. Date and time fields are mapped to Joda DateTime, and picklist fields are mapped to generated Java Enumerations. -[[Salesforce-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - +* link:getting-started.html[Getting Started] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc ---------------------------------------------------------------------- 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 3720b4d..b594cb1 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 @@ -1,4 +1,4 @@ -# SAP NetWeaver Component +## SAP NetWeaver Component *Available as of Camel 2.12* @@ -21,9 +21,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[SAPNetWeaver-URIformat]] -URI format -^^^^^^^^^^ +### URI format The URI scheme for a sap netweaver gateway component is as follows @@ -35,9 +33,7 @@ sap-netweaver:https://host:8080/path?username=foo&password=secret You can append query options to the URI in the following format, `?option=value&option=value&...` -[[SAPNetWeaver-Prerequisites]] -Prerequisites -^^^^^^^^^^^^^ +### Prerequisites You would need to have an account to the SAP NetWeaver system to be able to leverage this component. SAP provides a @@ -47,9 +43,7 @@ requires for an account. This component uses the basic authentication scheme for logging into SAP NetWeaver. -[[SAPNetWeaver-Componentandendpointoptions]] -SAPNetWeaver options -^^^^^^^^^^^^^^^^^^^^ +### SAPNetWeaver options // component options: START @@ -77,9 +71,7 @@ The SAP NetWeaver component supports 7 endpoint options which are listed below: // endpoint options: END -[[SAPNetWeaver-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers The following headers can be used by the producer. @@ -92,9 +84,7 @@ http://msdn.microsoft.com/en-us/library/cc956153.aspx[MS ADO.Net Data Service] format. |======================================================================= -[[SAPNetWeaver-Examples]] -Examples -^^^^^^^^ +### Examples This example is using the flight demo example from SAP, which is available online over the internet @@ -176,14 +166,11 @@ Destination city: SAN FRANCISCO Destination airport: SFO ------------------------------- -[[SAPNetWeaver-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] -* link:http.html[HTTP] - +* link:http.html[HTTP] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-saxon/src/main/docs/xquery-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc b/components/camel-saxon/src/main/docs/xquery-component.adoc index ba4730b..4f62111 100644 --- a/components/camel-saxon/src/main/docs/xquery-component.adoc +++ b/components/camel-saxon/src/main/docs/xquery-component.adoc @@ -1,4 +1,4 @@ -# XQuery Component +## XQuery Component Camel supports http://www.w3.org/TR/xquery/[XQuery] to allow an link:expression.html[Expression] or link:predicate.html[Predicate] to be @@ -8,9 +8,7 @@ link:predicate.html[Predicate] in a link:message-filter.html[Message Filter] or as an link:expression.html[Expression] for a link:recipient-list.html[Recipient List]. -[[XQuery-Options]] -Options -^^^^^^^ +### Options @@ -74,9 +72,7 @@ The XQuery component supports 31 endpoint options which are listed below: // endpoint options: END -[[XQuery-Examples]] -Examples -^^^^^^^^ +### Examples [source,java] --------------------------- @@ -96,9 +92,7 @@ from("direct:start"). recipientList().xquery("concat('mock:foo.', /person/@city)", String.class); ----------------------------------------------------------------------------- -[[XQuery-Variables]] -Variables -^^^^^^^^^ +### Variables The IN message body will be set as the `contextItem`. Besides this these Variables is also added as parameters: @@ -125,9 +119,7 @@ with they own key name, for instance if there is an IN header with the key name *foo* then its added as *foo*. |======================================================================= -[[XQuery-UsingXMLconfiguration]] -Using XML configuration -^^^^^^^^^^^^^^^^^^^^^^^ +### Using XML configuration If you prefer to configure your routes in your link:spring.html[Spring] XML file then you can use XPath expressions as follows @@ -165,9 +157,7 @@ attribute: <xquery type="java.lang.String">concat('mock:foo.', /person/@city)</xquery> ------------------------------------------------------------------------------- -[[XQuery-UsingXQueryastransformation]] -Using XQuery as transformation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using XQuery as transformation We can do a message translation using transform or setBody in the route, as shown below: @@ -190,9 +180,7 @@ from("direct:start"). Â -[[XQuery-UsingXQueryasanendpoint]] -Using XQuery as an endpoint -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using XQuery as an endpoint Sometimes an XQuery expression can be quite large; it can essentally be used for link:templating.html[Templating]. So you may want to use an @@ -213,9 +201,7 @@ The following example shows how to take a message of an ActiveMQ queue </camelContext> ------------------------------------------------------------------------- -[[XQuery-Examples.1]] -Examples -^^^^^^^^ +### Examples Here is a simple http://svn.apache.org/repos/asf/camel/trunk/components/camel-saxon/src/test/java/org/apache/camel/builder/saxon/XQueryFilterTest.java[example] @@ -227,9 +213,7 @@ http://svn.apache.org/repos/asf/camel/trunk/components/camel-saxon/src/test/java uses XQuery with namespaces as a predicate in a link:message-filter.html[Message Filter] -[[XQuery-LearningXQuery]] -Learning XQuery -^^^^^^^^^^^^^^^ +### Learning XQuery XQuery is a very powerful language for querying, searching, sorting and returning XML. For help learning XQuery try these tutorials @@ -242,9 +226,7 @@ Tutorial] You might also find the http://www.w3.org/TR/xpath-functions/[XQuery function reference] useful -[[XQuery-Loadingscriptfromexternalresource]] -Loading script from external resource -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Loading script from external resource *Available as of Camel 2.11* @@ -258,9 +240,7 @@ eg to refer to a file on the classpath you can do: .setHeader("myHeader").xquery("resource:classpath:myxquery.txt", String.class) ------------------------------------------------------------------------------ -[[XQuery-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use XQuery in your camel routes you need to add the a dependency on *camel-saxon* which implements the XQuery language. @@ -276,4 +256,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-saxon</artifactId> <version>x.x.x</version> </dependency> --------------------------------------- +-------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-saxon/src/main/docs/xquery-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-saxon/src/main/docs/xquery-language.adoc b/components/camel-saxon/src/main/docs/xquery-language.adoc index 852c9f2..4f31903 100644 --- a/components/camel-saxon/src/main/docs/xquery-language.adoc +++ b/components/camel-saxon/src/main/docs/xquery-language.adoc @@ -1,4 +1,4 @@ -# XQuery Language +## XQuery Language Camel supports http://www.w3.org/TR/xquery/[XQuery] to allow an link:expression.html[Expression] or link:predicate.html[Predicate] to be @@ -8,9 +8,7 @@ link:predicate.html[Predicate] in a link:message-filter.html[Message Filter] or as an link:expression.html[Expression] for a link:recipient-list.html[Recipient List]. -[[XQuery-Options]] -XQuery Language options -^^^^^^^^^^^^^^^^^^^^^^^ +### XQuery Language options // language options: START The XQuery language supports 3 options which are listed below. @@ -28,9 +26,7 @@ The XQuery language supports 3 options which are listed below. {% endraw %} // language options: END -[[XQuery-Examples]] -Examples -^^^^^^^^ +### Examples [source,java] --------------------------- @@ -50,9 +46,7 @@ from("direct:start"). recipientList().xquery("concat('mock:foo.', /person/@city)", String.class); ----------------------------------------------------------------------------- -[[XQuery-Variables]] -Variables -^^^^^^^^^ +### Variables The IN message body will be set as the `contextItem`. Besides this these Variables is also added as parameters: @@ -79,9 +73,7 @@ with they own key name, for instance if there is an IN header with the key name *foo* then its added as *foo*. |======================================================================= -[[XQuery-UsingXMLconfiguration]] -Using XML configuration -^^^^^^^^^^^^^^^^^^^^^^^ +### Using XML configuration If you prefer to configure your routes in your link:spring.html[Spring] XML file then you can use XPath expressions as follows @@ -119,9 +111,7 @@ attribute: <xquery type="java.lang.String">concat('mock:foo.', /person/@city)</xquery> ------------------------------------------------------------------------------- -[[XQuery-UsingXQueryastransformation]] -Using XQuery as transformation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using XQuery as transformation We can do a message translation using transform or setBody in the route, as shown below: @@ -144,9 +134,7 @@ from("direct:start"). Â -[[XQuery-UsingXQueryasanendpoint]] -Using XQuery as an endpoint -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using XQuery as an endpoint Sometimes an XQuery expression can be quite large; it can essentally be used for link:templating.html[Templating]. So you may want to use an @@ -167,9 +155,7 @@ The following example shows how to take a message of an ActiveMQ queue </camelContext> ------------------------------------------------------------------------- -[[XQuery-Examples.1]] -Examples -^^^^^^^^ +### Examples Here is a simple http://svn.apache.org/repos/asf/camel/trunk/components/camel-saxon/src/test/java/org/apache/camel/builder/saxon/XQueryFilterTest.java[example] @@ -181,9 +167,7 @@ http://svn.apache.org/repos/asf/camel/trunk/components/camel-saxon/src/test/java uses XQuery with namespaces as a predicate in a link:message-filter.html[Message Filter] -[[XQuery-LearningXQuery]] -Learning XQuery -^^^^^^^^^^^^^^^ +### Learning XQuery XQuery is a very powerful language for querying, searching, sorting and returning XML. For help learning XQuery try these tutorials @@ -196,9 +180,7 @@ Tutorial] You might also find the http://www.w3.org/TR/xpath-functions/[XQuery function reference] useful -[[XQuery-Loadingscriptfromexternalresource]] -Loading script from external resource -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Loading script from external resource *Available as of Camel 2.11* @@ -212,9 +194,7 @@ eg to refer to a file on the classpath you can do: .setHeader("myHeader").xquery("resource:classpath:myxquery.txt", String.class) ------------------------------------------------------------------------------ -[[XQuery-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use XQuery in your camel routes you need to add the a dependency on *camel-saxon* which implements the XQuery language. @@ -230,4 +210,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-saxon</artifactId> <version>x.x.x</version> </dependency> --------------------------------------- +-------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-schematron/src/main/docs/schematron-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-schematron/src/main/docs/schematron-component.adoc b/components/camel-schematron/src/main/docs/schematron-component.adoc index 2de9dfa..bb5c23b 100644 --- a/components/camel-schematron/src/main/docs/schematron-component.adoc +++ b/components/camel-schematron/src/main/docs/schematron-component.adoc @@ -1,4 +1,4 @@ -# Schematron Component +## Schematron Component *Available as of Camel 2.14* @@ -17,18 +17,14 @@ written in a way that Schematron rules are loaded at the start of the endpoint (only once) this is to minimise the overhead of instantiating a Java Templates object representing the rules. -[[Schematron-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------- schematron://path?[options] --------------------------- -[[Schematron-URIoptions]] -URI options -^^^^^^^^^^^ +### URI options // component options: START @@ -58,9 +54,7 @@ The Schematron component supports 5 endpoint options which are listed below: -[[Schematron-Headers]] -Headers -^^^^^^^ +### Headers [width="100%",cols="10%,10%,10%,70%",options="header",] |======================================================================= @@ -71,9 +65,7 @@ Headers |CamelSchematronValidationReport |The schematrion report body in XML format. See an example below |String |IN |======================================================================= -[[Schematron-URIandpathsyntax]] -URI and path syntax -^^^^^^^^^^^^^^^^^^^ +### URI and path syntax The following example shows how to invoke the schematron processor in Java DSL. The schematron rules file is sourced from the class path: @@ -124,9 +116,7 @@ an update, all you need is to restart the route or the component. No harm in storing these rules in the class path though, but you will have to build and deploy the component to pick up the changes. -[[Schematron-Schematronrulesandreportsamples]] -Schematron rules and report samples -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Schematron rules and report samples Here is an example of schematron rules @@ -175,5 +165,4 @@ TIP: *Useful Links and resources* to Schematron]Â by Mulleberry technologies. An excellent document in PDF to get you started on Schematron. * http://www.schematron.com[Schematron official site]. This contains -links to other resources - +links to other resources \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-script/src/main/docs/javaScript-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-script/src/main/docs/javaScript-language.adoc b/components/camel-script/src/main/docs/javaScript-language.adoc index 2dc2fca..a4dfdfa 100644 --- a/components/camel-script/src/main/docs/javaScript-language.adoc +++ b/components/camel-script/src/main/docs/javaScript-language.adoc @@ -1,4 +1,4 @@ -# JavaScript Language +## JavaScript Language Camel supports http://en.wikipedia.org/wiki/JavaScript[JavaScript/ECMAScript] among @@ -19,9 +19,7 @@ link:predicate.html[Predicate] in a link:message-filter.html[Message Filter] or as an link:expression.html[Expression] for a link:recipient-list.html[Recipient List] -[[JavaScript-Language-options]] -Javascript Language Options -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Javascript Language Options // language options: START The JavaScript language supports 1 options which are listed below. @@ -37,9 +35,7 @@ The JavaScript language supports 1 options which are listed below. {% endraw %} // language options: END -[[JavaScript-Example]] -Example -^^^^^^^ +### Example In the sample below we use JavaScript to create a link:predicate.html[Predicate] use in the route path, to route exchanges @@ -72,9 +68,7 @@ And a Spring DSL sample as well: </route> ------------------------------------------------------------------------------- -[[JavaScript-ScriptContext]] -ScriptContext -^^^^^^^^^^^^^ +### ScriptContext The JSR-223 scripting languages ScriptContext is pre configured with the following attributes all set at `ENGINE_SCOPE`: @@ -102,9 +96,7 @@ further below for example. See link:scripting-languages.html[Scripting Languages] for the list of languages with explicit DSL support. -[[JavaScript-AdditionalargumentstoScriptingEngine]] -Additional arguments to ScriptingEngine -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Additional arguments to ScriptingEngine *Available as of Camel 2.8* @@ -112,9 +104,7 @@ You can provide additional arguments to the `ScriptingEngine` using a header on the Camel message with the key `CamelScriptArguments`. + See this example: -[[JavaScript-Usingpropertiesfunction]] -Using properties function -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using properties function *Available as of Camel 2.9* @@ -139,9 +129,7 @@ same example is simpler: .setHeader("myHeader").groovy("properties.resolve(request.headers.get('foo'))") ------------------------------------------------------------------------------- -[[JavaScript-Loadingscriptfromexternalresource]] -Loading script from external resource -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Loading script from external resource *Available as of Camel 2.11* @@ -155,9 +143,7 @@ eg to refer to a file on the classpath you can do: .setHeader("myHeader").groovy("resource:classpath:mygroovy.groovy") ------------------------------------------------------------------- -[[JavaScript-Howtogettheresultfrommultiplestatementsscript]] -How to get the result from multiple statements script -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to get the result from multiple statements script *Available as of Camel 2.14* @@ -177,9 +163,7 @@ result = body * 2 + 1 Â -[[JavaScript-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use scripting languages in your camel routes you need to add the a dependency on *camel-script* which integrates the JSR-223 scripting @@ -196,4 +180,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-script</artifactId> <version>x.x.x</version> </dependency> ---------------------------------------- +--------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-script/src/main/docs/php-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-script/src/main/docs/php-language.adoc b/components/camel-script/src/main/docs/php-language.adoc index c7dcb13..d7c8a01 100644 --- a/components/camel-script/src/main/docs/php-language.adoc +++ b/components/camel-script/src/main/docs/php-language.adoc @@ -1,4 +1,4 @@ -# PHP Language +## PHP Language Camel supports http://www.php.net/[PHP] among other link:scripting-languages.html[Scripting Languages] to allow an @@ -18,9 +18,7 @@ link:predicate.html[Predicate] in a link:message-filter.html[Message Filter] or as an link:expression.html[Expression] for a link:recipient-list.html[Recipient List] -[[PHP-Language-options]] -PHP Language Options -^^^^^^^^^^^^^^^^^^^^ +### PHP Language Options // language options: START The PHP language supports 1 options which are listed below. @@ -36,9 +34,7 @@ The PHP language supports 1 options which are listed below. {% endraw %} // language options: END -[[PHP-ScriptContext]] -ScriptContext -^^^^^^^^^^^^^ +### ScriptContext The JSR-223 scripting languages ScriptContext is pre configured with the following attributes all set at `ENGINE_SCOPE`: @@ -66,9 +62,7 @@ further below for example. See link:scripting-languages.html[Scripting Languages] for the list of languages with explicit DSL support. -[[PHP-AdditionalargumentstoScriptingEngine]] -Additional arguments to ScriptingEngine -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Additional arguments to ScriptingEngine *Available as of Camel 2.8* @@ -76,9 +70,7 @@ You can provide additional arguments to the `ScriptingEngine` using a header on the Camel message with the key `CamelScriptArguments`. + See this example: -[[PHP-Usingpropertiesfunction]] -Using properties function -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using properties function *Available as of Camel 2.9* @@ -103,9 +95,7 @@ same example is simpler: .setHeader("myHeader").groovy("properties.resolve(request.headers.get('foo'))") ------------------------------------------------------------------------------- -[[PHP-Loadingscriptfromexternalresource]] -Loading script from external resource -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Loading script from external resource *Available as of Camel 2.11* @@ -119,9 +109,7 @@ eg to refer to a file on the classpath you can do: .setHeader("myHeader").groovy("resource:classpath:mygroovy.groovy") ------------------------------------------------------------------- -[[PHP-Howtogettheresultfrommultiplestatementsscript]] -How to get the result from multiple statements script -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to get the result from multiple statements script *Available as of Camel 2.14* @@ -141,9 +129,7 @@ result = body * 2 + 1 Â -[[PHP-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use scripting languages in your camel routes you need to add the a dependency on *camel-script* which integrates the JSR-223 scripting @@ -160,4 +146,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-script</artifactId> <version>x.x.x</version> </dependency> ---------------------------------------- +--------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-script/src/main/docs/python-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-script/src/main/docs/python-language.adoc b/components/camel-script/src/main/docs/python-language.adoc index aa4fd07..b9d26b7 100644 --- a/components/camel-script/src/main/docs/python-language.adoc +++ b/components/camel-script/src/main/docs/python-language.adoc @@ -1,4 +1,4 @@ -# Python Language +## Python Language Camel supports http://www.python.org/[Python] among other link:scripting-languages.html[Scripting Languages] to allow an @@ -18,9 +18,7 @@ link:predicate.html[Predicate] in a link:message-filter.html[Message Filter] or as an link:expression.html[Expression] for a link:recipient-list.html[Recipient List] -[[Python-Language-options]] -Python Language Options -^^^^^^^^^^^^^^^^^^^^^^^ +### Python Language Options // language options: START The Python language supports 1 options which are listed below. @@ -36,9 +34,7 @@ The Python language supports 1 options which are listed below. {% endraw %} // language options: END -[[Python-Example]] -Example -^^^^^^^ +### Example In the sample below we use Python to create a link:predicate.html[Predicate] use in the route path, to route exchanges @@ -71,9 +67,7 @@ And a Spring DSL sample as well: </route> ------------------------------------------------------------------- -[[Python-ScriptContext]] -ScriptContext -^^^^^^^^^^^^^ +### ScriptContext The JSR-223 scripting languages ScriptContext is pre configured with the following attributes all set at `ENGINE_SCOPE`: @@ -101,9 +95,7 @@ further below for example. See link:scripting-languages.html[Scripting Languages] for the list of languages with explicit DSL support. -[[Python-AdditionalargumentstoScriptingEngine]] -Additional arguments to ScriptingEngine -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Additional arguments to ScriptingEngine *Available as of Camel 2.8* @@ -111,9 +103,7 @@ You can provide additional arguments to the `ScriptingEngine` using a header on the Camel message with the key `CamelScriptArguments`. + See this example: -[[Python-Usingpropertiesfunction]] -Using properties function -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using properties function *Available as of Camel 2.9* @@ -138,9 +128,7 @@ same example is simpler: .setHeader("myHeader").groovy("properties.resolve(request.headers.get('foo'))") ------------------------------------------------------------------------------- -[[Python-Loadingscriptfromexternalresource]] -Loading script from external resource -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Loading script from external resource *Available as of Camel 2.11* @@ -154,9 +142,7 @@ eg to refer to a file on the classpath you can do: .setHeader("myHeader").groovy("resource:classpath:mygroovy.groovy") ------------------------------------------------------------------- -[[Python-Howtogettheresultfrommultiplestatementsscript]] -How to get the result from multiple statements script -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to get the result from multiple statements script *Available as of Camel 2.14* @@ -176,9 +162,7 @@ result = body * 2 + 1 Â -[[Python-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use scripting languages in your camel routes you need to add the a dependency on *camel-script* which integrates the JSR-223 scripting @@ -195,4 +179,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-script</artifactId> <version>x.x.x</version> </dependency> ---------------------------------------- +--------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-script/src/main/docs/ruby-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-script/src/main/docs/ruby-language.adoc b/components/camel-script/src/main/docs/ruby-language.adoc index 7a3e83e..6f11c00 100644 --- a/components/camel-script/src/main/docs/ruby-language.adoc +++ b/components/camel-script/src/main/docs/ruby-language.adoc @@ -1,4 +1,4 @@ -# Ruby Language +## Ruby Language Camel supports http://www.ruby-lang.org/en/[Ruby] among other link:scripting-languages.html[Scripting Languages] to allow an @@ -18,9 +18,7 @@ link:predicate.html[Predicate] in a link:message-filter.html[Message Filter] or as an link:expression.html[Expression] for a link:recipient-list.html[Recipient List] -[[Ruby-Language-options]] -Ruby Language Options -^^^^^^^^^^^^^^^^^^^^^ +### Ruby Language Options // language options: START The Ruby language supports 1 options which are listed below. @@ -36,9 +34,7 @@ The Ruby language supports 1 options which are listed below. {% endraw %} // language options: END -[[Ruby-Example]] -Example -^^^^^^^ +### Example In the sample below we use Ruby to create a link:predicate.html[Predicate] use in the route path, to route exchanges @@ -71,9 +67,7 @@ And a Spring DSL sample as well: </route> ---------------------------------------------------------------- -[[Ruby-ScriptContext]] -ScriptContext -^^^^^^^^^^^^^ +### ScriptContext The JSR-223 scripting languages ScriptContext is pre configured with the following attributes all set at `ENGINE_SCOPE`: @@ -101,9 +95,7 @@ further below for example. See link:scripting-languages.html[Scripting Languages] for the list of languages with explicit DSL support. -[[Ruby-AdditionalargumentstoScriptingEngine]] -Additional arguments to ScriptingEngine -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Additional arguments to ScriptingEngine *Available as of Camel 2.8* @@ -111,9 +103,7 @@ You can provide additional arguments to the `ScriptingEngine` using a header on the Camel message with the key `CamelScriptArguments`. + See this example: -[[Ruby-Usingpropertiesfunction]] -Using properties function -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using properties function *Available as of Camel 2.9* @@ -138,9 +128,7 @@ same example is simpler: .setHeader("myHeader").groovy("properties.resolve(request.headers.get('foo'))") ------------------------------------------------------------------------------- -[[Ruby-Loadingscriptfromexternalresource]] -Loading script from external resource -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Loading script from external resource *Available as of Camel 2.11* @@ -154,9 +142,7 @@ eg to refer to a file on the classpath you can do: .setHeader("myHeader").groovy("resource:classpath:mygroovy.groovy") ------------------------------------------------------------------- -[[Ruby-Howtogettheresultfrommultiplestatementsscript]] -How to get the result from multiple statements script -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to get the result from multiple statements script *Available as of Camel 2.14* @@ -176,9 +162,7 @@ result = body * 2 + 1 Â -[[Ruby-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use scripting languages in your camel routes you need to add the a dependency on *camel-script* which integrates the JSR-223 scripting @@ -195,4 +179,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-script</artifactId> <version>x.x.x</version> </dependency> ---------------------------------------- +--------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-servicenow/src/main/docs/servicenow-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-servicenow/src/main/docs/servicenow-component.adoc b/components/camel-servicenow/src/main/docs/servicenow-component.adoc index 258ec81..8ce386b 100644 --- a/components/camel-servicenow/src/main/docs/servicenow-component.adoc +++ b/components/camel-servicenow/src/main/docs/servicenow-component.adoc @@ -1,4 +1,4 @@ -# ServiceNow Component +## ServiceNow Component *Available as of Camel 2.18* @@ -19,18 +19,14 @@ for this component: </dependency> ------------------------------------------------- -[[ServiceNow-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------------- servicenow://instanceName?[options] --------------------------------------- -[[ServiceNow-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -108,9 +104,7 @@ The ServiceNow component supports 41 endpoint options which are listed below: -[[ServiceNow-Headers]] -Headers -^^^^^^^ +### Headers [width="100%",cols="10%,10%,10%,10%,60%",options="header",] |=== @@ -263,9 +257,7 @@ NOTE: link:http://wiki.servicenow.com/index.php?title=REST_API#Available_APIs[Fu NOTE: https://docs.servicenow.com/bundle/helsinki-servicenow-platform/page/integrate/inbound-rest/reference/r_RESTResources.html[Helsinki REST API Documentation] -[[ServiceNow-Usageexamples]] -Usage examples: -^^^^^^^^^^^^^^^ +### Usage examples: Â {% raw %} [source,java] @@ -292,4 +284,4 @@ FluentProducerTemplate.on(context) .to("direct:servicenow") .send(); ------------------------------------------------------------------------------------------------------------------- -{% endraw %} +{% endraw %} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-servlet/src/main/docs/servlet-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-servlet/src/main/docs/servlet-component.adoc b/components/camel-servlet/src/main/docs/servlet-component.adoc index bc35e2e..30209cd 100644 --- a/components/camel-servlet/src/main/docs/servlet-component.adoc +++ b/components/camel-servlet/src/main/docs/servlet-component.adoc @@ -1,4 +1,4 @@ -# Servlet Component +## Servlet Component The *servlet:* component provides HTTP based link:endpoint.html[endpoints] for consuming HTTP requests that arrive at @@ -27,9 +27,7 @@ body appears to be empty or you need to access the data multiple times link:stream-caching.html[Stream caching] or convert the message body to a `String` which is safe to be read multiple times. -[[SERVLET-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------- @@ -39,9 +37,7 @@ servlet://relative_path[?options] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[SERVLET-Options]] -Options -^^^^^^^ +### Options // component options: START The Servlet component supports 7 options which are listed below. @@ -96,9 +92,7 @@ The Servlet component supports 22 endpoint options which are listed below: {% endraw %} // endpoint options: END -[[SERVLET-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers Camel will apply the same Message Headers as the link:http.html[HTTP] component. @@ -108,18 +102,14 @@ Camel will also populate *all* `request.parameter` and `http://myserver/myserver?orderid=123`, the exchange will contain a header named `orderid` with the value 123. -[[SERVLET-Usage]] -Usage -^^^^^ +### Usage You can consume only from endpoints generated by the Servlet component. Therefore, it should be used only as input into your Camel routes. To issue HTTP requests against other HTTP endpoints, use the link:http.html[HTTP Component] -[[SERVLET-PuttingCamelJARsintheappserverbootclasspath]] -Putting Camel JARs in the app server boot classpath -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Putting Camel JARs in the app server boot classpath If you put the Camel JARs such as `camel-core`, `camel-servlet`, etc. in the boot classpath of your application server (eg usually in its lib @@ -178,9 +168,7 @@ But its *strongly advised* to use unique servlet-name for each Camel application to avoid this duplication clash, as well any unforeseen side-effects. -[[SERVLET-Sample]] -Sample -^^^^^^ +### Sample INFO: From Camel 2.7 onwards it's easier to use link:servlet.html[Servlet] in Spring web applications. See link:servlet-tomcat-example.html[Servlet @@ -204,15 +192,11 @@ endpoint uses the relative path to specify the endpoint's URL. A client can access the `camel-servlet` endpoint through the servlet publish address: `("http://localhost:8080/camel/services";) + RELATIVE_PATH("/hello")`. -[[SERVLET-SamplewhenusingSpring3.x]] -Sample when using Spring 3.x -++++++++++++++++++++++++++++ +#### Sample when using Spring 3.x See link:servlet-tomcat-example.html[Servlet Tomcat Example] -[[SERVLET-SamplewhenusingSpring2.x]] -Sample when using Spring 2.x -++++++++++++++++++++++++++++ +#### Sample when using Spring 2.x When using the Servlet component in a Camel/Spring application it's often required to load the Spring ApplicationContext _after_ the Servlet @@ -243,9 +227,7 @@ like this: <web-app> ------------------------------------------------------------------------- -[[SERVLET-SamplewhenusingOSGi]] -Sample when using OSGi -++++++++++++++++++++++ +#### Sample when using OSGi From *Camel 2.6.0*, you can publish the http://svn.apache.org/repos/asf/camel/trunk/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/CamelHttpTransportServlet.java[CamelHttpTransportServlet] @@ -258,9 +240,7 @@ the http://svn.apache.org/repos/asf/camel/trunk/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/CamelHttpTransportServlet.java[CamelHttpTransportServlet] on the OSGi platform -[[SERVLET-Spring-Boot]] -Usage with Spring-Boot -++++++++++++++++++++++ +#### 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 following table summarizes the additional configuration properties available in the camel-servlet-starter library. @@ -276,9 +256,7 @@ The automatic mapping of the Camel servlet can also be disabled. |======================================================================= {% endraw %} -[[SERVLET-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -289,5 +267,4 @@ See Also * link:servlet-tomcat-no-spring-example.html[Servlet Tomcat No Spring Example] * link:http.html[HTTP] -* link:jetty.html[Jetty] - +* link:jetty.html[Jetty] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-sip/src/main/docs/sip-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sip/src/main/docs/sip-component.adoc b/components/camel-sip/src/main/docs/sip-component.adoc index 082d621..4b405ed 100644 --- a/components/camel-sip/src/main/docs/sip-component.adoc +++ b/components/camel-sip/src/main/docs/sip-component.adoc @@ -1,4 +1,4 @@ -# SIP Component +## SIP Component *Available as of Camel 2.5* @@ -45,9 +45,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Sip-URIformat]] -URI format -^^^^^^^^^^ +### URI format The URI scheme for a sip endpoint is as follows: @@ -63,9 +61,7 @@ UDP. You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Sip-Options]] -Options -^^^^^^^ +### Options The SIP Component offers an extensive set of configuration options & capability to create custom stateful headers needed to propagate state @@ -134,13 +130,9 @@ The SIP component supports 45 endpoint options which are listed below: {% endraw %} // endpoint options: END -[[Sip-SendingMessagestofromaSIPendpoint]] -Sending Messages to/from a SIP endpoint -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Sending Messages to/from a SIP endpoint -[[Sip-CreatingaCamelSIPPublisher]] -Creating a Camel SIP Publisher -++++++++++++++++++++++++++++++ +#### Creating a Camel SIP Publisher In the example below, a SIP Publisher is created to send SIP Event publications to + @@ -164,9 +156,7 @@ producerTemplate.sendBodyAndHeader( Request.PUBLISH); ---------------------------------------------------------------------------------------------------------------------------------------------- -[[Sip-CreatingaCamelSIPSubscriber]] -Creating a Camel SIP Subscriber -+++++++++++++++++++++++++++++++ +#### Creating a Camel SIP Subscriber In the example below, a SIP Subscriber is created to receive SIP Event publications sent to + @@ -208,4 +198,4 @@ and is capable of communicating with both Publisher as well as Subscriber. It has a separate SIP stackName distinct from Publisher as well as Subscriber. While it is set up as a Camel Consumer, it does not actually send any messages along the route to the endpoint -"mock:neverland". +"mock:neverland". \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-sjms/src/main/docs/sjms-batch-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc index 98d6671..241b47d 100644 --- a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc @@ -1,8 +1,6 @@ -# Simple JMS Batch Component +## Simple JMS Batch Component [[ConfluenceContent]] -[[SJMSBatch-SJMSBatchComponent]] -SJMS Batch Component -~~~~~~~~~~~~~~~~~~~~ +### SJMS Batch Component *Available as of Camel 2.16* @@ -78,9 +76,7 @@ for this component: </dependency> ---- -[[SJMSBatch-URIformat]] -URI format -++++++++++ +#### URI format [source] ---- @@ -110,9 +106,7 @@ broker. A plain link:sjms.html[SJMS] consumer endpoint can be used in conjunction with a regular non-persistence backed link:aggregator2.html[aggregator] in this scenario. -[[SJMSBatch-ComponentOptionsandConfigurations]] -Component Options and Configurations -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Component Options and Configurations @@ -182,4 +176,4 @@ The Simple JMS Batch component supports 23 endpoint options which are listed bel The `completionSize` endpoint attribute is used in conjunction with `completionTimeout`, where the first condition to be met will cause the -aggregated `Exchange` to be emitted down the route. +aggregated `Exchange` to be emitted down the route. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-sjms/src/main/docs/sjms-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sjms/src/main/docs/sjms-component.adoc b/components/camel-sjms/src/main/docs/sjms-component.adoc index 7cb31cc..3e74bfc 100644 --- a/components/camel-sjms/src/main/docs/sjms-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-component.adoc @@ -1,4 +1,4 @@ -# Simple JMS Component +## Simple JMS Component ifdef::env-github[] :icon-smile: :smiley: :caution-caption: :boom: @@ -14,9 +14,7 @@ ifndef::env-github[] endif::[] [[ConfluenceContent]] -[[SJMS-SJMSComponent]] -SJMS Component -~~~~~~~~~~~~~~ +### SJMS Component *Available as of Camel 2.11* @@ -61,9 +59,7 @@ for this component: </dependency> ---- -[[SJMS-URIformat]] -URI format -++++++++++ +#### URI format [source] ---- @@ -97,9 +93,7 @@ sjms:topic:Stocks.Prices You append query options to the URI using the following format, `?option=value&option=value&...` -[[SJMS-ComponentOptionsandConfigurations]] -Component Options and Configurations -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Component Options and Configurations @@ -212,13 +206,9 @@ component.setConnectionResource(connectionResource); component.setMaxConnections(1); ---- -[[SJMS-ProducerUsage]] -Producer Usage -^^^^^^^^^^^^^^ +### Producer Usage -[[SJMS-InOnlyProducer]] -InOnly Producer - (Default) -+++++++++++++++++++++++++++ +#### InOnly Producer - (Default) The _InOnly_ producer is the default behavior of the SJMS Producer Endpoint. @@ -229,9 +219,7 @@ from("direct:start") .to("sjms:queue:bar"); ---- -[[SJMS-InOutProducer]] -InOut Producer -++++++++++++++ +#### InOut Producer To enable _InOut_ behavior append the `exchangePattern` attribute to the URI. By default it will use a dedicated TemporaryQueue for each @@ -252,13 +240,9 @@ from("direct:start") .to("sjms:queue:bar?exchangePattern=InOut&namedReplyTo=my.reply.to.queue"); ---- -[[SJMS-ConsumerUsage]] -Consumer Usage -^^^^^^^^^^^^^^ +### Consumer Usage -[[SJMS-InOnlyConsumer]] -InOnly Consumer - (Default) -+++++++++++++++++++++++++++ +#### InOnly Consumer - (Default) The _InOnly_ xonsumer is the default Exchange behavior of the SJMS Consumer Endpoint. @@ -269,9 +253,7 @@ from("sjms:queue:bar") .to("mock:result"); ---- -[[SJMS-InOutConsumer]] -InOut Consumer -++++++++++++++ +#### InOut Consumer To enable _InOut_ behavior append the `exchangePattern` attribute to the URI. @@ -282,13 +264,9 @@ from("sjms:queue:in.out.test?exchangePattern=InOut") .transform(constant("Bye Camel")); ---- -[[SJMS-AdvancedUsageNotes]] -Advanced Usage Notes -^^^^^^^^^^^^^^^^^^^^ +### Advanced Usage Notes -[[SJMS-PlugableConnectionResourceManagementconnectionresource]] -Plugable Connection Resource Management [[SJMS-connectionresource]] -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Plugable Connection Resource Management [[SJMS-connectionresource]] SJMS provides JMS http://docs.oracle.com/javaee/5/api/javax/jms/Connection.html[`Connection`] @@ -370,15 +348,11 @@ camelContext.addComponent("sjms", component); To see the full example of its usage please refer to the https://svn.apache.org/repos/asf/camel/trunk/components/camel-sjms/src/test/java/org/apache/camel/component/sjms/it/ConnectionResourceIT.java[`ConnectionResourceIT`]. -[[SJMS-Session,Consumer,&ProducerPooling&CachingManagement]] -Session, Consumer, & Producer Pooling & Caching Management -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Session, Consumer, & Producer Pooling & Caching Management Coming soon ... -[[SJMS-BatchMessageSupport]] -Batch Message Support -+++++++++++++++++++++ +#### Batch Message Support The SjmsProducer supports publishing a collection of messages by creating an Exchange that encapsulates a `List`. This SjmsProducer will @@ -411,9 +385,7 @@ Then publish the list: template.sendBody("sjms:queue:batch.queue", messages); ---- -[[SJMS-CustomizableTransactionCommitStrategies]] -Customizable Transaction Commit Strategies (Local JMS Transactions only) -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Customizable Transaction Commit Strategies (Local JMS Transactions only) SJMS provides a developer the means to create a custom and plugable transaction strategy through the use of the @@ -426,9 +398,7 @@ is the https://svn.apache.org/repos/asf/camel/trunk/components/camel-sjms/src/main/java/org/apache/camel/component/sjms/tx/BatchTransactionCommitStrategy.java[`BatchTransactionCommitStrategy`] which is detailed further in the next section. -[[SJMS-TransactedBatchConsumersAndProducers]] -Transacted Batch Consumers & Producers -++++++++++++++++++++++++++++++++++++++ +#### Transacted Batch Consumers & Producers The SJMS component has been designed to support the batching of local JMS transactions on both the Producer and Consumer endpoints. How they are @@ -499,13 +469,9 @@ Now publish the List with transactions enabled: template.sendBody("sjms:queue:batch.queue?transacted=true", messages); ---- -[[SJMS-AdditionalNotes]] -Additional Notes -^^^^^^^^^^^^^^^^ +### Additional Notes -[[SJMS-MessageHeaderFormat]] -Message Header Format -+++++++++++++++++++++ +#### Message Header Format The SJMS Component uses the same header format strategy that is used in the Camel JMS Component. This plugable strategy ensures that messages @@ -530,9 +496,7 @@ custom strategy for formatting keys. For the `exchange.in.header`, the following rules apply for the header values: -[[SJMS-MessageContent]] -Message Content -+++++++++++++++ +#### Message Content To deliver content over the wire we must ensure that the body of the message that is being delivered adheres to the JMS Message @@ -542,9 +506,7 @@ The types, `String`, `CharSequence`, `Date`, `BigDecimal` and `BigInteger` are a converted to their `toString()` representation. All other types are dropped. -[[SJMS-Clustering]] -Clustering -++++++++++ +#### Clustering When using _InOut_ with SJMS in a clustered environment you must either use TemporaryQueue destinations or use a unique named reply to @@ -561,17 +523,13 @@ The _InOut_ Consumer uses this strategy as well ensuring that all responses messages to the included `JMSReplyTo` destination also have the `JMSCorrelationId` copied from the request as well. -[[SJMS-TransactionSupporttransactions]] -Transaction Support [[SJMS-transactions]] -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Transaction Support [[SJMS-transactions]] SJMS currently only supports the use of internal JMS Transactions. There is no support for the Camel Transaction Processor or the Java Transaction API (JTA). -[[SJMS-DoesSpringlessMeanICantUseSpring]] -Does Springless Mean I Can't Use Spring? -++++++++++++++++++++++++++++++++++++++++ +#### Does Springless Mean I Can't Use Spring? Not at all. Below is an example of the SJMS component using the Spring DSL: @@ -589,4 +547,4 @@ DSL: Springless refers to moving away from the dependency on the Spring JMS API. A new JMS client API is being developed from the ground up to power -SJMS. +SJMS. \ No newline at end of file
