org.mule.jms.commons.api.config

Enum ConsumerAckMode

java.lang.Object

java.lang.Enum<ConsumerAckMode>

org.mule.jms.commons.api.config.ConsumerAckMode

All Implemented Interfaces:

Serializable, Comparable<ConsumerAckMode>, JmsAckMode

public enum ConsumerAckMode
extends Enum<ConsumerAckMode>
implements JmsAckMode

Declares the kind of Acknowledgement mode supported for consumer operations.

• MANUAL: This is JMS Session.CLIENT_ACKNOWLEDGE mode. The user must do the ack manually within the flow.
• DUPS_OK: JMS message is acked automatically but in a lazy fashion which may lead to duplicates.
• IMMEDIATE: Mule automatically ACKs the message upon reception.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
IMMEDIATE Mule automatically ACKs the message upon reception
MANUAL This is JMS Session.CLIENT_ACKNOWLEDGE mode.

Method Summary

Modifier and Type	Method and Description
InternalAckMode	getInternalAckMode()
static ConsumerAckMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConsumerAckMode[]	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 ConsumerAckMode IMMEDIATE

Mule automatically ACKs the message upon reception

MANUAL

public static final ConsumerAckMode MANUAL

This is JMS Session.CLIENT_ACKNOWLEDGE mode. The user must do the ACK manually within the flow

Method Detail

values

public static ConsumerAckMode[] 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 (ConsumerAckMode c : ConsumerAckMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ConsumerAckMode 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

getInternalAckMode

public InternalAckMode getInternalAckMode()

Specified by:

getInternalAckMode in interface JmsAckMode

Returns:

The InternalAckMode of the current enum value.