You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2017/01/12 12:16:15 UTC
[5/7] camel git commit: CAMEL-10375: Added first spike of
documentation
CAMEL-10375: Added first spike of documentation
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/a9da1c48
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/a9da1c48
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/a9da1c48
Branch: refs/heads/master
Commit: a9da1c480f70342d61b6b10c296dc5b83b1acd1a
Parents: 0f1f14f
Author: Andrea Cosentino <an...@gmail.com>
Authored: Thu Jan 12 11:47:24 2017 +0100
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Thu Jan 12 13:14:46 2017 +0100
----------------------------------------------------------------------
.../camel-couchbase-starter/pom.xml | 2 +-
.../src/main/docs/couchbase-component.adoc | 92 ++++++++++++++++++++
2 files changed, 93 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/a9da1c48/components-starter/camel-couchbase-starter/pom.xml
----------------------------------------------------------------------
diff --git a/components-starter/camel-couchbase-starter/pom.xml b/components-starter/camel-couchbase-starter/pom.xml
index d4a53f2..c88c9c2 100644
--- a/components-starter/camel-couchbase-starter/pom.xml
+++ b/components-starter/camel-couchbase-starter/pom.xml
@@ -24,7 +24,7 @@
</parent>
<artifactId>camel-couchbase-starter</artifactId>
<packaging>jar</packaging>
- <name>Spring-Boot Starter :: Camel Extra :: Couchbase</name>
+ <name>Spring-Boot Starter :: Camel :: Couchbase</name>
<description>Spring-Boot Starter for Camel Couchbase component</description>
<dependencies>
<dependency>
http://git-wip-us.apache.org/repos/asf/camel/blob/a9da1c48/components/camel-couchbase/src/main/docs/couchbase-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-couchbase/src/main/docs/couchbase-component.adoc b/components/camel-couchbase/src/main/docs/couchbase-component.adoc
new file mode 100644
index 0000000..f4072c7
--- /dev/null
+++ b/components/camel-couchbase/src/main/docs/couchbase-component.adoc
@@ -0,0 +1,92 @@
+# Couchbase Component
+## Couchbase Component
+
+*Available as of Camel 2.19*
+
+The *couchbase:* component allows you to treat
+https://www.couchbase.com/[CouchBase] instances as a producer or consumer
+of 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-couchbase</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+### URI format
+
+[source,java]
+-------------------------------------------------
+couchbase:url
+-------------------------------------------------
+
+### Options
+
+// component options: START
+The Couchbase component has no options.
+// component options: END
+
+// endpoint options: START
+The Couchbase component supports 47 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| protocol | common | | String | The protocol to use
+| additionalHosts | common | | String | The additional hosts
+| autoStartIdForInserts | common | false | boolean | Define if we want an autostart Id when we are doing an insert operation
+| consumerProcessedStrategy | common | | String | Define the consumer Processed strategy to use
+| descending | common | false | boolean | Define if this operation is descending or not
+| designDocumentName | common | | String | The design document name to use
+| key | common | | String | The key to use
+| limit | common | | int | The output limit to use
+| maxReconnectDelay | common | | long | Define the max delay during a reconnection
+| obsPollInterval | common | | long | Define the observation polling interval
+| obsTimeout | common | | long | Define the observation timeout
+| operation | common | | String | The operation to do
+| opQueueMaxBlockTime | common | | long | Define the max time an operation can be in queue blocked
+| opTimeOut | common | | long | Define the operation timeout
+| password | common | | String | The password to use
+| persistTo | common | | int | Where to persist the data
+| producerRetryAttempts | common | | int | Define the number of retry attempts
+| producerRetryPause | common | | int | Define the retry pause between different attempts
+| rangeEndKey | common | | String | Define a range for the end key
+| rangeStartKey | common | | String | Define a range for the start key
+| readBufferSize | common | | int | Define the buffer size
+| replicateTo | common | | int | Where to replicate the data
+| shouldOptimize | common | false | boolean | Define if we want to use optimization or not where possible
+| skip | common | | int | Define the skip to use
+| startingIdForInsertsFrom | common | | long | Define the starting Id where we are doing an insert operation
+| timeoutExceptionThreshold | common | | int | Define the threshold for throwing a timeout Exception
+| username | common | | String | The username to use
+| viewName | common | | String | The view name to use
+| 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 or ERROR level and ignored.
+| 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 or ERROR level and ignored.
+| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
+| 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.
+| 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. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| 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. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| 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.
+|=======================================================================
+{% endraw %}
+// endpoint options: END