camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject camel git commit: Added camel-spring-integration docs to Gitbook
Date Tue, 07 Jun 2016 09:40:29 GMT
Repository: camel
Updated Branches:
  refs/heads/master f1cb15b5b -> 6ad8f24d6


Added camel-spring-integration 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/6ad8f24d
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6ad8f24d
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6ad8f24d

Branch: refs/heads/master
Commit: 6ad8f24d628fc5f815dadfb2143fd7720ae95e39
Parents: f1cb15b
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Tue Jun 7 11:40:01 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Tue Jun 7 11:40:01 2016 +0200

----------------------------------------------------------------------
 .../src/main/docs/spring-integration.adoc       | 114 +++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |   1 +
 2 files changed, 115 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/6ad8f24d/components/camel-spring-integration/src/main/docs/spring-integration.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-integration/src/main/docs/spring-integration.adoc b/components/camel-spring-integration/src/main/docs/spring-integration.adoc
new file mode 100644
index 0000000..9d88661
--- /dev/null
+++ b/components/camel-spring-integration/src/main/docs/spring-integration.adoc
@@ -0,0 +1,114 @@
+[[SpringIntegration-SpringIntegrationComponent]]
+Spring Integration Component
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The *spring-integration:* component provides a bridge for Camel
+components to talk to
+http://www.springsource.org/spring-integration[spring integration
+endpoints].
+
+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-spring-integration</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[SpringIntegration-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+-----------------------------------------------
+spring-integration:defaultChannelName[?options]
+-----------------------------------------------
+
+Where *defaultChannelName* represents the default channel name which is
+used by the Spring Integration Spring context. It will equal to the
+`inputChannel` name for the Spring Integration consumer and the
+`outputChannel` name for the Spring Integration provider.
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+[[SpringIntegration-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The Spring Integration component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The Spring Integration component supports 8 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| defaultChannel | common |  | String | *Required* The default channel name which is used
by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring
Integration consumer and the outputChannel name for the Spring Integration provider.
+| inOut | common | false | boolean | The exchange pattern that the Spring integration endpoint
should use. If inOut=true then a reply channel is expected either from the Spring Integration
Message header or configured on the endpoint.
+| 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.
+| inputChannel | consumer |  | String | The Spring integration input channel name that this
endpoint wants to consume from Spring integration.
+| 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.
+| outputChannel | producer |  | String | The Spring integration output channel name that
is used to send messages to Spring integration.
+| 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).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[SpringIntegration-Usage]]
+Usage
+^^^^^
+
+The Spring integration component is a bridge that connects Camel
+endpoints with Spring integration endpoints through the Spring
+integration's input channels and output channels. Using this component,
+we can send Camel messages to Spring Integration endpoints or receive
+messages from Spring integration endpoints in a Camel routing context.
+
+[[SpringIntegration-Examples]]
+Examples
+^^^^^^^^
+
+[[SpringIntegration-UsingtheSpringintegrationendpoint]]
+Using the Spring integration endpoint
++++++++++++++++++++++++++++++++++++++
+
+You can set up a Spring integration endpoint using a URI, as follows:
+
+Or directly using a Spring integration channel name:
+
+[[SpringIntegration-TheSourceandTargetadapter]]
+The Source and Target adapter
++++++++++++++++++++++++++++++
+
+Spring integration also provides the Spring integration's source and
+target adapters, which can route messages from a Spring integration
+channel to a Camel endpoint or from a Camel endpoint to a Spring
+integration channel.
+
+This example uses the following namespaces:
+
+You can bind your source or target to a Camel endpoint as follows:
+
+[[SpringIntegration-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/6ad8f24d/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 9893865..5cf62e7 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -249,6 +249,7 @@
     * [Spring-Batch](spring-batch.adoc)
     * [Spring-Boot](spring-boot.adoc)
     * [Spring-Event](spring-event.adoc)
+    * [Spring-Integration](spring-integration.adoc)
     * [Telegram](telegram.adoc)
     * [Twitter](twitter.adoc)
     * [Websocket](websocket.adoc)


Mime
View raw message