org.apache.activemq.ActiveMQQueueReceiver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of activemq-client Show documentation
The ActiveMQ Client implementation
There is a newer version: 6.1.4
/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 org.apache.activemq;

import jakarta.jms.JMSException;
import jakarta.jms.Queue;
import jakarta.jms.QueueReceiver;

import org.apache.activemq.command.ActiveMQDestination;
import org.apache.activemq.command.ConsumerId;

/**
 * A client uses a QueueReceiver object to receive messages that
 * have been delivered to a queue. 
 * 

 * Although it is possible to have multiple QueueReceiver s for
 * the same queue, the JMS API does not define how messages are distributed
 * between the QueueReceivers. 

 * 

 * If a QueueReceiver specifies a message selector, the messages
 * that are not selected remain on the queue. By definition, a message selector
 * allows a QueueReceiver to skip messages. This means that when
 * the skipped messages are eventually read, the total ordering of the reads
 * does not retain the partial order defined by each message producer. Only
 * QueueReceiver s without a message selector will read messages
 * in message producer order. 

 * 
 * Creating a MessageConsumer provides the same features as
 * creating a QueueReceiver. A MessageConsumer
 * object is recommended for creating new code. The QueueReceiver
 * 
 * is provided to support existing code.
 *
 * @see jakarta.jms.Session#createConsumer(jakarta.jms.Destination, String)
 * @see jakarta.jms.Session#createConsumer(jakarta.jms.Destination)
 * @see jakarta.jms.QueueSession#createReceiver(Queue, String)
 * @see jakarta.jms.QueueSession#createReceiver(Queue)
 * @see jakarta.jms.MessageConsumer
 */
public class ActiveMQQueueReceiver extends ActiveMQMessageConsumer implements QueueReceiver {

    /**
     * @param theSession
     * @param consumerId
     * @param destination
     * @param selector
     * @param prefetch
     * @param maximumPendingMessageCount
     * @param asyncDispatch
     *
     * @throws JMSException
     */
    protected ActiveMQQueueReceiver(ActiveMQSession theSession, ConsumerId consumerId,
                                    ActiveMQDestination destination, String selector, int prefetch,
                                    int maximumPendingMessageCount, boolean asyncDispatch) throws JMSException {
        super(theSession, consumerId, destination, null, selector, prefetch, maximumPendingMessageCount,
              false, false, asyncDispatch, null);
    }

    /**
     * Gets the Queue associated with this queue receiver.
     *
     * @return this receiver's Queue
     * @throws JMSException if the JMS provider fails to get the queue for this
     *                 queue receiver due to some internal error.
     */
    @Override
    public Queue getQueue() throws JMSException {
        checkClosed();
        return (Queue)super.getDestination();
    }
}