Package com.apama.correlator.jms.config.api.mapper

Class JmsSenderMessageHolder

  • public final class JmsSenderMessageHolder
extends java.lang.Object
    Holds a JMS message and send parameters such as the destination, and optionally the values of any send arguments that were overridden on a per-message basis by the mapper (such as priority).

    Threading: intended for single-threaded use, not thread-safe.

    All set methods on this class return the JmsSenderMessageHolder instance they were called on, to allow a fluent coding style when building a JmsSenderMessageHolder instance.

    • Constructor Detail

      • JmsSenderMessageHolder

        public JmsSenderMessageHolder()
        Creates an empty JmsSenderMessageHolder. Callers are required to set the destination and message and may additionally set other properties if desired.

      • JmsSenderMessageHolder

        public JmsSenderMessageHolder​(javax.jms.Message message,
                              javax.jms.Destination destination)
        Creates a JmsSenderMessageHolder with the required message and destination already set.

    • Method Detail

      • getJmsMessage

        public javax.jms.Message getJmsMessage()

      • getDestination

        public javax.jms.Destination getDestination()

      • setDestination

        public JmsSenderMessageHolder setDestination​(javax.jms.Destination destination)
        Set the Destination this message should be sent to.
        Parameters:
        destination -
        Returns:
        this instance

      • getPriority

        public java.lang.Integer getPriority()
        Returns:
        The priority assigned for this message, or null to use the producer's default value if it was not overridden.

      • setPriority

        public JmsSenderMessageHolder setPriority​(java.lang.Integer priority)
        Set the JMS message priority.
        Parameters:
        priority -
        Returns:
        this instance

      • getDeliveryMode

        public java.lang.Integer getDeliveryMode()
        Returns:
        The delivery mode assigned for this message, or null to use the producer's default value if it was not overridden.

      • setDeliveryMode

        public JmsSenderMessageHolder setDeliveryMode​(java.lang.Integer deliveryMode)
        Set the javax.jms.DeliveryMode override to use for this message.
        Parameters:
        deliveryMode -
        Returns:
        this instance

      • getTimeToLive

        public java.lang.Long getTimeToLive()
        Returns:
        The time to live assigned for this message, or null to use the producer's default value if it was not overridden.

      • setTimeToLive

        public JmsSenderMessageHolder setTimeToLive​(java.lang.Long timeToLive)
        Set the time to live for this message in milliseconds.
        Parameters:
        timeToLive -
        Returns:
        this instance

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object