Package org.ow2.joram.jakarta.connector

Class OutboundConsumer

  • All Implemented Interfaces:
    jakarta.jms.MessageConsumer, AutoCloseable
    Direct Known Subclasses:
    OutboundReceiver, OutboundSubscriber
    public class OutboundConsumer
extends Object
implements jakarta.jms.MessageConsumer
    An OutboundConsumer instance wraps a JMS consumer for a component involved in outbound messaging.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected jakarta.jms.MessageConsumer consumer
      Wrapped JMS consumer.
      private static boolean DEBUG  
      private static Logger logger  
      protected OutboundSession session
      The OutboundSession this consumer belongs to.
      (package private) boolean valid
      false if consumer is no more valid.

    • Constructor Summary

      Constructors 
      Constructor Description
      OutboundConsumer​(jakarta.jms.MessageConsumer consumer, OutboundSession session)
      Constructs an OutboundConsumer instance.

    • Field Detail

      • logger

        private static final Logger logger

      • DEBUG

        private static final boolean DEBUG

      • session

        protected OutboundSession session
        The OutboundSession this consumer belongs to.

      • consumer

        protected jakarta.jms.MessageConsumer consumer
        Wrapped JMS consumer.

      • valid

        boolean valid
        false if consumer is no more valid.

    • Constructor Detail

      • OutboundConsumer

        OutboundConsumer​(jakarta.jms.MessageConsumer consumer,
                 OutboundSession session)
        Constructs an OutboundConsumer instance.
        Parameters:
        consumer - JMS consumer to wrap.
        session - The OutboundSession this consumer belongs to.

    • Method Detail

      • checkValidity

        protected void checkValidity()
                      throws jakarta.jms.IllegalStateException
        Checks the validity of the subscriber instance.
        Throws:
        jakarta.jms.IllegalStateException

      • setMessageListener

        public void setMessageListener​(jakarta.jms.MessageListener messageListener)
                        throws jakarta.jms.JMSException
        Forbidden call on a component's outbound consumer, throws a IllegalStateException instance.
        Specified by:
        setMessageListener in interface jakarta.jms.MessageConsumer
        Throws:
        jakarta.jms.JMSException

      • getMessageListener

        public jakarta.jms.MessageListener getMessageListener()
                                               throws jakarta.jms.JMSException
        Forbidden call on a component's outbound consumer, throws a IllegalStateException instance.
        Specified by:
        getMessageListener in interface jakarta.jms.MessageConsumer
        Throws:
        jakarta.jms.JMSException

      • getMessageSelector

        public String getMessageSelector()
                          throws jakarta.jms.JMSException
        Delegates the call to the wrapped JMS consumer.
        Specified by:
        getMessageSelector in interface jakarta.jms.MessageConsumer
        Throws:
        jakarta.jms.JMSException

      • receive

        public jakarta.jms.Message receive​(long timeOut)
                            throws jakarta.jms.JMSException
        Delegates the call to the wrapped JMS consumer.
        Specified by:
        receive in interface jakarta.jms.MessageConsumer
        Throws:
        jakarta.jms.JMSException

      • receive

        public jakarta.jms.Message receive()
                            throws jakarta.jms.JMSException
        Delegates the call to the wrapped JMS consumer.
        Specified by:
        receive in interface jakarta.jms.MessageConsumer
        Throws:
        jakarta.jms.JMSException

      • receiveNoWait

        public jakarta.jms.Message receiveNoWait()
                                  throws jakarta.jms.JMSException
        Delegates the call to the wrapped JMS consumer.
        Specified by:
        receiveNoWait in interface jakarta.jms.MessageConsumer
        Throws:
        jakarta.jms.JMSException

      • close

        public void close()
           throws jakarta.jms.JMSException
        Delegates the call to the wrapped JMS consumer.
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface jakarta.jms.MessageConsumer
        Throws:
        jakarta.jms.JMSException