ActiveMQ Artemis JMX Management Example

# JMX Management Example

    To run the example, simply type mvn verify from this directory,
    or mvn -PnoServer verify if you want to start and create the server manually.

This example shows how to manage ActiveMQ Artemis using JMX

## Example configuration

ActiveMQ Artemis exposes its managed resources by default on the platform MBeanServer.

To access this MBeanServer remotely, the Java Virtual machine must be started with system properties:

                 -Dcom.sun.management.jmxremote
                 -Dcom.sun.management.jmxremote.port=3000
                 -Dcom.sun.management.jmxremote.ssl=false
                 -Dcom.sun.management.jmxremote.authenticate=false

These properties are explained in the Java management guide (please note that for this example, we will disable user authentication for simplicity sake).

With these properties, ActiveMQ Artemis server will be manageable remotely using standard JMX URL on port `3000`.

## Example step-by-step

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 its properties from client-jndi.properties

                InitialContext initialContext = getContext(0);

2. We look up the JMS queue object from JNDI

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

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 create a JMS session. The session is created as non transacted and will auto acknowledge messages.

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

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

                MessageProducer messageProducer = session.createProducer(topic);

7. We create a JMS text message that we are going to send.

                TextMessage message = session.createTextMessage("This is a text message");

8. We send message to the queue

                messageProducer.send(message);

Now that we have a message in the queue, we will manage the queue by retrieving the number of messages in the queue (i.e. 1) and by removing the message which has been sent in step 8.

9. We retrieve the `ObjectName` corresponding to the queue using a helper class `ObjectNameBuilder`

                  ObjectName on = ObjectNameBuilder.DEFAULT.getJMSQueueObjectName(queue.getQueueName());

10. We create a JMX Connector to connect to the server's MBeanServer using the standard JMX service URL

                JMXConnector connector = JMXConnectorFactory.connect(new JMXServiceURL(JMX_URL), new HashMap());

11. We retrieve a `MBeanServerConnection` from the JMX connector

               TextMessage messageReceived = (TextMessage) messageConsumer.receive(5000);

12. We create a `JMSQueueControl` proxy to manage the queue on the server

                JMSQueueControl queueControl = (JMSQueueControl)MBeanServerInvocationHandler.newProxyInstance(mbsc,
                                                                                                  on,
                                                                                                  JMSQueueControl.class,
                                                                                                  false);

13. We use this mbean proxy to retrieve the number of messages in the queue using the `getMessageCount` method

                System.out.println(queueControl.getName() + " contains " + queueControl.getMessageCount() + " messages");

14. We will now remove the message sent at step 8 using the `removeMessage` method with the JMS Message ID of the message

                System.out.println("message has been removed: " + queueControl.removeMessage(message.getJMSMessageID()));

15. We use again the mbean proxy to retrieve the number of messages. This time, it will display `0` messages

                System.out.println(queueControl.getName() + " contains " + queueControl.getMessageCount() + " messages");

16. Now we have finish the management operations, we close the JMX connector

                connector.close()

We will now try to consume the message sent to the queue but it won't be there: it has been removed by the management operation

17. We create a JMS message consumer on the queue

                MessageConsumer messageConsumer = session.createConsumer(queue);

18. We start the connection. In order for delivery to occur on any consumers or subscribers on a connection, the connection must be started

                connection.start();

19. We try to receive a message from the queue. Since there is none, the call will timeout after 5000ms and messageReceived will be null

                TextMessage messageReceived = (TextMessage) messageConsumer.receive(5000);
                System.out.println("Received message: " + messageReceived);

20. 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();
                  }
               }

## More information

- User Manual's Using Management Via JMX chapter
- Java management guide