Package com.github.ddth.queue.impl

Class ActiveMqQueue<ID,​DATA>

  • All Implemented Interfaces:
    IQueue<ID,​DATA>, AutoCloseable
    Direct Known Subclasses:
    BaseUniversalActiveMqQueue
    public abstract class ActiveMqQueue<ID,​DATA>
extends AbstractQueue<ID,​DATA>
    (Experimental) ActiveMQ implementation of IQueue.
    • Queue-size support: no
    • Ephemeral storage support: no
    Since:
    0.6.1
    Author:
    Thanh Ba Nguyen

    • Constructor Detail

      • ActiveMqQueue

        public ActiveMqQueue()

    • Method Detail

      • getUri

        public String getUri()
        ActiveMQ's connection URI (see http://activemq.apache.org/connection-configuration-uri.html).
        Returns:

      • setUri

        public ActiveMqQueue<ID,​DATA> setUri​(String uri)
        ActiveMQ's connection URI (see http://activemq.apache.org/connection-configuration-uri.html).
        Parameters:
        uri -
        Returns:

      • getUsername

        public String getUsername()
        Username to connect to ActiveMQ server.
        Returns:

      • setUsername

        public ActiveMqQueue<ID,​DATA> setUsername​(String username)
        Username to connect to ActiveMQ server.
        Parameters:
        username -
        Returns:

      • getPassword

        public String getPassword()
        Password to connect to ActiveMQ server.
        Returns:

      • setPassword

        public ActiveMqQueue<ID,​DATA> setPassword​(String password)
        Password to connect to ActiveMQ server.
        Parameters:
        password -
        Returns:

      • getConnectionFactory

        protected org.apache.activemq.ActiveMQConnectionFactory getConnectionFactory()
        Getter for connectionFactory.
        Returns:

      • setConnectionFactory

        protected ActiveMqQueue<ID,​DATA> setConnectionFactory​(org.apache.activemq.ActiveMQConnectionFactory connectionFactory,
                                                            boolean setMyOwnConnectionFactory)
        Setter for connectionFactory.
        Parameters:
        connectionFactory -
        setMyOwnConnectionFactory -
        Returns:
        Since:
        0.7.1

      • setConnectionFactory

        public ActiveMqQueue<ID,​DATA> setConnectionFactory​(org.apache.activemq.ActiveMQConnectionFactory connectionFactory)
        Setter for connectionFactory.
        Parameters:
        connectionFactory -
        Returns:

      • getConnection

        protected javax.jms.Connection getConnection()
                                      throws javax.jms.JMSException
        Throws:
        javax.jms.JMSException

      • createSession

        protected javax.jms.Session createSession​(int acknowledgeMode)
                                   throws javax.jms.JMSException
        Throws:
        javax.jms.JMSException

      • getProducerSession

        protected javax.jms.Session getProducerSession()
                                        throws javax.jms.JMSException
        Get the Session dedicated for sending messages.
        Returns:
        Throws:
        javax.jms.JMSException

      • getMessageProducer

        protected javax.jms.MessageProducer getMessageProducer()
                                                throws javax.jms.JMSException
        Throws:
        javax.jms.JMSException

      • getConsumerSession

        protected javax.jms.Session getConsumerSession()
                                        throws javax.jms.JMSException
        Get the Session dedicated for consuming messages.
        Returns:
        Throws:
        javax.jms.JMSException

      • getMessageConsumer

        protected javax.jms.MessageConsumer getMessageConsumer()
                                                throws javax.jms.JMSException
        Throws:
        javax.jms.JMSException

      • buildConnectionFactory

        protected org.apache.activemq.ActiveMQConnectionFactory buildConnectionFactory()
        Returns:
        Since:
        0.6.2.6

      • closeQuietly

        protected void closeQuietly​(javax.jms.Connection connection)

      • closeQuietly

        protected void closeQuietly​(javax.jms.Session session)

      • closeQuietly

        protected void closeQuietly​(javax.jms.MessageConsumer consumer)

      • closeQuietly

        protected void closeQuietly​(javax.jms.MessageProducer producer)

      • finish

        public void finish​(IQueueMessage<ID,​DATA> msg)
        Called when finish processing the message to cleanup ephemeral storage.

        Implementation flow:

        • Remove message from ephemeral storage.

        Note: ephemeral storage implementation is optional, depends on implementation.

      • take

        public IQueueMessage<ID,​DATA> take()
                                  throws QueueException.EphemeralIsFull
        Take a message out of queue.

        Implementation flow:

        • Read message from head of queue storage.
        • Write message to ephemeral storage.
        • Remove message from queue storage.

        Note: ephemeral storage implementation is optional, depends on implementation.

        Returns:
        Throws:
        QueueException.EphemeralIsFull - if the ephemeral storage is full

      • getOrphanMessages

        public Collection<IQueueMessage<ID,​DATA>> getOrphanMessages​(long thresholdTimestampMs)
        Get all orphan messages (messages that were left in ephemeral storage for a long time).
        Parameters:
        thresholdTimestampMs - message is orphan if message's timestampMillis + thresholdTimestampMs < now . Which means getOrphanMessages(10000) will return orphan messages that have stayed in ephemeral storage for more than 10000 milliseconds.
        Returns:
        null or empty collection if there is no orphan message

      • queueSize

        public int queueSize()
        Get number of items currently in queue storage.
        Returns:
        negative number if queue size can not be queried

      • ephemeralSize

        public int ephemeralSize()
        Get number of items currently in ephemeral storage.

        Note: ephemeral storage implementation is optional, depends on implementation.

        Returns:
        negative number if ephemeral size can not be queried