documentation.md

Documentation

This contains all of the documentation for the framework.

Table of Contents

1. Core Implementation Overview: this document provides a quick overview of the libraries core implementations. For a more in depth understanding take a look at the JavaDoc for the API.
2. How to Guides:
   1. Core Framework How To Guides
      1. How to implement a custom MessageRetriever: useful for changing the logic for obtaining messages from the SQS queue if the core implementations do not provided the required functionality
      2. How to implement a custom ArgumentResolver: useful for changing how the arguments in the method being executed are resolved
      3. How to extend a message's visibility during processing: useful for extending the visibility of a message in the case of long processing so it does not get put back on the queue while processing
      4. How to manually acknowledge message: useful for when you want to mark the message as successfully processed before the method has finished executing
   2. How to Connect to an AWS SQS Queue: necessary for actually using this framework in live environments
   3. Spring How To Guides
      1. How to add a custom ArgumentResolver to a Spring application: useful for integrating custom argument resolution code to be included in a Spring Application. See How to implement a custom ArgumentResolver for how build a new ArgumentResolver from scratch
      2. How to provide a custom Object Mapper: guide for overriding the default ObjectMapper that is used to serialise the message body and attributes
      3. How to add your own queue listener: useful for defining your own annotation for queue listening without the verbosity of the custom queue listener
      4. How to write Spring Integration Tests: you actually want to test what you are writing right?
      5. How to Start/Stop Queue Listeners: guide for starting and stopping the processing of messages for specific queue listeners
      6. How to connect to multiple AWS Accounts: guide for listening to queues across multiple AWS Accounts
3. Local Development:
   1. Setting up IntelliJ: steps for setting IntelliJ up for development, e.g. configuring checkstyle, Lombok, etc
   2. Releasing Artifacts: reminder steps for the project owner on how to release a version of this library