jakarta.jms.QueueReceiver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 34.0.0.Final

Show newest version

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.jms;

/**
 * A client uses a {@code QueueReceiver} object to receive messages that have been delivered to a queue.
 *
 * 
 * Although it is possible to have multiple {@code QueueReceiver}s for the same queue, the Jakarta Messaging API does not define how
 * messages are distributed between the {@code QueueReceiver}s.
 *
 * 

 * If a {@code QueueReceiver} specifies a message selector, the messages that are not selected remain on the queue. By
 * definition, a message selector allows a {@code 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 {@code QueueReceiver}s without a message selector will read messages in message producer
 * order.
 *
 * 
 * Creating a {@code MessageConsumer} provides the same features as creating a {@code QueueReceiver}. A
 * {@code MessageConsumer} object is recommended for creating new code. The {@code QueueReceiver} is provided to support
 * existing code.
 *
 * @see jakarta.jms.Session#createConsumer(Destination, String)
 * @see jakarta.jms.Session#createConsumer(Destination)
 * @see jakarta.jms.QueueSession#createReceiver(Queue, String)
 * @see jakarta.jms.QueueSession#createReceiver(Queue)
 * @see jakarta.jms.MessageConsumer
 *
 * @version Jakarta Messaging 2.0
 * @since JMS 1.0
 */
public interface QueueReceiver extends MessageConsumer {

    /**
     * Gets the {@code Queue} associated with this queue receiver.
     *
     * @return this receiver's {@code Queue}
     *
     * @exception JMSException if the Jakarta Messaging provider fails to get the queue for this queue receiver due to some internal
     * error.
     */
    Queue getQueue() throws JMSException;
}