javax.jms

Interface QueueSender

  • All Superinterfaces:
    AutoCloseable, MessageProducer

    public interface QueueSender
    extends MessageProducer
    A client uses a QueueSender object to send messages to a queue.

    Normally, the Queue is specified when a QueueSender is created. In this case, an attempt to use the send methods for an unidentified QueueSender will throw a java.lang.UnsupportedOperationException.

    If the QueueSender is created with an unidentified Queue, an attempt to use the send methods that assume that the Queue has been identified will throw a java.lang.UnsupportedOperationException.

    During the execution of its send method, a message must not be changed by other threads within the client. If the message is modified, the result of the send is undefined.

    After sending a message, a client may retain and modify it without affecting the message that has been sent. The same message object may be sent multiple times.

    The following message headers are set as part of sending a message: JMSDestination, JMSDeliveryMode, JMSExpiration, JMSPriority, JMSMessageID and JMSTimeStamp. When the message is sent, the values of these headers are ignored. After the completion of the send, the headers hold the values specified by the method sending the message. It is possible for the send method not to set JMSMessageID and JMSTimeStamp if the setting of these headers is explicitly disabled by the MessageProducer.setDisableMessageID or MessageProducer.setDisableMessageTimestamp method.

    Creating a MessageProducer provides the same features as creating a QueueSender. A MessageProducer object is recommended when creating new code. The QueueSender is provided to support existing code.

    Since:
    JMS 1.0
    Version:
    JMS 2.0
    See Also:
    MessageProducer, Session.createProducer(Destination), QueueSession.createSender(Queue)
    • Method Detail

      • getQueue

        Queue getQueue()
                throws JMSException
        Gets the queue associated with this QueueSender.
        Returns:
        this sender's queue
        Throws:
        JMSException - if the JMS provider fails to get the queue for this QueueSender due to some internal error.
      • send

        void send(Queue queue,
                  Message message,
                  int deliveryMode,
                  int priority,
                  long timeToLive)
           throws JMSException
        Sends a message to a queue for an unidentified message producer, specifying delivery mode, priority and time to live.

        Typically, a message producer is assigned a queue at creation time; however, the JMS API also supports unidentified message producers, which require that the queue be supplied every time a message is sent.

        Parameters:
        queue - the queue to send this message to
        message - the message to send
        deliveryMode - the delivery mode to use
        priority - the priority for this message
        timeToLive - the message's lifetime (in milliseconds)
        Throws:
        JMSException - if the JMS provider fails to send the message due to some internal error.
        MessageFormatException - if an invalid message is specified.
        InvalidDestinationException - if a client uses this method with an invalid queue.

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/jms/queuesender.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.