Module dk.cloudcreate.essentials.components.foundation

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

Interface DurableQueuesInterceptor

All Superinterfaces:

dk.cloudcreate.essentials.shared.interceptor.Interceptor

All Known Implementing Classes:

DurableQueuesMicrometerInterceptor, DurableQueuesMicrometerTracingInterceptor

public interface DurableQueuesInterceptor
extends dk.cloudcreate.essentials.shared.interceptor.Interceptor

Method Summary

Modifier and Type	Method	Description
default boolean	intercept(AcknowledgeMessageAsHandled operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<AcknowledgeMessageAsHandled,Boolean,DurableQueuesInterceptor> interceptorChain)	Intercept AcknowledgeMessageAsHandled calls
default DurableQueueConsumer	intercept(ConsumeFromQueue operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<ConsumeFromQueue,DurableQueueConsumer,DurableQueuesInterceptor> interceptorChain)	Intercept ConsumeFromQueue calls
default boolean	intercept(DeleteMessage operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<DeleteMessage,Boolean,DurableQueuesInterceptor> interceptorChain)	Intercept DeleteMessage calls
default Optional<QueuedMessage>	intercept(GetDeadLetterMessage operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetDeadLetterMessage,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)	Intercept GetDeadLetterMessage calls
default List<QueuedMessage>	intercept(GetDeadLetterMessages operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetDeadLetterMessages,List<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)	Intercept GetDeadLetterMessages calls
default Optional<QueuedMessage>	intercept(GetNextMessageReadyForDelivery operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetNextMessageReadyForDelivery,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)	Intercept GetNextMessageReadyForDelivery calls
default Optional<QueuedMessage>	intercept(GetQueuedMessage operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetQueuedMessage,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)	Intercept GetQueuedMessage calls
default List<QueuedMessage>	intercept(GetQueuedMessages operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetQueuedMessages,List<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)	Intercept GetQueuedMessages calls
default long	intercept(GetTotalDeadLetterMessagesQueuedFor operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetTotalDeadLetterMessagesQueuedFor,Long,DurableQueuesInterceptor> interceptorChain)	Intercept GetTotalDeadLetterMessagesQueuedFor calls
default long	intercept(GetTotalMessagesQueuedFor operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetTotalMessagesQueuedFor,Long,DurableQueuesInterceptor> interceptorChain)	Intercept GetTotalMessagesQueuedFor calls
default Optional<QueuedMessage>	intercept(MarkAsDeadLetterMessage operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<MarkAsDeadLetterMessage,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)	Intercept MarkAsDeadLetterMessage calls
default int	intercept(PurgeQueue operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<PurgeQueue,Integer,DurableQueuesInterceptor> interceptorChain)	Intercept PurgeQueue calls
default QueueEntryId	intercept(QueueMessageAsDeadLetterMessage operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<QueueMessageAsDeadLetterMessage,QueueEntryId,DurableQueuesInterceptor> interceptorChain)	Intercept QueueMessageAsDeadLetterMessage calls
default QueueEntryId	intercept(QueueMessage operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<QueueMessage,QueueEntryId,DurableQueuesInterceptor> interceptorChain)	Intercept QueueMessage calls
default List<QueueEntryId>	intercept(QueueMessages operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<QueueMessages,List<QueueEntryId>,DurableQueuesInterceptor> interceptorChain)	Intercept QueueMessages calls
default Optional<QueuedMessage>	intercept(ResurrectDeadLetterMessage operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<ResurrectDeadLetterMessage,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)	Intercept ResurrectDeadLetterMessage calls
default Optional<QueuedMessage>	intercept(RetryMessage operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<RetryMessage,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)	Intercept RetryMessage calls
default DurableQueueConsumer	intercept(StopConsumingFromQueue operation, dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<StopConsumingFromQueue,DurableQueueConsumer,DurableQueuesInterceptor> interceptorChain)	Intercept StopConsumingFromQueue calls - is initiated when DurableQueueConsumer.cancel() is called
void	setDurableQueues(DurableQueues durableQueues)	This method will be called by the DurableQueues instance that the DurableQueuesInterceptor is added to

Method Details

setDurableQueues

void setDurableQueues(DurableQueues durableQueues)

This method will be called by the DurableQueues instance that the DurableQueuesInterceptor is added to

Parameters:

durableQueues - the durable queue instance that this interceptor is added to

intercept

default Optional<QueuedMessage> intercept(GetDeadLetterMessage operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetDeadLetterMessage,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)

Intercept GetDeadLetterMessage calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the message wrapped in an Optional if the message exists and QueuedMessage.isDeadLetterMessage(), otherwise Optional.empty()

intercept

default Optional<QueuedMessage> intercept(GetQueuedMessage operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetQueuedMessage,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)

Intercept GetQueuedMessage calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the message wrapped in an Optional if the message exists and NOT a QueuedMessage.isDeadLetterMessage(), otherwise Optional.empty()

intercept

default DurableQueueConsumer intercept(ConsumeFromQueue operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<ConsumeFromQueue,DurableQueueConsumer,DurableQueuesInterceptor> interceptorChain)

Intercept ConsumeFromQueue calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the queue consumer

intercept

default DurableQueueConsumer intercept(StopConsumingFromQueue operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<StopConsumingFromQueue,DurableQueueConsumer,DurableQueuesInterceptor> interceptorChain)

Intercept StopConsumingFromQueue calls - is initiated when DurableQueueConsumer.cancel() is called

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the queue consumer that was stopped

intercept

default QueueEntryId intercept(QueueMessage operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<QueueMessage,QueueEntryId,DurableQueuesInterceptor> interceptorChain)

Intercept QueueMessage calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the unique entry id for the message queued

intercept

default QueueEntryId intercept(QueueMessageAsDeadLetterMessage operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<QueueMessageAsDeadLetterMessage,QueueEntryId,DurableQueuesInterceptor> interceptorChain)

Intercept QueueMessageAsDeadLetterMessage calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the unique entry id for the message queued

intercept

default List<QueueEntryId> intercept(QueueMessages operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<QueueMessages,List<QueueEntryId>,DurableQueuesInterceptor> interceptorChain)

Intercept QueueMessages calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the unique entry id's for the messages queued, ordered in the same order as the payloads that were queued

intercept

default Optional<QueuedMessage> intercept(RetryMessage operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<RetryMessage,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)

Intercept RetryMessage calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the QueuedMessage message wrapped in an Optional if the operation was successful, otherwise it returns an Optional.empty()

intercept

default Optional<QueuedMessage> intercept(MarkAsDeadLetterMessage operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<MarkAsDeadLetterMessage,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)

Intercept MarkAsDeadLetterMessage calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the QueuedMessage message wrapped in an Optional if the operation was successful, otherwise it returns an Optional.empty()

intercept

default Optional<QueuedMessage> intercept(ResurrectDeadLetterMessage operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<ResurrectDeadLetterMessage,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)

Intercept ResurrectDeadLetterMessage calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the QueuedMessage message wrapped in an Optional if the operation was successful, otherwise it returns an Optional.empty()

intercept

default boolean intercept(AcknowledgeMessageAsHandled operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<AcknowledgeMessageAsHandled,Boolean,DurableQueuesInterceptor> interceptorChain)

Intercept AcknowledgeMessageAsHandled calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

true if the operation went well, otherwise false

intercept

default boolean intercept(DeleteMessage operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<DeleteMessage,Boolean,DurableQueuesInterceptor> interceptorChain)

Intercept DeleteMessage calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

true if the operation went well, otherwise false

intercept

default Optional<QueuedMessage> intercept(GetNextMessageReadyForDelivery operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetNextMessageReadyForDelivery,Optional<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)

Intercept GetNextMessageReadyForDelivery calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the next message ready to be delivered (wrapped in an Optional) or Optional.empty() if no message is ready for delivery

intercept

default long intercept(GetTotalMessagesQueuedFor operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetTotalMessagesQueuedFor,Long,DurableQueuesInterceptor> interceptorChain)

Intercept GetTotalMessagesQueuedFor calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the number of queued messages for the given queue

intercept

default long intercept(GetTotalDeadLetterMessagesQueuedFor operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetTotalDeadLetterMessagesQueuedFor,Long,DurableQueuesInterceptor> interceptorChain)

Intercept GetTotalDeadLetterMessagesQueuedFor calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the number of dead-letter-messages/poison-messages queued for the given queue

intercept

default List<QueuedMessage> intercept(GetQueuedMessages operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetQueuedMessages,List<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)

Intercept GetQueuedMessages calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the messages matching the criteria

intercept

default List<QueuedMessage> intercept(GetDeadLetterMessages operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<GetDeadLetterMessages,List<QueuedMessage>,DurableQueuesInterceptor> interceptorChain)

Intercept GetDeadLetterMessages calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the dead letter messages matching the criteria

intercept

default int intercept(PurgeQueue operation,
 dk.cloudcreate.essentials.shared.interceptor.InterceptorChain<PurgeQueue,Integer,DurableQueuesInterceptor> interceptorChain)

Intercept PurgeQueue calls

Parameters:

operation - the operation

interceptorChain - the interceptor chain (call InterceptorChain.proceed() to continue the processing chain)

Returns:

the number of deleted messages