Repository: camel Updated Branches: refs/heads/master eb51dfb5f -> 127aa76b1
Added camel-krati docs to Gitbook Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/127aa76b Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/127aa76b Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/127aa76b Branch: refs/heads/master Commit: 127aa76b1056742c7eb176593e8ab6b1b01e6427 Parents: b26440c Author: Andrea Cosentino <anco...@gmail.com> Authored: Tue May 3 08:59:33 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Tue May 3 08:59:54 2016 +0200 ---------------------------------------------------------------------- components/camel-krati/src/main/docs/krati.adoc | 214 +++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 215 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/127aa76b/components/camel-krati/src/main/docs/krati.adoc ---------------------------------------------------------------------- diff --git a/components/camel-krati/src/main/docs/krati.adoc b/components/camel-krati/src/main/docs/krati.adoc new file mode 100644 index 0000000..72c7d8f --- /dev/null +++ b/components/camel-krati/src/main/docs/krati.adoc @@ -0,0 +1,214 @@ +[[Krati-KratiComponent]] +Krati Component +~~~~~~~~~~~~~~~ + +*Available as of Camel 2.9* + +This component allows the use krati datastores and datasets inside +Camel. Krati is a simple persistent data store with very low latency and +high throughput. It is designed for easy integration with +read-write-intensive applications with little effort in tuning +configuration, performance and JVM garbage collection. + +Camel provides a producer and consumer for krati datastore_(key/value +engine)_. It also provides an idempotent repository for filtering out +duplicate messages. + +Maven users will need to add the following dependency to their `pom.xml` +for this component: + +[source,xml] +------------------------------------------------------------ +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-krati</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +------------------------------------------------------------ + +[[Krati-URIformat]] +URI format +^^^^^^^^^^ + +[source,java] +------------------------------------------- +krati:[the path of the datastore][?options] +------------------------------------------- + +The *path of the datastore* is the relative path of the folder that +krati will use for its datastore. + +You can append query options to the URI in the following format, +`?option=value&option=value&...` + +[[Krati-KratiOptions]] +Krati Options +^^^^^^^^^^^^^ + + +// component options: START +The Krati component has no options. +// component options: END + + + +// endpoint options: START +The Krati component supports 30 endpoint options which are listed below: + +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| path | common | | String | *Required* Path of the datastore is the relative path of the folder that krati will use for its datastore. +| hashFunction | common | | HashFunction<byte[]> | The hash function to use. +| initialCapacity | common | 100 | int | The inital capcity of the store. +| keySerializer | common | | Object> | The serializer that will be used to serialize the key. +| segmentFactory | common | | SegmentFactory | Sets the segment factory of the target store. +| segmentFileSize | common | 64 | int | Data store segments size in MB. +| valueSerializer | common | | Object> | The serializer that will be used to serialize the value. +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| maxMessagesPerPoll | consumer | | int | The maximum number of messages which can be received in one poll. This can be used to avoid reading in too much data and taking up too much memory. +| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. +| key | producer | | String | The key. +| operation | producer | | String | Specifies the type of operation that will be performed to the datastore. +| value | producer | | String | The Value. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. +| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. +| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. +| delay | scheduler | 500 | long | Milliseconds before the next poll. +| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. +| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. +| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. +| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. +| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component +| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. +| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. +| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. +| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +|======================================================================= +// endpoint options: END + + +[source,java] +------------------------------------------------------------------------------------------------ +krati:/tmp/krati?operation=CamelKratiGet&initialCapacity=10000&keySerializer=#myCustomSerializer +------------------------------------------------------------------------------------------------ + +For producer endpoint you can override all of the above URI options by +passing the appropriate headers to the message. + +[[Krati-MessageHeadersfordatastore]] +Message Headers for datastore ++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,90%",options="header",] +|======================================================================= +|Header |Description + +|`CamelKratiOperation` |The operation to be performed on the datastore. The valid options are CamelKratiAdd, CamelKratiGet, +CamelKratiDelete, CamelKratiDeleteAll + +|`CamelKratiKey` |The key. + +|`CamelKratiValue` |The value. +|======================================================================= + +[[Krati-UsageSamples]] +Usage Samples +^^^^^^^^^^^^^ + +[[Krati-Example1:Puttingtothedatastore.]] +Example 1: Putting to the datastore. +++++++++++++++++++++++++++++++++++++ + +This example will show you how you can store any message inside a +datastore. + +[source,java] +-------------------------------------------------------- +from("direct:put").to("krati:target/test/producertest"); +-------------------------------------------------------- + +In the above example you can override any of the URI parameters with +headers on the message. + + Here is how the above example would look like using xml to define our +route. + +[source,xml] +------------------------------------------------------------ + <route> + <from uri="direct:put"/> + <to uri="krati:target/test/producerspringtest"/> + </route> +------------------------------------------------------------ + +[[Krati-Example2:GettingReadingfromadatastore]] +Example 2: Getting/Reading from a datastore ++++++++++++++++++++++++++++++++++++++++++++ + +This example will show you how you can read the contnet of a datastore. + +[source,java] +-------------------------------------------------------------------------------------------- +from("direct:get") + .setHeader(KratiConstants.KRATI_OPERATION, constant(KratiConstants.KRATI_OPERATION_GET)) + .to("krati:target/test/producertest"); +-------------------------------------------------------------------------------------------- + +In the above example you can override any of the URI parameters with +headers on the message. + + Here is how the above example would look like using xml to define our +route. + +[source,xml] +----------------------------------------------------------------------------- +<route> + <from uri="direct:get"/> + <to uri="krati:target/test/producerspringtest?operation=CamelKratiGet"/> +</route> +----------------------------------------------------------------------------- + +[[Krati-Example3:Consumingfromadatastore]] +Example 3: Consuming from a datastore ++++++++++++++++++++++++++++++++++++++ + +This example will consume all items that are under the specified +datastore. + +[source,java] +------------------------------------------ + from("krati:target/test/consumertest") + .to("direct:next"); +------------------------------------------ + +You can achieve the same goal by using xml, as you can see below. + +[source,xml] +------------------------------------------------------ +<route> + <from uri="krati:target/test/consumerspringtest"/> + <to uri="mock:results"/> +</route> +------------------------------------------------------ + +[[Krati-IdempotentRepository]] +Idempotent Repository +^^^^^^^^^^^^^^^^^^^^^ + +As already mentioned this component also offers and idemptonet +repository which can be used for filtering out duplicate messages. + +[source,java] +----------------------------------------------------------------------------------------------------------------------------- +from("direct://in").idempotentConsumer(header("messageId"), new KratiIdempotentRepositroy("/tmp/idempotent").to("log://out"); +----------------------------------------------------------------------------------------------------------------------------- + +[[Krati-Seealso]] +See also +++++++++ + +http://sna-projects.com/krati/[Krati Website] http://git-wip-us.apache.org/repos/asf/camel/blob/127aa76b/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 9fe3f00..4c283c4 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -179,6 +179,7 @@ * [JT400](jt400.adoc) * [Kafka](kafka.adoc) * [Kestrel](kestrel.adoc) + * [Krati](krati.adoc) * [Metrics](metrics.adoc) * [Mock](mock.adoc) * [NATS](nats.adoc)
