com.amazon.sqs.javamessaging.acknowledge

Enum AcknowledgeMode

java.lang.Object

java.lang.Enum<AcknowledgeMode>

com.amazon.sqs.javamessaging.acknowledge.AcknowledgeMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AcknowledgeMode>

public enum AcknowledgeMode
extends java.lang.Enum<AcknowledgeMode>

Specifies the different possible modes of acknowledgment:

• In ACK_AUTO mode, every time the user receives a message, it is acknowledged automatically. This is implemented by consumer and does not need any further processing.
• In ACK_RANGE mode, all messages received before that message including that one are acknowledged.
• In ACK_UNORDERED mode, messages can be acknowledged in any order one at a time. Acknowledging the consumed message does not affect other message acknowledges.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACK_AUTO
ACK_RANGE
ACK_UNORDERED

Method Summary

Methods

Modifier and Type	Method and Description
Acknowledger	createAcknowledger(AmazonSQSMessagingClientWrapper amazonSQSClient, SQSSession parentSQSSession) Creates the acknowledger associated with the session, which will be used to acknowledge the delivered messages on consumers of the session.
int	getOriginalAcknowledgeMode() Returns the acknowledge mode.
static AcknowledgeMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AcknowledgeMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
AcknowledgeMode	withOriginalAcknowledgeMode(int originalAcknowledgeMode) Sets the acknowledge mode.

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

ACK_AUTO

public static final AcknowledgeMode ACK_AUTO

ACK_UNORDERED

public static final AcknowledgeMode ACK_UNORDERED

ACK_RANGE

public static final AcknowledgeMode ACK_RANGE

Method Detail

values

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

Returns:

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

valueOf

public static AcknowledgeMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

withOriginalAcknowledgeMode

public AcknowledgeMode withOriginalAcknowledgeMode(int originalAcknowledgeMode)

Sets the acknowledge mode.

getOriginalAcknowledgeMode

public int getOriginalAcknowledgeMode()

Returns the acknowledge mode.

createAcknowledger

public Acknowledger createAcknowledger(AmazonSQSMessagingClientWrapper amazonSQSClient,
                              SQSSession parentSQSSession)
                                throws JMSException

Creates the acknowledger associated with the session, which will be used to acknowledge the delivered messages on consumers of the session.

Parameters:

amazonSQSClient - the SQS client to delete messages

parentSQSSession - the associated session for the acknowledger

Throws:

JMSException - If invalid acknowledge mode is used.