com.atlassian.messagequeue.registry

Interface MessageContext

All Known Implementing Classes:

InMemoryMessageContext, SchedulerMessageContext

@PublicApi
public interface MessageContext

Context that is passed to an execution of a message. This contains all information that is required by handlers of the message.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	acknowledge() Called by a message consumer to acknowledge the receipt of a message and prevent it's redelivery to another consumer.
default void	cancelAutoAcknowledgementOfMessage() Cancels the auto-acknowledgement of the message in this context.
Optional<String>	getMessageId()
Optional<String>	getPayload()
boolean	isCancellationRequested() Returns true if the MessageRunner should terminate its activities as gracefully as possible and exit; false to continue running normally.
default boolean	shouldAutoAcknowledgeMessage()

Method Detail

getMessageId

Optional<String> getMessageId()

Returns:

the message ID.

getPayload

Optional<String> getPayload()

Returns:

the payload that should be given to an executable message

acknowledge

void acknowledge()

Called by a message consumer to acknowledge the receipt of a message and prevent it's redelivery to another consumer.

Please note: due to the distributed nature of how messages are stored in some implementations, there are no guarantees that the message won't be redelivered to another consumer (even after this method is called). However, redelivery after acknowledge() is rare.

This method is thread-safe and idempotent.

Throws:

MessageAcknowledgementException - if there is an error in acknowledgement.

isCancellationRequested

boolean isCancellationRequested()

Returns true if the MessageRunner should terminate its activities as gracefully as possible and exit; false to continue running normally.

MessageRunner cancellation is entirely cooperative. If a MessageRunner is likely to take longer than a few seconds to complete its work, then it should periodically check this value and react to it. Normally, cancellation is requested because the application is trying to shut down, and continuing to run after this flag has been set increases the chance that the system administrator will grow impatient and forcibly kill the application.

Returns:

true if cancellation is requested; false otherwise

shouldAutoAcknowledgeMessage

default boolean shouldAutoAcknowledgeMessage()

Returns:

true if the message in this context should automatically be acknowledged after successful completion of MessageRunner.processMessage(MessageContext). If MessageRunner.processMessage(MessageContext) throws an exception, the message won't be acknowledged and will be redelivered after a delay (assuming the delivery count of the message has not exceeded the maximum count configured).

Returns false if the message should not be automatically acknowledged on successful completion.

cancelAutoAcknowledgementOfMessage

default void cancelAutoAcknowledgementOfMessage()

Cancels the auto-acknowledgement of the message in this context.

Auto-acknowledgement occurs after successful completion of MessageRunner.processMessage(MessageContext).