Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #655 from garyrussell/INT-2788

Browse Source 
* INT-2788 AMQP return-channel Doc. Improvements
This commit is contained in:
Mark Fisher
2012-11-01 12:13:24 -04:00
parent c363ceaa9d c52babd068
commit 66200e94a2
2 changed files with 27 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-integration-amqp/src/main/resources/org/springframework/integration/amqp/config/spring-integration-amqp-2.2.xsd
View File

@@ -50,6 +50,7 @@
to a channel; this is used to further correlate a confirm to a message. An example is
"headers['amqp_confirmCorrelationData']", assuming that header contains the data.
Messages that do not have correlation data do not generate publisher confirm messages.
Requires a CachingConnectionFactory with the 'publisherConfirms' property set to TRUE.
]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
@@ -436,7 +437,9 @@ this list can also be simple patterns to be matched against the header names (e.
<xsd:attribute name="return-channel" type="xsd:string">
<xsd:annotation>
<xsd:documentation><![CDATA[
Channel to which returned messages will be sent.
Channel to which returned messages will be sent. Requires a RabbitTemplate with the 'mandatory' or
'immediate' properties set to TRUE; requires a CachingConnectionFactory with the 'publisherReturns'
property set to TRUE.
]]></xsd:documentation>
<xsd:appinfo>
<tool:annotation kind="ref">

29
src/reference/docbook/amqp.xml
View File

@@ -41,8 +41,8 @@
regarding Spring's integration with AMQP in general and RabbitMQ in
particular.</para>
<para>You can find the documentation at:
<ulink url="http://static.springsource.org/spring-amqp/docs/1.0.x/reference/html/">
http://static.springsource.org/spring-amqp/docs/1.0.x/reference/html/</ulink>
<ulink url="http://static.springsource.org/spring-amqp/reference/html/">
http://static.springsource.org/spring-amqp/reference/html/</ulink>
</para>
</tip>
</section>
@@ -327,8 +327,9 @@ this list can also be simple patterns to be matched against the header names (e.
</callout>
<callout arearefs="amqp-outbound-channel-adapter-xml-8-co" id="amqp-outbound-channel-adapter-xml-8">
<para>An expression defining correlation data. When provided, this configures the underlying
amqp template to receive publisher confirms. Requires a RabbitTemplate and a
CachingConnectionFactory with publisherConfirms enabled. When a publisher confirm
amqp template to receive publisher confirms. Requires a <classname>RabbitTemplate</classname> and a
<classname>CachingConnectionFactory</classname> with the <code>publisherConfirms</code> property
set to <code>true</code>. When a publisher confirm
is received, it is written to either the confirm-ack-channel, or the confirm-nack-channel,
depending on the confirmation type. The payload of the confirm is the correlation data as
defined by this expression and the message will have a header 'amqp_publishConfirm' set to
@@ -347,10 +348,18 @@ this list can also be simple patterns to be matched against the header names (e.
</callout>
<callout arearefs="amqp-outbound-channel-adapter-xml-11-co" id="amqp-outbound-channel-adapter-xml-11">
<para>The channel to which returned messages are sent. When provided, the underlying amqp template
is configured to return undeliverable messages. The message will be constructed from the
is configured to return undeliverable messages to the adapter. The message will be constructed from the
data received from amqp, with the following additional headers: <emphasis>amqp_returnReplyCode,
amqp_returnReplyText, amqp_returnExchange, amqp_returnRoutingKey</emphasis>.
<emphasis>Optional</emphasis>.</para>
<important>
Using a <code>return-channel</code> requires a <classname>RabbitTemplate</classname> with either
the <code>mandatory</code> or <code>immediate</code> properties set to <code>true</code>,
and a <classname>CachingConnectionFactory</classname>
with the <code>publisherReturns</code> property set to <code>true</code>. When using multiple
outbound endpoints with returns, a separate <classname>RabbitTemplate</classname> is needed
for each endpoint.
</important>
</callout>
</calloutlist>
</para>
@@ -468,10 +477,18 @@ this list can also be simple patterns to be matched against the header names (e.
</callout>
<callout arearefs="amqp-outbound-gateway-adapter-xml-9-co" id="amqp-outbound-gateway-adapter-xml-9">
<para>The channel to which returned messages are sent. When provided, the underlying amqp template
is configured to return undeliverable messages. The message will be constructed from the
is configured to return undeliverable messages to the gateway. The message will be constructed from the
data received from amqp, with the following additional headers: <emphasis>amqp_returnReplyCode,
amqp_returnReplyText, amqp_returnExchange, amqp_returnRoutingKey</emphasis>.
<emphasis>Optional</emphasis>.</para>
<important>
Using a <code>return-channel</code> requires a <classname>RabbitTemplate</classname> with either
the <code>mandatory</code> or <code>immediate</code> properties set to <code>true</code>,
and a <classname>CachingConnectionFactory</classname>
with the <code>publisherReturns</code> property set to <code>true</code>. When using multiple
outbound endpoints with returns, a separate <classname>RabbitTemplate</classname> is needed
for each endpoint.
</important>
</callout>
</calloutlist>
</para>