From ec71247c9e0d32f2e57737edba068c228d6d4469 Mon Sep 17 00:00:00 2001 From: Gary Russell Date: Thu, 12 Dec 2013 16:55:44 +0200 Subject: [PATCH] INT-3043 Add Endpoint Quick Reference Table JIRA: https://jira.springsource.org/browse/INT-3043 INT-3043: Polishing --- src/reference/docbook/amqp.xml | 6 +- src/reference/docbook/channel-adapter.xml | 2 +- src/reference/docbook/endpoint-summary.xml | 225 +++++++++++++++++++++ src/reference/docbook/gemfire.xml | 6 +- src/reference/docbook/index.xml | 5 +- 5 files changed, 235 insertions(+), 9 deletions(-) create mode 100644 src/reference/docbook/endpoint-summary.xml diff --git a/src/reference/docbook/amqp.xml b/src/reference/docbook/amqp.xml index 2fc36fbd91..a487da810e 100644 --- a/src/reference/docbook/amqp.xml +++ b/src/reference/docbook/amqp.xml @@ -282,7 +282,7 @@ this list can also be simple patterns to be matched against the header names (e. -
+
Outbound Channel Adapter A configuration sample for an AMQP Outbound Channel Adapter is shown @@ -378,7 +378,7 @@ this list can also be simple patterns to be matched against the header names (e.
-
+
Inbound Gateway A configuration sample for an AMQP Inbound Gateway is shown below. @@ -434,7 +434,7 @@ this list can also be simple patterns to be matched against the header names (e.
-
+
Outbound Gateway A configuration sample for an AMQP Outbound Gateway is shown below. diff --git a/src/reference/docbook/channel-adapter.xml b/src/reference/docbook/channel-adapter.xml index d8868b2267..b5a1383b75 100644 --- a/src/reference/docbook/channel-adapter.xml +++ b/src/reference/docbook/channel-adapter.xml @@ -84,7 +84,7 @@
- Configuring Outbound Channel Adapter + Configuring An Outbound Channel Adapter An "outbound-channel-adapter" element can also connect a MessageChannel to any POJO consumer method that should be invoked with the payload of Messages sent to that channel. diff --git a/src/reference/docbook/endpoint-summary.xml b/src/reference/docbook/endpoint-summary.xml new file mode 100644 index 0000000000..6a5c9d7443 --- /dev/null +++ b/src/reference/docbook/endpoint-summary.xml @@ -0,0 +1,225 @@ + + + Endpoint Quick Reference Table + + As discussed in the sections above, Spring Integration provides a number of endpoints used + to interface with external systems, file systems etc. The following is a summary of the various + endpoints with quick links to the appropriate chapter. + + + To recap, Inbound Channel Adapters are used for one-way integration + bringing data into the messagng application. Outbound Channel Adapters + are used for one-way integration to send data out of the messaging application. + Inbound Gateways are used for a bidirectional integration flow where + some other system invokes the messaging application and receives a reply. + Outbound Gateways are used for a bidirectional integration flow where + the messaging application invokes some external service or entity, expecting a result. + + + + + + + + + + + Module + Inbound Adapter + Outbound Adapter + Inbound Gateway + Outbound Gateway + + + + + AMQP + + + + + + + Events + + + N + N + + + Feed + + N + N + N + + + File + and + + N + + + + FTP(S) + + + N + + + + Gemfire + and + + N + N + + + HTTP + + + + + + + JDBC + and + and + N + and + + + JMS + and + + + + + + JMX + and + and + + and + + N + + + + JPA + + + N + and + + + Mail + + + N + N + + + MongoDB + + + N + N + + + Redis + and + and + + and + and + + N + N + + + Resource + + N + N + N + + + RMI + N + N + + + + + SFTP + + + N + + + + Stream + + + N + N + + + Syslog + + N + N + N + + + TCP + + + + + + + Twitter + + + N + N + + + UDP + + + N + N + + + Web Services + N + N + + + + + XMPP + and + and + N + N + + + +
+ + In addition, as discussed in , endpoints are provided + for interfacing with Plain Old Java Objects + (POJOs). As discussed in , the <int:inbound-channel-adapter> + allows polling a java method for data; the + <int:outbound-channel-adapter> allows sending data to a void method, and + as discussed in , the <int:gateway> allows any Java program + to invoke a messaging flow. Each of these without requiring any source level + dependencies on Spring Integration. The equivalent of an outbound gateway in this context would be to use a + to invoke a method that returns an Object of some kind. + + diff --git a/src/reference/docbook/gemfire.xml b/src/reference/docbook/gemfire.xml index 6bcc648d4a..df9edb4100 100644 --- a/src/reference/docbook/gemfire.xml +++ b/src/reference/docbook/gemfire.xml @@ -28,7 +28,7 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/gemfire http://www.springframework.org/schema/integration/gemfire/spring-integration-gemfire.xsd"]]>
-
+
Inbound Channel Adapter The inbound-channel-adapter produces messages on a channel triggered by a GemFire EntryEvent. GemFire @@ -49,7 +49,7 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/gemfire If expression is not provided the message payload will be a GemFire EntryEvent
-
+
Continuous Query Inbound Channel Adapter The cq-inbound-channel-adapter produces messages a channel triggered by a GemFire continuous query or CqEvent event. Spring GemFire introduced @@ -90,7 +90,7 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/gemfire
-
+
Outbound Channel Adapter The outbound-channel-adapter writes cache entries mapped from the message payload. In its simplest form, it expects a diff --git a/src/reference/docbook/index.xml b/src/reference/docbook/index.xml index 4f38687421..d1a7ba6bf2 100644 --- a/src/reference/docbook/index.xml +++ b/src/reference/docbook/index.xml @@ -115,12 +115,13 @@ - Integration Adapters + Integration Endpoints This section covers the various Channel Adapters and Messaging Gateways provided by Spring Integration to support Message-based communication with external systems. + @@ -128,7 +129,6 @@ - @@ -140,6 +140,7 @@ +