com.amazon.sqs.javamessaging.acknowledge.AcknowledgeMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of amazon-sqs-java-messaging-lib Show documentation

The Amazon SQS Java Messaging Library holds the Java Message Service compatible classes, that are used for communicating with Amazon Simple Queue Service.

There is a newer version: 2.1.4

Show newest version

/*
 * Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazon.sqs.javamessaging.acknowledge;

import javax.jms.JMSException;

import com.amazon.sqs.javamessaging.AmazonSQSMessagingClientWrapper;
import com.amazon.sqs.javamessaging.SQSSession;

/**
 * 
 * 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.
 * 
 */
public enum AcknowledgeMode {
    ACK_AUTO, ACK_UNORDERED, ACK_RANGE;

    private int originalAcknowledgeMode;
    
    /**
     * Sets the acknowledge mode.
     */
    public AcknowledgeMode withOriginalAcknowledgeMode(int originalAcknowledgeMode) {
        this.originalAcknowledgeMode = originalAcknowledgeMode;
        return this;
    }
    
    /**
     * Returns the acknowledge mode.
     */
    public int getOriginalAcknowledgeMode() {
        return originalAcknowledgeMode;
    }
    
    /**
     * Creates the acknowledger associated with the session, which will be used
     * to acknowledge the delivered messages on consumers of the session.
     * 
     * @param amazonSQSClient
     *            the SQS client to delete messages
     * @param parentSQSSession
     *            the associated session for the acknowledger
     * @throws JMSException
     *             If invalid acknowledge mode is used.
     */
    public Acknowledger createAcknowledger(AmazonSQSMessagingClientWrapper amazonSQSClient, SQSSession parentSQSSession) throws JMSException {
        switch (this) {
        case ACK_AUTO:
            return new AutoAcknowledger(amazonSQSClient, parentSQSSession);
        case ACK_RANGE:
            return new RangedAcknowledger(amazonSQSClient, parentSQSSession);
        case ACK_UNORDERED:
            return new UnorderedAcknowledger(amazonSQSClient, parentSQSSession);
        default:
            throw new JMSException(this + " - AcknowledgeMode does not exist");
        }
    }
}