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 2016/06/17 09:52:36 UTC
camel git commit: Added stub component docs to Gitbook
Repository: camel
Updated Branches:
refs/heads/master 0de807d39 -> 0fd6d7089
Added stub component 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/0fd6d708
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0fd6d708
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0fd6d708
Branch: refs/heads/master
Commit: 0fd6d7089b14c57bc18d7fbc3538ffa621dbf7fa
Parents: 0de807d
Author: Andrea Cosentino <an...@gmail.com>
Authored: Fri Jun 17 11:51:32 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Fri Jun 17 11:51:32 2016 +0200
----------------------------------------------------------------------
camel-core/src/main/docs/stub.adoc | 103 ++++++++++++++++++++++++++++++++
docs/user-manual/en/SUMMARY.md | 1 +
2 files changed, 104 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/0fd6d708/camel-core/src/main/docs/stub.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/stub.adoc b/camel-core/src/main/docs/stub.adoc
new file mode 100644
index 0000000..8760d06
--- /dev/null
+++ b/camel-core/src/main/docs/stub.adoc
@@ -0,0 +1,103 @@
+[[Stub-StubComponent]]
+Stub Component
+~~~~~~~~~~~~~~
+
+*Available as of Camel 2.10*
+
+The *stub:* component provides a simple way to stub out any physical
+endpoints while in development or testing, allowing you for example to
+run a route without needing to actually connect to a specific
+link:mail.html[SMTP] or link:http.html[Http] endpoint. Just add *stub:*
+in front of any endpoint URI to stub out the endpoint.
+
+Internally the Stub component creates link:vm.html[VM] endpoints. The
+main difference between link:stub.html[Stub] and link:vm.html[VM] is
+that link:vm.html[VM] will validate the URI and parameters you give it,
+so putting vm: in front of a typical URI with query arguments will
+usually fail. Stub won't though, as it basically ignores all query
+parameters to let you quickly stub out one or more endpoints in your
+route temporarily.
+
+[[Stub-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+------------
+stub:someUri
+------------
+
+Where *`someUri`* can be any URI with any query parameters.
+
+[[Stub-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The Stub component supports 3 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| queueSize | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
+| concurrentConsumers | int | Sets the default number of concurrent threads processing exchanges.
+| defaultQueueFactory | Exchange> | Sets the default queue factory.
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+// endpoint options: START
+The Stub component supports 17 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| name | common | | String | *Required* Name of queue
+| size | common | 2147483647 | int | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
+| 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.
+| concurrentConsumers | consumer | 1 | int | Number of concurrent threads processing exchanges.
+| 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.
+| limitConcurrentConsumers | consumer (advanced) | true | boolean | Whether to limit the number of concurrentConsumers to the maximum of 500. By default an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off.
+| multipleConsumers | consumer (advanced) | false | boolean | Specifies whether multiple consumers are allowed. If enabled you can use SEDA for Publish-Subscribe messaging. That is you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint.
+| pollTimeout | consumer (advanced) | 1000 | int | The timeout used when polling. When a timeout occurs the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown.
+| purgeWhenStopping | consumer (advanced) | false | boolean | Whether to purge the task queue when stopping the consumer/route. This allows to stop faster as any pending messages on the queue is discarded.
+| blockWhenFull | producer | false | boolean | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default an exception will be thrown stating that the queue is full. By enabling this option the calling thread will instead block and wait until the message can be accepted.
+| discardIfNoConsumers | producer | false | boolean | Whether the producer should discard the message (do not add the message to the queue) when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time.
+| failIfNoConsumers | producer | false | boolean | Whether the producer should fail by throwing an exception when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time.
+| timeout | producer | 30000 | long | Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value.
+| waitForTaskToComplete | producer | IfReplyExpected | WaitForTaskToComplete | Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always Never or IfReplyExpected. The first two values are self-explanatory. The last value IfReplyExpected will only wait if the message is Request Reply based. The default option is IfReplyExpected.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange.
+| queue | advanced | | BlockingQueue | Define the queue instance which will be used by the endpoint. This option is only for rare use-cases where you want to use a custom queue instance.
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+
+[[Stub-Examples]]
+Examples
+^^^^^^^^
+
+Here are a few samples:
+
+* stub:smtp://somehost.foo.com?user=whatnot&something=else
+*
+stub:http://somehost.bar.com/something[http://somehost.bar.com/something]
+
+[[Stub-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:configuring-camel.html[Configuring Camel]
+* link:component.html[Component]
+* link:endpoint.html[Endpoint]
+* link:getting-started.html[Getting Started]
+
http://git-wip-us.apache.org/repos/asf/camel/blob/0fd6d708/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 7aa1c16..aa81c87 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -92,6 +92,7 @@
* [Rest](rest.adoc)
* [Scheduler](scheduler.adoc)
* [Seda](seda.adoc)
+ * [Stub](stub.adoc)
* Components
* [Async Http Client (AHC)](ahc.adoc)