javax.jms.JMSConsumer Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-2013 Oracle and/or its affiliates. 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_1_1.html
* or packager/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 packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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 using the simplified JMS API introduced for JMS 2.0 uses a
* {@code JMSConsumer} object to receive messages from a queue or topic. A
* {@code JMSConsumer} object may be created either created by passing a
* {@code Queue} or {@code Topic} object to one of the {@code createConsumer}
* methods on a {@code JMSContext}. or by passing a {@code Topic} object to one
* of the {@code createSharedConsumer} or {@code createDurableConsumer} methods
* on a {@code JMSContext}.
*
* A {@code JMSConsumer} can be created with a message selector. A message
* selector allows the client to restrict the messages delivered to the
* {@code JMSConsumer} to those that match the selector.
*
* A client may either synchronously receive a {@code JMSConsumer}'s messages or
* have the {@code JMSConsumer} asynchronously deliver them as they arrive.
*
* For synchronous receipt, a client can request the next message from a
* {@code JMSConsumer} using one of its {@code receive} methods. There are
* several variations of {@code receive} that allow a client to poll or wait for
* the next message.
*
* For asynchronous delivery, a client can register a {@code MessageListener}
* object with a {@code JMSConsumer}. As messages arrive at the
* {@code JMSConsumer}, it delivers them by calling the {@code MessageListener}
* 's {@code onMessage} method.
*
* It is a client programming error for a {@code MessageListener} to throw an
* exception.
*
* @see javax.jms.JMSContext
*
* @version JMS 2.0
* @since JMS 2.0
*
*/
public interface JMSConsumer extends AutoCloseable {
/** Gets this {@code JMSConsumer}'s message selector expression.
*
* @return this {@code JMSConsumer}'s message selector, or null if no
* message selector exists for the {@code JMSConsumer} (that is, if
* the message selector was not set or was set to null or the
* empty string)
*
* @exception JMSRuntimeException if the JMS provider fails to get the message
* selector due to some internal error.
*/
String getMessageSelector();
/** Gets the {@code JMSConsumer}'s {@code MessageListener}.
*
* This method must not be used in a Java EE web or EJB application.
* Doing so may cause a {@code JMSRuntimeException} to be thrown though this is not guaranteed.
*
* @return the {@code JMSConsumer}'s {@code MessageListener}, or null if one was not set
*
* @exception JMSRuntimeException if the JMS provider fails to get the {@code MessageListener}
* for one of the following reasons:
*
* - an internal error has occurred or
*
- this method has been called in a Java EE web or EJB application
* (though it is not guaranteed that an exception is thrown in this case)
*
*
* @see javax.jms.JMSConsumer#setMessageListener(javax.jms.MessageListener)
*/
MessageListener getMessageListener() throws JMSRuntimeException;
/** Sets the {@code JMSConsumer}'s {@code MessageListener}.
*
* Setting the {@code MessageListener} to null is the equivalent of
* unsetting the {@code MessageListener} for the {@code JMSConsumer}.
*
* The effect of calling this method
* while messages are being consumed by an existing listener
* or the {@code JMSConsumer} is being used to consume messages synchronously
* is undefined.
*
* This method must not be used in a Java EE web or EJB application.
* Doing so may cause a {@code JMSRuntimeException} to be thrown though this is not guaranteed.
*
* @param listener the listener to which the messages are to be
* delivered
*
* @exception JMSRuntimeException if the JMS provider fails to set the {@code JMSConsumer}'s {@code MessageListener}
* for one of the following reasons:
*
* - an internal error has occurred or
*
- this method has been called in a Java EE web or EJB application
* (though it is not guaranteed that an exception is thrown in this case)
*
*
* @see javax.jms.JMSConsumer#getMessageListener()
*/
void setMessageListener(MessageListener listener) throws JMSRuntimeException;
/** Receives the next message produced for this {@code JMSConsumer}.
*
* This call blocks indefinitely until a message is produced
* or until this {@code JMSConsumer} is closed.
*
*
If this {@code receive} is done within a transaction, the
* JMSConsumer retains the message until the transaction commits.
*
* @return the next message produced for this {@code JMSConsumer}, or
* null if this {@code JMSConsumer} is concurrently closed
*
* @exception JMSRuntimeException if the JMS provider fails to receive the next
* message due to some internal error.
*
*/
Message receive();
/** Receives the next message that arrives within the specified
* timeout interval.
*
*
This call blocks until a message arrives, the
* timeout expires, or this {@code JMSConsumer} is closed.
* A {@code timeout} of zero never expires, and the call blocks
* indefinitely.
*
* @param timeout the timeout value (in milliseconds)
*
* @return the next message produced for this {@code JMSConsumer}, or
* null if the timeout expires or this {@code JMSConsumer} is concurrently
* closed
*
* @exception JMSRuntimeException if the JMS provider fails to receive the next
* message due to some internal error.
*/
Message receive(long timeout);
/** Receives the next message if one is immediately available.
*
* @return the next message produced for this {@code JMSConsumer}, or
* null if one is not available
*
* @exception JMSRuntimeException if the JMS provider fails to receive the next
* message due to some internal error.
*/
Message receiveNoWait();
/**
* Closes the {@code JMSConsumer}.
*
* Since a provider may allocate some resources on behalf of a
* {@code JMSConsumer} 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 will block until a {@code receive} call in progress on this
* consumer has completed. A blocked {@code receive} call returns null when
* this consumer is closed.
*
* If this method is called whilst a message listener is in progress in
* another thread then it will block until the message listener has
* completed.
*
* This method may be called from a message listener's {@code onMessage}
* method on its own consumer. After this method returns the
* {@code onMessage} method will be allowed to complete normally.
*
* This method is the only {@code JMSConsumer} method that can be called
* concurrently.
*
* @exception JMSRuntimeException
* if the JMS provider fails to close the consumer due to
* some internal error.
*/
void close();
/**
* Receives the next message produced for this {@code JMSConsumer} and
* returns its body as an object of the specified type.
* This method may be used to receive any type of message except
* for {@code StreamMessage} and {@code Message}, so long as the message
* has a body which is capable of being assigned to the specified type.
* This means that the specified class or interface must either be the same
* as, or a superclass or superinterface of, the class of the message body.
* If the message is not one of the supported types,
* or its body cannot be assigned to the specified type, or it has no body,
* then a {@code MessageFormatRuntimeException} is thrown.
*
* This method does not give access to the message headers or properties
* (such as the {@code JMSRedelivered} message header field or the
* {@code JMSXDeliveryCount} message property) and should only be used if
* the application has no need to access them.
*
* This call blocks indefinitely until a message is produced or until this
* {@code JMSConsumer} is closed.
*
* If this method is called within a transaction, the
* {@code JMSConsumer} retains the message until the transaction commits.
*
* The result of this method throwing a
* {@code MessageFormatRuntimeException} depends on the session mode:
*
* - {@code AUTO_ACKNOWLEDGE} or {@code DUPS_OK_ACKNOWLEDGE}: The JMS
* provider will behave as if the unsuccessful call to {@code receiveBody} had
* not occurred. The message will be delivered again before any subsequent
* messages.
*
* This is not considered to be redelivery and does not cause the
* {@code JMSRedelivered} message header field to be set or the
* {@code JMSXDeliveryCount} message property to be incremented.
* - {@code CLIENT_ACKNOWLEDGE}: The JMS provider will behave as if the
* call to {@code receiveBody} had been successful and will not deliver the
* message again.
*
* As with any message that is delivered with a session mode of
* {@code CLIENT_ACKNOWLEDGE}, the message will not be acknowledged until
* {@code acknowledge} is called on the {@code JMSContext}. If an
* application wishes to have the failed message redelivered, it must call
* {@code recover} on the {@code JMSContext}. The redelivered message's
* {@code JMSRedelivered} message header field will be set and its
* {@code JMSXDeliveryCount} message property will be incremented.
*
* - Transacted session: The JMS provider will behave as if the call to
* {@code receiveBody} had been successful and will not deliver the message
* again.
*
* As with any message that is delivered in a transacted session, the
* transaction will remain uncommitted until the transaction is committed or
* rolled back by the application. If an application wishes to have the
* failed message redelivered, it must roll back the transaction. The
* redelivered message's {@code JMSRedelivered} message header field will be
* set and its {@code JMSXDeliveryCount} message property will be
* incremented.
*
*
* @param c
* The type to which the body of the next message should be
* assigned.
* If the next message is expected to be a {@code TextMessage}
* then this should be set to {@code String.class} or another
* class to which a {@code String} is assignable.
* If the next message is expected to be a {@code ObjectMessage}
* then this should be set to {@code java.io.Serializable.class}
* or another class to which the body is assignable.
* If the next message is expected to be a {@code MapMessage}
* then this should be set to {@code java.util.Map.class}
* (or {@code java.lang.Object.class}).
* If the next message is expected to be a {@code BytesMessage}
* then this should be set to {@code byte[].class}
* (or {@code java.lang.Object.class}).
*
* @return the body of the next message produced for this
* {@code JMSConsumer}, or null if this {@code JMSConsumer} is
* concurrently closed
*
* @throws MessageFormatRuntimeException
*
* - if the message is not one of the supported types listed above
*
- if the message body cannot be assigned to the specified type
*
- if the message has no body
*
- if the message is an {@code ObjectMessage} and object deserialization fails.
*
* @throws JMSRuntimeException
* if the JMS provider fails to receive the next message due to
* some internal error
*/
T receiveBody(Class c);
/**
* Receives the next message produced for this {@code JMSConsumer}
* that arrives within the specified timeout period and
* returns its body as an object of the specified type.
* This method may be used to receive any type of message except
* for {@code StreamMessage} and {@code Message}, so long as the message
* has a body which is capable of being assigned to the specified type.
* This means that the specified class or interface must either be the same
* as, or a superclass or superinterface of, the class of the message body.
* If the message is not one of the supported types,
* or its body cannot be assigned to the specified type, or it has no body,
* then a {@code MessageFormatRuntimeException} is thrown.
*
* This method does not give access to the message headers or properties
* (such as the {@code JMSRedelivered} message header field or the
* {@code JMSXDeliveryCount} message property) and should only be used if
* the application has no need to access them.
*
* This call blocks until a message arrives, the timeout expires, or this
* {@code JMSConsumer} is closed. A timeout of zero never expires, and the
* call blocks indefinitely.
*
* If this method is called within a transaction, the
* {@code JMSConsumer} retains the message until the transaction commits.
*
* The result of this method throwing a
* {@code MessageFormatRuntimeException} depends on the session mode:
*
* - {@code AUTO_ACKNOWLEDGE} or {@code DUPS_OK_ACKNOWLEDGE}: The JMS
* provider will behave as if the unsuccessful call to {@code receiveBody} had
* not occurred. The message will be delivered again before any subsequent
* messages.
*
* This is not considered to be redelivery and does not cause the
* {@code JMSRedelivered} message header field to be set or the
* {@code JMSXDeliveryCount} message property to be incremented.
* - {@code CLIENT_ACKNOWLEDGE}: The JMS provider will behave as if the
* call to {@code receiveBody} had been successful and will not deliver the
* message again.
*
* As with any message that is delivered with a session mode of
* {@code CLIENT_ACKNOWLEDGE}, the message will not be acknowledged until
* {@code acknowledge} is called on the {@code JMSContext}. If an
* application wishes to have the failed message redelivered, it must call
* {@code recover} on the {@code JMSContext}. The redelivered message's
* {@code JMSRedelivered} message header field will be set and its
* {@code JMSXDeliveryCount} message property will be incremented.
*
* - Transacted session: The JMS provider will behave as if the call to
* {@code receiveBody} had been successful and will not deliver the message
* again.
*
* As with any message that is delivered in a transacted session, the
* transaction will remain uncommitted until the transaction is committed or
* rolled back by the application. If an application wishes to have the
* failed message redelivered, it must roll back the transaction. The
* redelivered message's {@code JMSRedelivered} message header field will be
* set and its {@code JMSXDeliveryCount} message property will be
* incremented.
*
*
* @param c
* The type to which the body of the next message should be
* assigned.
* If the next message is expected to be a {@code TextMessage}
* then this should be set to {@code String.class} or another
* class to which a {@code String} is assignable.
* If the next message is expected to be a {@code ObjectMessage}
* then this should be set to {@code java.io.Serializable.class}
* or another class to which the body is assignable.
* If the next message is expected to be a {@code MapMessage}
* then this should be set to {@code java.util.Map.class}
* (or {@code java.lang.Object.class}).
* If the next message is expected to be a {@code BytesMessage}
* then this should be set to {@code byte[].class}
* (or {@code java.lang.Object.class}).
*
* @return the body of the next message produced for this {@code JMSConsumer},
* or null if the timeout expires or this {@code JMSConsumer} is concurrently closed
*
* @throws MessageFormatRuntimeException
*
* - if the message is not one of the supported types listed above
*
- if the message body cannot be assigned to the specified type
*
- if the message has no body
*
- if the message is an {@code ObjectMessage} and object deserialization fails.
*
* @throws JMSRuntimeException
* if the JMS provider fails to receive the next message due
* to some internal error
*/
T receiveBody(Class c, long timeout);
/**
* Receives the next message produced for this {@code JMSConsumer}
* if one is immediately available and
* returns its body as an object of the specified type.
* This method may be used to receive any type of message except
* for {@code StreamMessage} and {@code Message}, so long as the message
* has a body which is capable of being assigned to the specified type.
* This means that the specified class or interface must either be the same
* as, or a superclass or superinterface of, the class of the message body.
* If the message is not one of the supported types,
* or its body cannot be assigned to the specified type, or it has no body,
* then a {@code MessageFormatRuntimeException} is thrown.
*
* This method does not give access to the message headers or properties
* (such as the {@code JMSRedelivered} message header field or the
* {@code JMSXDeliveryCount} message property) and should only be used if
* the application has no need to access them.
*
* If a message is not immediately available null is returned.
*
* If this method is called within a transaction, the
* {@code JMSConsumer} retains the message until the transaction commits.
*
* The result of this method throwing a
* {@code MessageFormatRuntimeException} depends on the session mode:
*
* - {@code AUTO_ACKNOWLEDGE} or {@code DUPS_OK_ACKNOWLEDGE}: The JMS
* provider will behave as if the unsuccessful call to {@code receiveBodyNoWait} had
* not occurred. The message will be delivered again before any subsequent
* messages.
*
* This is not considered to be redelivery and does not cause the
* {@code JMSRedelivered} message header field to be set or the
* {@code JMSXDeliveryCount} message property to be incremented.
* - {@code CLIENT_ACKNOWLEDGE}: The JMS provider will behave as if the
* call to {@code receiveBodyNoWait} had been successful and will not deliver the
* message again.
*
* As with any message that is delivered with a session mode of
* {@code CLIENT_ACKNOWLEDGE}, the message will not be acknowledged until
* {@code acknowledge} is called on the {@code JMSContext}. If an
* application wishes to have the failed message redelivered, it must call
* {@code recover} on the {@code JMSContext}. The redelivered message's
* {@code JMSRedelivered} message header field will be set and its
* {@code JMSXDeliveryCount} message property will be incremented.
*
* - Transacted session: The JMS provider will behave as if the call to
* {@code receiveBodyNoWait} had been successful and will not deliver the message
* again.
*
* As with any message that is delivered in a transacted session, the
* transaction will remain uncommitted until the transaction is committed or
* rolled back by the application. If an application wishes to have the
* failed message redelivered, it must roll back the transaction. The
* redelivered message's {@code JMSRedelivered} message header field will be
* set and its {@code JMSXDeliveryCount} message property will be
* incremented.
*
*
* @param c
* The type to which the body of the next message should be
* assigned.
* If the next message is expected to be a {@code TextMessage}
* then this should be set to {@code String.class} or another
* class to which a {@code String} is assignable.
* If the next message is expected to be a {@code ObjectMessage}
* then this should be set to {@code java.io.Serializable.class}
* or another class to which the body is assignable.
* If the next message is expected to be a {@code MapMessage}
* then this should be set to {@code java.util.Map.class}
* (or {@code java.lang.Object.class}).
* If the next message is expected to be a {@code BytesMessage}
* then this should be set to {@code byte[].class}
* (or {@code java.lang.Object.class}).
*
* @return the body of the next message produced for this {@code JMSConsumer},
* or null if one is not immediately available or this {@code JMSConsumer} is concurrently closed
*
* @throws MessageFormatRuntimeException
*
* - if the message is not one of the supported types listed above
*
- if the message body cannot be assigned to the specified type
*
- if the message has no body
*
- if the message is an {@code ObjectMessage} and object deserialization fails.
*
*
* @throws JMSRuntimeException
* if the JMS provider fails to receive the next message due
* to some internal error
*/
T receiveBodyNoWait(Class c);
}