com.mulesoft.extension.mq.api.modes

Enum SubscriberAckMode

java.lang.Object

java.lang.Enum<SubscriberAckMode>

com.mulesoft.extension.mq.api.modes.SubscriberAckMode

All Implemented Interfaces:

Serializable, Comparable<SubscriberAckMode>

public enum SubscriberAckMode
extends Enum<SubscriberAckMode>

Defines the behavior of the Anypoint MQ Subscriber regarding the acknowledgement of the messages retrieved.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO The message will be ACKed only if the flow that processes it finishes successfully.
IMMEDIATE The message will be ACKed as soon as it is dispatched to the flow.
MANUAL The subscriber will not handle any aspect of the acknowledgement of the message.

Method Summary

Modifier and Type	Method and Description
static SubscriberAckMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubscriberAckMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IMMEDIATE

public static final SubscriberAckMode IMMEDIATE

The message will be ACKed as soon as it is dispatched to the flow. If the processing of the message fails during the execution of the flow, it has to be handled by the application.

AUTO

public static final SubscriberAckMode AUTO

The message will be ACKed only if the flow that processes it finishes successfully. If an error is propagated during the execution of the flow, finalizing the execution with an error, then the subscriber listener will NACK the message, effectively returning it to the destination for redelivery. In case the flow processing is not completed before the acknowledgement TTL is evicted, then the message will be returned automatically to the destination by the broker for its redelivery.

MANUAL

public static final SubscriberAckMode MANUAL

The subscriber will not handle any aspect of the acknowledgement of the message. Once it is dispatched to the flow, for processing, the application is in charge of performing either an ACK or a NACK. If none is performed before the acknowledgement TTL is evicted, then the message will be returned automatically to the destination by the broker for its redelivery.

Method Detail

values

public static SubscriberAckMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SubscriberAckMode c : SubscriberAckMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubscriberAckMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null