org.mule.jms.commons.api.config

Enum AckMode

java.lang.Object

java.lang.Enum<AckMode>

org.mule.jms.commons.api.config.AckMode

All Implemented Interfaces:

Serializable, Comparable<AckMode>, JmsAckMode

public enum AckMode
extends Enum<AckMode>
implements JmsAckMode

Declares the kind of Acknowledgement mode supported.

• AUTO: Mule ACKs the message only if the flow is finished successfully.
• 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
AUTO This is JMS Session.AUTO_ACKNOWLEDGE mode.
DUPS_OK Similar to AUTO, the JMS message is acknowledged automatically but in a lazy fashion which may lead to duplicates.
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 AckMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AckMode[]	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 AckMode IMMEDIATE

Mule automatically ACKs the message upon reception

AUTO

public static final AckMode AUTO

This is JMS Session.AUTO_ACKNOWLEDGE mode. The session automatically acknowledges the receipt when it successfully delivered the message to a JmsConsume.consume(org.mule.jms.commons.internal.config.JmsConfig, org.mule.jms.commons.internal.connection.JmsTransactionalConnection, java.lang.String, org.mule.jms.commons.api.destination.ConsumerType, org.mule.jms.commons.internal.config.JmsAckMode, java.lang.String, java.lang.String, java.lang.String, java.lang.Long, java.util.concurrent.TimeUnit, org.mule.runtime.extension.api.tx.OperationTransactionalAction) or JmsListener handler.

MANUAL

public static final AckMode MANUAL

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

DUPS_OK

public static final AckMode DUPS_OK

Similar to AUTO, the JMS message is acknowledged automatically but in a lazy fashion which may lead to duplicates.

Method Detail

values

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

Returns:

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

valueOf

public static AckMode 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.