Static Message Selector Example

This example shows you how to configure a ActiveMQ Artemis queue with static message selectors (filters) (to configure a static selector directly on a JMS queue, please see the static-selector-jms example).

Static message selectors are ActiveMQ's extension to message selectors as defined in JMS spec 1.1. Rather than specifying the selector in the application code, static message selectors are defined in one of ActiveMQ's configuration files, broker.xml, as an element called 'filter' inside each queue definition, like

      <queues>     
      	<queue name="jms.queue.selectorQueue">
      	    <address>jms.queue.selectorQueue</address>
      	    <filter string="color='red'"/>
      	</queue>
      </queues>
     

Once configured the queue 'selectorQueue' only delivers messages that are selected against the filter, i.e., only the messages whose 'color' properties are of 'red' values can be received by its consumers. Those that don't match the filter will be dropped by the queue and therefore will never be delivered to any of its consumers.

In the example code, five messages with different 'color' property values are sent to queue 'selectorQueue'. One consumer is created to receive messages from the queue. Of the five sent messages, two are of 'red' color properties, one is 'blue', one is 'green' and one has not the 'color' property at all. The result is that the consumer only gets the two 'red' messages.

Example step-by-step

To run the example, simply type mvn verify -Pexample from this directory

1. First we need to get an initial context so we can look-up the JMS connection factory and destination objects from JNDI. This initial context will get it's properties from the client-jndi.properties file in the directory ../common/config

           InitialContext initialContext = getContext();
        

2. We look-up the JMS queue object from JNDI, this is the queue that has filter configured with it.

           Queue queue = (Queue) initialContext.lookup("/queue/selectorQueue");
        

3. We look-up the JMS connection factory object from JNDI

           ConnectionFactory cf = (ConnectionFactory) initialContext.lookup("/ConnectionFactory");
        

4. We create a JMS connection

           connection = cf.createConnection();
        

5. We start the connection

           connection.start();
        

6. We create a JMS session. The session is created as non transacted and will auto acknowledge messages.

           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
        

7. We create a JMS message producer on the session. This will be used to send the messages.

          MessageProducer producer = session.createProducer(queue);
       

8. We create a JMS message consumer that receives 'red' messages. The message listener will check the 'color' property on each received message.

           
         MessageConsumer redConsumer = session.createConsumer(queue);
         redConsumer.setMessageListener(new SimpleMessageListener("red"));
           
         

9. We reate five messages with different 'color' properties.

          
         TextMessage redMessage1 = session.createTextMessage("Red-1");
         redMessage1.setStringProperty("color", "red");
         TextMessage redMessage2 = session.createTextMessage("Red-2");
         redMessage2.setStringProperty("color", "red");
         TextMessage greenMessage = session.createTextMessage("Green");
         greenMessage.setStringProperty("color", "green");
         TextMessage blueMessage = session.createTextMessage("Blue");
         blueMessage.setStringProperty("color", "blue");
         TextMessage normalMessage = session.createTextMessage("No color");
         
        

10. We send those messages.

          
         producer.send(redMessage1);
         System.out.println("Message sent: " + redMessage1.getText());
         producer.send(greenMessage);
         System.out.println("Message sent: " + greenMessage.getText());
         producer.send(blueMessage);
         System.out.println("Message sent: " + blueMessage.getText());
         producer.send(redMessage2);
         System.out.println("Message sent: " + redMessage2.getText());
         producer.send(normalMessage);
         System.out.println("Message sent: " + normalMessage.getText());
          
        

11. Waiting for the message listener to check the received messages.

          
          Thread.sleep(5000);
         
        

12. And finally, always remember to close your JMS connections and resources after use, in a finally block. Closing a JMS connection will automatically close all of its sessions, consumers, producer and browser objects

           finally
           {
              if (initialContext != null)
              {
                initialContext.close();
              }
              if (connection != null)
              {
                 connection.close();
              }
           }