[INT-2430] Improve Polling Consumer Documentation Created: 06/Feb/12  Updated: 15/May/12  Resolved: 09/Mar/12

Status: Closed
Project: Spring Integration
Component/s: Documentation
Affects Version/s: 2.1 GA
Fix Version/s: 2.1.1, 2.2 M1

Type: Task Priority: Minor
Reporter: Gunnar Hillert Assignee: Gunnar Hillert
Resolution: Complete Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depend
is depended on by INT-2425 Poller: Document the Ability to Chang... Closed
Relate
is related to INTSAMPLES-64 Create an Poller Example using a Cust... Closed
is related to INT-2444 Chapter 7.1.3 Polling Consumer - Java... Closed

 Description   

Currently we don't have a dedicated chapter regarding poller documentation early in the documentation. The index only has one mentioning of pollers:

  • 31.1.1. Poller Transaction Support

The first use of the word "poller" in the reference guide is:

  • 2.3.2 Message Channel - references the word poller without describing it or further referencing it.
  • 3.1.2 Message Channel Implementations

Actual description and configuration options are handled in chapter:

  • 3.2.1 Configuring Inbound Channel Adapter
  • and also scattered throughout the guide

Polling Consumers are handled in Chapter "7.1.3 Polling Consumer". However, we should have an introduction-type chapter earlier on.

I would propose the following changed chapter structure:

3. Messaging Channels
3.1. Message Channels
3.2. Poller (Polling Consumer)
3.3. Channel Adapter
3.3. Messaging Bridge

Chapter 3.2. Poller (Polling Consumer) will then reference Chapter "7.1.3 Polling Consumer" for more in-depth coverage.
Therefore the user has one dedicated chapter with necessary information regarding pollers without being "surprised" by the use of Pollers in chapter "3.3. Channel Adapter"



 Comments   
Comment by Artem Bilan [ 14/Feb/12 ]

Gunnar, can you also fix here 'poler' typo in the 7.1.4 Namespace Support. AOP Advice chains?
I don't see any reason to create new issue for that very simple bug

Comment by Gunnar Hillert [ 14/Feb/12 ]

Excellent - Will do. Already fixed locally. Will do a commit by tomorrow morning.

Comment by Artem Bilan [ 14/Feb/12 ]

Gunnar, also, please, look at 7.1.3 Polling Consumer into the sample code:

consumer.setTransactionManager(txManager);

org.springframework.integration.endpoint.PollingConsumer doesn't have that method. Seem to have forgotten to make changes to the documentation after refactoring...

Comment by Gunnar Hillert [ 16/Feb/12 ]

I will move that particular issue into a separate Jira as that is not a one-liner fix. We need to expand the Java-based configuration also a bit more, which I think is important to understand for unit/integration testing scenarios.

Comment by Gunnar Hillert [ 16/Feb/12 ]

Issued Pull Request: https://github.com/SpringSource/spring-integration/pull/366

Comment by Gunnar Hillert [ 16/Feb/12 ]

Created issue INT-2444 and linked to it.

Generated at Sat Oct 20 22:08:39 UTC 2018 using JIRA 7.9.2#79002-sha1:3bb15b68ecd99a30eb364c4c1a393359bcad6278.