root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Revised documentation on AUTO_ACKNOWLEDGE behavior 

Issue: SPR-12705
This commit is contained in:
Juergen Hoeller 2015-02-27 22:28:18 +01:00
parent 594a14ab25
commit c1a9e3484a
3 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
spring-jms/src/main/java/org/springframework/jms/listener/AbstractMessageListenerContainer.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2014 the original author or authors. * Copyright 2002-2015 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -60,8 +60,13 @@ import org.springframework.util.ReflectionUtils;
* <p>The listener container offers the following message acknowledgment options: * <p>The listener container offers the following message acknowledgment options:
* <ul> * <ul>
* <li>"sessionAcknowledgeMode" set to "AUTO_ACKNOWLEDGE" (default): * <li>"sessionAcknowledgeMode" set to "AUTO_ACKNOWLEDGE" (default):
* Automatic message acknowledgment <i>before</i> listener execution; * This mode is container-dependent: For {@link DefaultMessageListenerContainer},
* no redelivery in case of exception thrown. * it means automatic message acknowledgment <i>before</i> listener execution, with
* no redelivery in case of an exception. For {@link SimpleMessageListenerContainer},
* it means automatic message acknowledgment <i>after</i> listener execution, with
* redelivery in case of an exception thrown, as defined by the JMS specification.
* In order to consistently achieve the latter behavior with any container variant,
* consider setting "sessionTransacted" to "true" instead.
* <li>"sessionAcknowledgeMode" set to "CLIENT_ACKNOWLEDGE": * <li>"sessionAcknowledgeMode" set to "CLIENT_ACKNOWLEDGE":
* Automatic message acknowledgment <i>after</i> successful listener execution; * Automatic message acknowledgment <i>after</i> successful listener execution;
* no redelivery in case of exception thrown. * no redelivery in case of exception thrown.

10
spring-jms/src/main/java/org/springframework/jms/listener/DefaultMessageListenerContainer.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2014 the original author or authors. * Copyright 2002-2015 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -107,9 +107,11 @@ import org.springframework.util.backoff.FixedBackOff;
* <p><b>It is strongly recommended to either set {@link #setSessionTransacted * <p><b>It is strongly recommended to either set {@link #setSessionTransacted
* "sessionTransacted"} to "true" or specify an external {@link #setTransactionManager * "sessionTransacted"} to "true" or specify an external {@link #setTransactionManager
* "transactionManager"}.</b> See the {@link AbstractMessageListenerContainer} * "transactionManager"}.</b> See the {@link AbstractMessageListenerContainer}
* javadoc for details on acknowledge modes and native transaction options, * javadoc for details on acknowledge modes and native transaction options, as
* as well as the {@link AbstractPollingMessageListenerContainer} javadoc * well as the {@link AbstractPollingMessageListenerContainer} javadoc for details
* for details on configuring an external transaction manager. * on configuring an external transaction manager. Note that for the default
* "AUTO_ACKNOWLEDGE" mode, this container applies automatic message acknowledgment
* before listener execution, with no redelivery in case of an exception.
* *
* @author Juergen Hoeller * @author Juergen Hoeller
* @since 2.0 * @since 2.0

7
spring-jms/src/main/java/org/springframework/jms/listener/SimpleMessageListenerContainer.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2014 the original author or authors. * Copyright 2002-2015 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -44,7 +44,10 @@ import org.springframework.util.Assert;
* on the JMS provider: Not even the ServerSessionPool facility is required. * on the JMS provider: Not even the ServerSessionPool facility is required.
* *
* <p>See the {@link AbstractMessageListenerContainer} javadoc for details * <p>See the {@link AbstractMessageListenerContainer} javadoc for details
* on acknowledge modes and transaction options. * on acknowledge modes and transaction options. Note that this container
* exposes standard JMS behavior for the default "AUTO_ACKNOWLEDGE" mode:
* that is, automatic message acknowledgment after listener execution,
* with redelivery in case of an exception thrown.
* *
* <p>For a different style of MessageListener handling, through looped * <p>For a different style of MessageListener handling, through looped
* {@code MessageConsumer.receive()} calls that also allow for * {@code MessageConsumer.receive()} calls that also allow for