javax.jms.MessageConsumer Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.jms;
/** A client uses a MessageConsumer object to receive messages
* from a destination. A MessageConsumer object is created by
* passing a Destination object to a message-consumer creation
* method supplied by a session.
*
* MessageConsumer is the parent interface for all message
* consumers.
*
*
A message consumer can be created with a message selector. A message
* selector allows
* the client to restrict the messages delivered to the message consumer to
* those that match the selector.
*
*
A client may either synchronously receive a message consumer's messages
* or have the consumer asynchronously deliver them as they arrive.
*
*
For synchronous receipt, a client can request the next message from a
* message consumer using one of its receive methods. There are
* several variations of receive that allow a
* client to poll or wait for the next message.
*
*
For asynchronous delivery, a client can register a
* MessageListener object with a message consumer.
* As messages arrive at the message consumer, it delivers them by calling the
* MessageListener's onMessage method.
*
*
It is a client programming error for a MessageListener to
* throw an exception.
*
* @version 1.0 - 13 March 1998
* @author Mark Hapner
* @author Rich Burridge
*
* @see javax.jms.QueueReceiver
* @see javax.jms.TopicSubscriber
* @see javax.jms.Session
*/
public interface MessageConsumer {
/** Gets this message consumer's message selector expression.
*
* @return this message consumer's message selector, or null if no
* message selector exists for the message consumer (that is, if
* the message selector was not set or was set to null or the
* empty string)
*
* @exception JMSException if the JMS provider fails to get the message
* selector due to some internal error.
*/
String
getMessageSelector() throws JMSException;
/** Gets the message consumer's MessageListener.
*
* @return the listener for the message consumer, or null if no listener
* is set
*
* @exception JMSException if the JMS provider fails to get the message
* listener due to some internal error.
* @see javax.jms.MessageConsumer#setMessageListener
*/
MessageListener
getMessageListener() throws JMSException;
/** Sets the message consumer's MessageListener.
*
*
Setting the message listener to null is the equivalent of
* unsetting the message listener for the message consumer.
*
*
The effect of calling MessageConsumer.setMessageListener
* while messages are being consumed by an existing listener
* or the consumer is being used to consume messages synchronously
* is undefined.
*
* @param listener the listener to which the messages are to be
* delivered
*
* @exception JMSException if the JMS provider fails to set the message
* listener due to some internal error.
* @see javax.jms.MessageConsumer#getMessageListener
*/
void
setMessageListener(MessageListener listener) throws JMSException;
/** Receives the next message produced for this message consumer.
*
*
This call blocks indefinitely until a message is produced
* or until this message consumer is closed.
*
*
If this receive is done within a transaction, the
* consumer retains the message until the transaction commits.
*
* @return the next message produced for this message consumer, or
* null if this message consumer is concurrently closed
*
* @exception JMSException if the JMS provider fails to receive the next
* message due to some internal error.
*
*/
Message
receive() throws JMSException;
/** Receives the next message that arrives within the specified
* timeout interval.
*
*
This call blocks until a message arrives, the
* timeout expires, or this message consumer is closed.
* A timeout of zero never expires, and the call blocks
* indefinitely.
*
* @param timeout the timeout value (in milliseconds)
*
* @return the next message produced for this message consumer, or
* null if the timeout expires or this message consumer is concurrently
* closed
*
* @exception JMSException if the JMS provider fails to receive the next
* message due to some internal error.
*/
Message
receive(long timeout) throws JMSException;
/** Receives the next message if one is immediately available.
*
* @return the next message produced for this message consumer, or
* null if one is not available
*
* @exception JMSException if the JMS provider fails to receive the next
* message due to some internal error.
*/
Message
receiveNoWait() throws JMSException;
/** Closes the message consumer.
*
*
Since a provider may allocate some resources on behalf of a
* MessageConsumer outside the Java virtual machine, clients
* should close them when they
* are not needed. Relying on garbage collection to eventually reclaim
* these resources may not be timely enough.
*
*
This call blocks until a receive or message listener in
* progress has completed. A blocked message consumer receive
* call
* returns null when this message consumer is closed.
*
* @exception JMSException if the JMS provider fails to close the consumer
* due to some internal error.
*/
void
close() throws JMSException;
}