Added camel-stomp 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/ca0215d4 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/ca0215d4 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/ca0215d4 Branch: refs/heads/master Commit: ca0215d487560a1b47b77ca27346cc18ceb329cd Parents: 8a4dc40 Author: Andrea Cosentino <anco...@gmail.com> Authored: Wed Jun 8 15:40:36 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Wed Jun 8 15:40:36 2016 +0200 ---------------------------------------------------------------------- components/camel-stomp/src/main/docs/stomp.adoc | 143 +++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 144 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/ca0215d4/components/camel-stomp/src/main/docs/stomp.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stomp/src/main/docs/stomp.adoc b/components/camel-stomp/src/main/docs/stomp.adoc new file mode 100644 index 0000000..7278411 --- /dev/null +++ b/components/camel-stomp/src/main/docs/stomp.adoc @@ -0,0 +1,143 @@ +[[Stomp-StompComponent]] +Stomp Component +~~~~~~~~~~~~~~~ + +*Available as of Camel 2.12* + +The *stomp:* component is used for communicating with +http://stomp.github.io/[Stomp] compliant message brokers, like +http://activemq.apache.org[Apache ActiveMQ] or +http://activemq.apache.org/apollo/[ActiveMQ Apollo] + +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-stomp</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +------------------------------------------------------------ + +[[Stomp-URIformat]] +URI format +^^^^^^^^^^ + +[source,java] +--------------------------------- +stomp:queue:destination[?options] +--------------------------------- + +Where *destination* is the name of the queue. + +[[Stomp-Options]] +Options +^^^^^^^ + + +// component options: START +The Stomp component supports 5 options which are listed below. + + + +{% raw %} +[width="100%",cols="2s,1m,8",options="header"] +|======================================================================= +| Name | Java Type | Description +| configuration | StompConfiguration | To use the shared stomp configuration +| brokerURL | String | The URI of the Stomp broker to connect to +| login | String | The username +| passcode | String | The password +| host | String | The virtual host +|======================================================================= +{% endraw %} +// component options: END + + + +// endpoint options: START +The Stomp component supports 10 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| destination | common | | String | *Required* Name of the queue +| brokerURL | common | tcp://localhost:61613 | String | *Required* The URI of the Stomp broker to connect to +| host | common | | String | The virtual host name +| login | common | | String | The username +| passcode | common | | String | The password +| 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. +| 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. +| 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). +| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters +|======================================================================= +{% endraw %} +// endpoint options: END + + +You can append query options to the URI in the following format, +`?option=value&option=value&...` + +[[Stomp-Samples]] +Samples +^^^^^^^ + +Sending messages: + +[source,java] +------------------------------------------ +from("direct:foo").to("stomp:queue:test"); +------------------------------------------ + +Consuming messages: + +[source,java] +------------------------------------------------------------------------------ +from("stomp:queue:test").transform(body().convertToString()).to("mock:result") +------------------------------------------------------------------------------ + +[[Stomp-Endpoints]] +Endpoints +~~~~~~~~~ + +Camel supports the link:message-endpoint.html[Message Endpoint] pattern +using the +http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html[Endpoint] +interface. Endpoints are usually created by a +link:component.html[Component] and Endpoints are usually referred to in +the link:dsl.html[DSL] via their link:uris.html[URIs]. + +From an Endpoint you can use the following methods + +* +http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html#createProducer()[createProducer()] +will create a +http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Producer.html[Producer] +for sending message exchanges to the endpoint +* +http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html#createConsumer(org.apache.camel.Processor)[createConsumer()] +implements the link:event-driven-consumer.html[Event Driven Consumer] +pattern for consuming message exchanges from the endpoint via a +http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Processor.html[Processor] +when creating a +http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Consumer.html[Consumer] +* +http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html#createPollingConsumer()[createPollingConsumer()] +implements the link:polling-consumer.html[Polling Consumer] pattern for +consuming message exchanges from the endpoint via a +http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/PollingConsumer.html[PollingConsumer] + +[[Stomp-SeeAlso]] +See Also +^^^^^^^^ + +* link:configuring-camel.html[Configuring Camel] +* link:message-endpoint.html[Message Endpoint] pattern +* link:uris.html[URIs] +* link:writing-components.html[Writing Components] + http://git-wip-us.apache.org/repos/asf/camel/blob/ca0215d4/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index c1c2329..2d0a2d1 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -259,6 +259,7 @@ * [SQL-Stored](sql-stored.adoc) * [SSH](ssh.adoc) * [StAX](stax.adoc) + * [Stomp](stomp.adoc) * [Telegram](telegram.adoc) * [Twitter](twitter.adoc) * [Websocket](websocket.adoc)
