com.atlassian.messagequeue.internal.scheduler

Class SchedulerMessageContext

java.lang.Object

com.atlassian.messagequeue.internal.scheduler.SchedulerMessageContext

All Implemented Interfaces:

MessageContext

public class SchedulerMessageContext
extends Object
implements MessageContext

Scheduler MessageContext.

Constructor Summary

Constructors

Constructor and Description
SchedulerMessageContext(com.atlassian.scheduler.JobRunnerRequest jobRunnerRequest, String payload, com.atlassian.scheduler.SchedulerService schedulerService)

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.
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.
boolean	shouldAutoAcknowledgeMessage()

Methods inherited from class java.lang.Object

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

Constructor Detail

SchedulerMessageContext

public SchedulerMessageContext(@Nonnull
                               com.atlassian.scheduler.JobRunnerRequest jobRunnerRequest,
                               @Nullable
                               String payload,
                               com.atlassian.scheduler.SchedulerService schedulerService)

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

shouldAutoAcknowledgeMessage

public boolean shouldAutoAcknowledgeMessage()

Specified by:

shouldAutoAcknowledgeMessage in interface MessageContext

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

public void cancelAutoAcknowledgementOfMessage()

Description copied from interface: MessageContext

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

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

Specified by:

cancelAutoAcknowledgementOfMessage in interface MessageContext