com.atlassian.messagequeue.internal.inmemory

Class InMemoryMessageContext

java.lang.Object

com.atlassian.messagequeue.internal.inmemory.InMemoryMessageContext

All Implemented Interfaces:

MessageContext

public class InMemoryMessageContext
extends Object
implements MessageContext

In-memory message context.

Constructor Summary

Constructors

Constructor and Description
InMemoryMessageContext(String payload)

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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.messagequeue.registry.MessageContext

cancelAutoAcknowledgementOfMessage, shouldAutoAcknowledgeMessage

Constructor Detail

InMemoryMessageContext

public InMemoryMessageContext(@Nullable
                              String payload)

Method Detail

getMessageId

public Optional<String> getMessageId()

Specified by:

getMessageId in interface MessageContext

Returns:

the message ID.

getPayload

public Optional<String> getPayload()

Specified by:

getPayload in interface MessageContext

Returns:

the payload that should be given to an executable message

acknowledge

public void acknowledge()

Description copied from interface: MessageContext

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.

Specified by:

acknowledge in interface MessageContext

isCancellationRequested

public boolean isCancellationRequested()

Description copied from interface: MessageContext

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.

Specified by:

isCancellationRequested in interface MessageContext

Returns:

true if cancellation is requested; false otherwise