Module dk.cloudcreate.essentials.components.foundation

Package dk.cloudcreate.essentials.components.foundation.messaging.queue

Class PatternMatchingQueuedMessageHandler

java.lang.Object

dk.cloudcreate.essentials.components.foundation.messaging.queue.PatternMatchingQueuedMessageHandler

All Implemented Interfaces:

QueuedMessageHandler

public class PatternMatchingQueuedMessageHandler
extends Object
implements QueuedMessageHandler

Pattern matching QueuedMessageHandler for use with DurableQueues's
The PatternMatchingQueuedMessageHandler will automatically call methods annotated with the @MessageHandler annotation and where the 1st argument matches the actual Message payload type (contained in the Message.getPayload() provided to the QueuedMessageHandler.handle(QueuedMessage) method)

Each method may also include a 2nd argument that of type QueuedMessage in which case the event that's being matched is included as the 2nd argument in the call to the method.
The methods can have any accessibility (private, public, etc.), they just have to be instance methods.

Example:

 public class MyMessageHandler extends PatternMatchingQueuedMessageHandler {

         @MessageHandler
         public void handle(OrderEvent.OrderAdded orderAdded) {
             ...
         }

         @MessageHandler
         private void handle(OrderEvent.ProductRemovedFromOrder productRemovedFromOrder, QueuedMessage queuedMessage) {
           ...
         }
 }
 

Constructor Summary

Constructors

Constructor	Description
PatternMatchingQueuedMessageHandler()	Create an PatternMatchingQueuedMessageHandler that can resolve and invoke message handler methods, i.e.
PatternMatchingQueuedMessageHandler(Object invokeMessageHandlerMethodsOn)	Create an PatternMatchingQueuedMessageHandler that can resolve and invoke message handler methods, i.e.

Method Summary

Modifier and Type	Method	Description
void	allowUnmatchedMessages()	Should the event handler allow unmatched Message.getPayload()? If true then an unmatched Message.getPayload() is ignored, if false (the default value) then an unmatched event will cause handleUnmatchedMessage(QueuedMessage) will throw an IllegalArgumentException
void	handle(QueuedMessage queuedMessage)
protected void	handleUnmatchedMessage(QueuedMessage queuedMessage)	Override this method to provide custom handling for QueuedMessage's who's Message.getPayload() aren't matched Default behaviour is to throw an IllegalArgumentException unless isAllowUnmatchedMessages() is set to true (default value is false)
boolean	isAllowUnmatchedMessages()	Should the event handler allow unmatched Message.getPayload()? If true then an unmatched Message.getPayload() is ignored, if false (the default value) then an unmatched event will cause handleUnmatchedMessage(QueuedMessage) will throw an IllegalArgumentException
void	setAllowUnmatchedMessages(boolean allowUnmatchedMessages)	Should the event handler allow unmatched Message.getPayload()? If true then an unmatched Message.getPayload() is ignored, if false (the default value) then an unmatched event will cause handleUnmatchedMessage(QueuedMessage) will throw an IllegalArgumentException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PatternMatchingQueuedMessageHandler

public PatternMatchingQueuedMessageHandler(Object invokeMessageHandlerMethodsOn)

Create an PatternMatchingQueuedMessageHandler that can resolve and invoke message handler methods, i.e. methods annotated with @MessageHandler, on another object

Parameters:

invokeMessageHandlerMethodsOn - the object that contains the @MessageHandler annotated methods

PatternMatchingQueuedMessageHandler

public PatternMatchingQueuedMessageHandler()

Create an PatternMatchingQueuedMessageHandler that can resolve and invoke message handler methods, i.e. methods annotated with @MessageHandler, on this concrete subclass of PatternMatchingQueuedMessageHandler

Method Details

isAllowUnmatchedMessages

public boolean isAllowUnmatchedMessages()

Should the event handler allow unmatched Message.getPayload()? If true then an unmatched Message.getPayload() is ignored, if false (the default value) then an unmatched event will cause handleUnmatchedMessage(QueuedMessage) will throw an IllegalArgumentException

Returns:

should the event handler allow unmatched events

setAllowUnmatchedMessages

public void setAllowUnmatchedMessages(boolean allowUnmatchedMessages)

Should the event handler allow unmatched Message.getPayload()? If true then an unmatched Message.getPayload() is ignored, if false (the default value) then an unmatched event will cause handleUnmatchedMessage(QueuedMessage) will throw an IllegalArgumentException

Parameters:

allowUnmatchedMessages - should the event handler allow unmatched Message.getPayload()

allowUnmatchedMessages

public void allowUnmatchedMessages()

Should the event handler allow unmatched Message.getPayload()? If true then an unmatched Message.getPayload() is ignored, if false (the default value) then an unmatched event will cause handleUnmatchedMessage(QueuedMessage) will throw an IllegalArgumentException

See Also:

• setAllowUnmatchedMessages(boolean)

handle

public void handle(QueuedMessage queuedMessage)

Specified by:

handle in interface QueuedMessageHandler

handleUnmatchedMessage

protected void handleUnmatchedMessage(QueuedMessage queuedMessage)

Override this method to provide custom handling for QueuedMessage's who's Message.getPayload() aren't matched
Default behaviour is to throw an IllegalArgumentException unless isAllowUnmatchedMessages() is set to true (default value is false)

Parameters:

queuedMessage - the unmatched queue message