Managing AMQ Broker

Procedure

1. Download the desired archive from the Red Hat Customer Portal by following the instructions provided in Downloading the AMQ Broker archive.

2. Change the owner of the archive to the same user that owns the AMQ Broker installation to be upgraded.

   sudo chown amq-broker:amq-broker jboss-amq-7.x.x.redhat-1.zip

3. Move the archive to the directory created during the original installation of AMQ Broker. In the following example, the directory /opt/redhat is used.

   sudo mv jboss-amq-7.x.x.redhat-1.zip /opt/redhat

4. As the directory owner, extract the contents of the compressed archive. The archive is kept in a compressed format. In the following example, the user amq-broker extracts the archive by using the unzip command.

   su - amq-broker
   cd /opt/redhat
   unzip jboss-amq-7.x.x.redhat-1.zip

5. Stop the broker if it is running.

   BROKER_INSTANCE_DIR/bin/artemis stop

6. Back up the instance directory of the broker by copying it to the home directory of the current user.

   cp -r BROKER_INSTANCE_DIR ~/

7. (Optional) Note the current version of the broker. After the broker stops, a line similar to the one below is displayed at the end of its log file, which can be found at BROKER_INSTANCE_DIR/log/artemis.log.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221002: Apache ActiveMQ Artemis Message Broker version 2.0.0.amq-700005-redhat-1 [4782d50d-47a2-11e7-a160-9801a793ea45] stopped, uptime 28 minutes

8. Edit the BROKER_INSTANCE_DIR/etc/artemis.profile configuration file to set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

   ARTEMIS_HOME='/opt/redhat/jboss-amq-7.x.x-redhat-1'

9. Restart the broker by entering the following command:

   BROKER_INSTANCE_DIR/bin/artemis run

10. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the log file BROKER_INSTANCE_DIR/log/artemis.log and find two lines similar to the ones below. Note the new version number that appears in the log after the broker is live.

    INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
    ...
    INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.1.0.amq-700005-redhat-1 [0.0.0.0, nodeID=4782d50d-47a2-11e7-a160-9801a793ea45]

Procedure

1. Download the desired archive from the Red Hat Customer Portal by following the instructions provided in Downloading the AMQ Broker archive.
2. Use a file manager to move the archive to the folder you created during the last installation of AMQ Broker.
3. Extract the file contents into the directory by right-clicking on the zip file and choosing Extract All.

4. Stop the broker if it is running by entering the following command.

   BROKER_INSTANCE_DIR\bin\artemis-service.exe stop

5. Back up the broker by using a file manager.

   1. Right click on the BROKER_INSTANCE_DIR folder and select Copy.
   2. Right click in the same window and select Paste.

6. (Optional) Note the current version of the broker. After the broker stops, a line similar to the one below is displayed at the end of its log file, which can be found at BROKER_INSTANCE_DIR\log\artemis.log.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221002: Apache ActiveMQ Artemis Message Broker version 2.0.0.amq-700005-redhat-1 [4782d50d-47a2-11e7-a160-9801a793ea45] stopped, uptime 28 minutes

7. Edit the BROKER_INSTANCE_DIR\etc\artemis.profile configuration file to set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

   ARTEMIS_HOME=NEW_INSTALL_DIR

8. Restart the broker entering the following command:

   BROKER_INSTANCE_DIR\bin\artemis-service.exe start

9. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the log file BROKER_INSTANCE_DIR\log\artemis.log and find two lines similar to the ones below. Note the new version number that appears in the log after the broker is live.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
   ...
   INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.1.0.amq-700005-redhat-1 [0.0.0.0, nodeID=4782d50d-47a2-11e7-a160-9801a793ea45]

Procedure

1. If it is running, stop the 7.0.x broker you want to upgrade:

   $ BROKER_INSTANCE_DIR/bin/artemis stop

2. Back up the instance directory of the broker by copying it to the home directory of the current user.

   cp -r BROKER_INSTANCE_DIR ~/

3. Open the file artemis.profile in the BROKER_INSTANCE_DIR/etc/ directory of the 7.0.x broker.

   1. Update the ARTEMIS_HOME property so that its value refers to the installation directory for AMQ Broker 7.1.0:

      ARTEMIS_HOME="7.1.0_INSTALL_DIR"

   2. On the line below the one you updated, add the property ARTEMIS_INSTANCE_URI and assign it a value that refers to the 7.0.x broker instance directory:

      ARTEMIS_INSTANCE_URI="file://7.0.x_BROKER_INSTANCE_DIR"

   3. Update the JAVA_ARGS property by adding the jolokia.policyLocation parameter and assigning it the following value:

      -Djolokia.policyLocation=${ARTEMIS_INSTANCE_URI}/etc/jolokia-access.xml

4. Create a 7.1.0 broker instance. The creation procedure generates the configuration files required to upgrade from 7.0.x to 7.1.0. In the following example, note that the instance is created in the directory upgrade_tmp:

   $ 7.1.0_INSTALL_DIR/bin/artemis create --allow-anonymous --user admin --password admin upgrade_tmp

5. Copy configuration files from the etc directory of the temporary 7.1.0 instance into the BROKER_INSTANCE_DIR/etc/ directory of the 7.0.x broker.

   1. Copy the management.xml file:

      $ cp TEMPORARY_7.1.0_BROKER_INSTANCE_DIR/etc/management.xml 7.0_BROKER_INSTANCE_DIR/etc/

   2. Copy the jolokia-access.xml file:

      $ cp TEMPORARY_7.1.0_BROKER_INSTANCE_DIR/etc/jolokia-access.xml 7.0_BROKER_INSTANCE_DIR/etc/

6. Open up the bootstrap.xml file in the BROKER_INSTANCE_DIR/etc/ directory of the 7.0.x broker.

   1. Comment out or delete the following two lines:

      <app url="jolokia" war="jolokia.war"/>
      <app url="hawtio" war="hawtio-no-slf4j.war"/>

   2. Add the following to replace the two lines removed in the previous step:

      <app url="console" war="console.war"/>

7. Start the broker that you upgraded:

   $ BROKER_INSTANCE_DIR/bin/artemis run

Procedure

1. If it is running, stop the 7.0.x broker you want to upgrade:

   > BROKER_INSTANCE_DIR\bin\artemis-service.exe stop

2. Back up the instance directory of the broker by using a file manager.

   1. Right click on the BROKER_INSTANCE_DIR folder and select Copy.
   2. Right click in the same window and select Paste.

3. Open the file artemis.profile in the BROKER_INSTANCE_DIR/etc/ directory of the 7.0.x broker.

   1. Update the ARTEMIS_HOME property so that its value refers to the installation directory for AMQ Broker 7.1.0:

      ARTEMIS_HOME="7.1.0_INSTALL_DIR"

   2. On the line below the one you updated, add the property ARTEMIS_INSTANCE_URI and assign it a value that refers to the 7.0.x broker instance directory:

      ARTEMIS_INSTANCE_URI="file://7.0.x_BROKER_INSTANCE_DIR"

   3. Update the JAVA_ARGS property by adding the jolokia.policyLocation parameter and assigning it the following value:

      -Djolokia.policyLocation=${ARTEMIS_INSTANCE_URI}/etc/jolokia-access.xml

4. Create a 7.1.0 broker instance. The creation procedure generates the configuration files required to upgrade from 7.0.x to 7.1.0. In the following example, note that the instance is created in the directory upgrade_tmp:

   > 7.1.0_INSTALL_DIR/bin/artemis create --allow-anonymous --user admin --password admin upgrade_tmp

5. Copy configuration files from the etc directory of the temporary 7.1.0 instance into the BROKER_INSTANCE_DIR/etc/ directory of the 7.0.x broker.

   1. Copy the management.xml file:

      > cp TEMPORARY_7.1.0_BROKER_INSTANCE_DIR/etc/management.xml 7.0_BROKER_INSTANCE_DIR/etc/

   2. Copy the jolokia-access.xml file:

      > cp TEMPORARY_7.1.0_BROKER_INSTANCE_DIR/etc/jolokia-access.xml 7.0_BROKER_INSTANCE_DIR/etc/

6. Open up the bootstrap.xml file in the BROKER_INSTANCE_DIR/etc/ directory of the 7.0.x broker.

   1. Comment out or delete the following two lines:

      <app url="jolokia" war="jolokia.war"/>
      <app url="hawtio" war="hawtio-no-slf4j.war"/>

   2. Add the following to replace the two lines removed in the previous step:

      <app url="console" war="console.war"/>

7. Start the broker that you upgraded:

   > BROKER_INSTANCE_DIR\bin\artemis-service.exe start

Procedure

1. Download the desired archive from the Red Hat Customer Portal by following the instructions provided in Downloading the AMQ Broker archive.

2. Change the owner of the archive to the same user that owns the AMQ Broker installation to be upgraded.

   sudo chown amq-broker:amq-broker amq-7.x.x.redhat-1.zip

3. Move the archive to the directory created during the original installation of AMQ Broker. In the following example, the directory /opt/redhat is used.

   sudo mv amq-7.x.x.redhat-1.zip /opt/redhat

4. As the directory owner, extract the contents of the compressed archive. In the following example, the user amq-broker extracts the archive by using the unzip command.

   su - amq-broker
   cd /opt/redhat
   unzip jboss-amq-7.x.x.redhat-1.zip

5. Stop the broker if it is running.

   BROKER_INSTANCE_DIR/bin/artemis stop

6. Back up the instance directory of the broker by copying it to the home directory of the current user.

   cp -r BROKER_INSTANCE_DIR ~/

7. (Optional) Note the current version of the broker. After the broker stops, a line similar to the one below is displayed at the end of its log file, which can be found at BROKER_INSTANCE_DIR/log/artemis.log.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.5.0.amq-720001-redhat-1 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

8. Edit the BROKER_INSTANCE_DIR/etc/artemis.profile configuration file to set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

   ARTEMIS_HOME='/opt/redhat/amq-7.x.x-redhat-1'

9. Restart the broker by entering the following command:

   BROKER_INSTANCE_DIR/bin/artemis run

10. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the log file BROKER_INSTANCE_DIR/log/artemis.log and find two lines similar to the ones below. Note the new version number that appears in the log after the broker is live.

    INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
    ...
    INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.5.0.amq-720001-redhat-1 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

Procedure

1. Download the desired archive from the Red Hat Customer Portal by following the instructions provided in Downloading the AMQ Broker archive.
2. Use a file manager to move the archive to the folder you created during the last installation of AMQ Broker.
3. Extract the file contents into the directory by right-clicking on the zip file and choosing Extract All.

4. Stop the broker if it is running by entering the following command.

   BROKER_INSTANCE_DIR\bin\artemis-service.exe stop

5. Back up the broker by using a file manager.

   1. Right click on the BROKER_INSTANCE_DIR folder and select Copy.
   2. Right click in the same window and select Paste.

6. (Optional) Note the current version of the broker. After the broker stops, a line similar to the one below is displayed at the end of its log file, which can be found at BROKER_INSTANCE_DIR\log\artemis.log.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221002: Apache ActiveMQ Artemis Message Broker version 2.0.0.amq-700005-redhat-1 [4782d50d-47a2-11e7-a160-9801a793ea45] stopped, uptime 28 minutes

7. Edit the BROKER_INSTANCE_DIR\etc\artemis.profile.cmd and BROKER_INSTANCE_DIR\bin\artemis-service.xml configuration files to set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

   ARTEMIS_HOME=NEW_INSTALL_DIR

8. Restart the broker entering the following command:

   BROKER_INSTANCE_DIR\bin\artemis-service.exe start

9. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the log file BROKER_INSTANCE_DIR\log\artemis.log and find two lines similar to the ones below. Note the new version number that appears in the log after the broker is live.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
   ...
   INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.5.0.amq-720001-redhat-1 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

Procedure

1. Download the desired archive from the Red Hat Customer Portal by following the instructions provided in Downloading the AMQ Broker archive.

2. Change the owner of the archive to the same user that owns the AMQ Broker installation to be upgraded.

   sudo chown amq-broker:amq-broker amq-7.x.x.redhat-1.zip

3. Move the archive to the directory created during the original installation of AMQ Broker. In the following example, the directory /opt/redhat is used.

   sudo mv amq-7.x.x.redhat-1.zip /opt/redhat

4. As the directory owner, extract the contents of the compressed archive. In the following example, the user amq-broker extracts the archive by using the unzip command.

   su - amq-broker
   cd /opt/redhat
   unzip jboss-amq-7.x.x.redhat-1.zip

5. Stop the broker if it is running.

   BROKER_INSTANCE_DIR/bin/artemis stop

6. Back up the instance directory of the broker by copying it to the home directory of the current user.

   cp -r BROKER_INSTANCE_DIR ~/

7. (Optional) Note the current version of the broker. After the broker stops, a line similar to the one below is displayed at the end of its log file, which can be found at BROKER_INSTANCE_DIR/log/artemis.log.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.6.3.amq-720001-redhat-1 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

8. Edit the BROKER_INSTANCE_DIR/etc/artemis.profile configuration file to set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

   ARTEMIS_HOME='/opt/redhat/amq-7.x.x-redhat-1'

9. Restart the broker by entering the following command:

   BROKER_INSTANCE_DIR/bin/artemis run

10. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the log file BROKER_INSTANCE_DIR/log/artemis.log and find two lines similar to the ones below. Note the new version number that appears in the log after the broker is live.

    INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
    ...
    INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.7.0.redhat-00054 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

Procedure

1. Download the desired archive from the Red Hat Customer Portal by following the instructions provided in Downloading the AMQ Broker archive.
2. Use a file manager to move the archive to the folder you created during the last installation of AMQ Broker.
3. Extract the file contents into the directory by right-clicking on the zip file and choosing Extract All.

4. Stop the broker if it is running by entering the following command.

   BROKER_INSTANCE_DIR\bin\artemis-service.exe stop

5. Back up the broker by using a file manager.

   1. Right click on the BROKER_INSTANCE_DIR folder and select Copy.
   2. Right click in the same window and select Paste.

6. (Optional) Note the current version of the broker. After the broker stops, a line similar to the one below is displayed at the end of its log file, which can be found at BROKER_INSTANCE_DIR\log\artemis.log.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221002: Apache ActiveMQ Artemis Message Broker version 2.6.3.amq-720001-redhat-1 [4782d50d-47a2-11e7-a160-9801a793ea45] stopped, uptime 28 minutes

7. Edit the BROKER_INSTANCE_DIR\etc\artemis.profile.cmd and BROKER_INSTANCE_DIR\bin\artemis-service.xml configuration files to set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

   ARTEMIS_HOME=NEW_INSTALL_DIR

8. Edit the BROKER_INSTANCE_DIR\etc\artemis.profile.cmd configuration file to set the JAVA_ARGS environment variable to reference the correct log manager version.

   JAVA_ARGS=NEW_INSTALL_DIR\lib\jboss-logmanager-2.0.3.Final-redhat-1.jar

9. Edit the BROKER_INSTANCE_DIR\bin\artemis-service.xml configuration file to set the bootstrap class path argument to reference the correct log manager version.

   Xbootclasspath/a:%ARTEMIS_HOME%\lib\jboss-logmanager-2.0.3.Final-redhat-1.jar

10. Restart the broker entering the following command:

    BROKER_INSTANCE_DIR\bin\artemis-service.exe start

11. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the log file BROKER_INSTANCE_DIR\log\artemis.log and find two lines similar to the ones below. Note the new version number that appears in the log after the broker is live.

    INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
    ...
    INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.7.0.redhat-00054 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

Procedure

1. Download the desired archive from the Red Hat Customer Portal. Follow the instructions provided in Downloading the AMQ Broker archive.

2. Change the owner of the archive to the same user that owns the AMQ Broker installation to be upgraded. The following example shows a user called amq-broker.

   sudo chown amq-broker:amq-broker amq-broker-7.x.x.redhat-1.zip

3. Move the archive to the directory created during the original installation of AMQ Broker. The following example uses /opt/redhat.

   sudo mv amq-broker-7.x.x.redhat-1.zip /opt/redhat

4. As the directory owner, extract the contents of the compressed archive. In the following example, the user amq-broker extracts the archive using the unzip command.

   su - amq-broker
   cd /opt/redhat
   unzip amq-broker-7.x.x.redhat-1.zip

5. If the broker is running, stop it.

   BROKER_INSTANCE_DIR/bin/artemis stop

6. Back up the instance directory of the broker by copying it to the home directory of the current user.

   cp -r BROKER_INSTANCE_DIR ~/

7. (Optional) Note the current version of the broker. After the broker stops, you see a line similar to the one below at the end of the BROKER_INSTANCE_DIR/log/artemis.log file.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.7.0.redhat-00054 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

8. Edit the BROKER_INSTANCE_DIR/etc/artemis.profile configuration file.

   1. Set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

      ARTEMIS_HOME='/opt/redhat/amq-broker-7.x.x-redhat-1'

   2. Edit the JAVA_ARGS property. Add the bootstrap class path argument, which references a dependent file for the log manager.

      -Xbootclasspath/a:$ARTEMIS_HOME/lib/wildfly-common-1.5.1.Final-redhat-00001.jar

9. Edit the BROKER_INSTANCE_DIR/etc/bootstrap.xml configuration file. In the <web> configuration element, add a reference to the metrics plugin file for AMQ Broker.

   <app url="metrics" war="metrics.war"/>

10. Restart the broker.

    BROKER_INSTANCE_DIR/bin/artemis run

11. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the BROKER_INSTANCE_DIR/log/artemis.log file. Find two lines similar to the ones below. Note the new version number that appears in the log when the broker is live.

    INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
    ...
    INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.9.0.redhat-00001 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

Procedure

1. Download the desired archive from the Red Hat Customer Portal. Follow the instructions provided in Downloading the AMQ Broker archive.
2. Use a file manager to move the archive to the folder you created during the last installation of AMQ Broker.
3. Extract the file contents into the installation directory. Right-click the .zip file and select Extract All.

4. If the broker is running, stop it.

   BROKER_INSTANCE_DIR\bin\artemis-service.exe stop

5. Back up the broker using a file manager.

   1. Right click the BROKER_INSTANCE_DIR folder. Select Copy.
   2. Right click in the same window. Select Paste.

6. (Optional) Note the current version of the broker. After the broker stops, you see a line similar to the one below at the end of the BROKER_INSTANCE_DIR\log\artemis.log file.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221002: Apache ActiveMQ Artemis Message Broker version 2.7.0.redhat-00054 [4782d50d-47a2-11e7-a160-9801a793ea45] stopped, uptime 28 minutes

7. Edit the BROKER_INSTANCE_DIR\etc\artemis.profile.cmd and BROKER_INSTANCE_DIR\bin\artemis-service.xml configuration files. Set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

   ARTEMIS_HOME=NEW_INSTALL_DIR

8. Edit the BROKER_INSTANCE_DIR\etc\artemis.profile.cmd configuration file. Set the JAVA_ARGS environment variable to reference the correct log manager version and dependent file.

   JAVA_ARGS=-Xbootclasspath/%ARTEMIS_HOME%\lib\jboss-logmanager-2.1.10.Final-redhat-00001.jar;%ARTEMIS_HOME%\lib\wildfly-common-1.5.1.Final-redhat-00001.jar

9. Edit the BROKER_INSTANCE_DIR\bin\artemis-service.xml configuration file. Set the bootstrap class path argument to reference the correct log manager version and dependent file.

   <argument>-Xbootclasspath/a:%ARTEMIS_HOME%\lib\jboss-logmanager-2.1.10.Final-redhat-00001.jar;%ARTEMIS_HOME%\lib\wildfly-common-1.5.1.Final-redhat-00001.jar</argument>

10. Edit the BROKER_INSTANCE_DIR\etc\bootstrap.xml configuration file. In the <web> configuration element, add a reference to the metrics plugin file for AMQ Broker.

    <app url="metrics" war="metrics.war"/>

11. Restart the broker.

    BROKER_INSTANCE_DIR\bin\artemis-service.exe start

12. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the BROKER_INSTANCE_DIR\log\artemis.log file. Find two lines similar to the ones below. Note the new version number that appears in the log when the broker is live.

    INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
    ...
    INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.9.0.redhat-00001 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

Procedure

1. Download the desired archive from the Red Hat Customer Portal. Follow the instructions provided in Downloading the AMQ Broker archive.

2. Change the owner of the archive to the same user that owns the AMQ Broker installation to be upgraded. The following example shows a user called amq-broker.

   sudo chown amq-broker:amq-broker amq-broker-7.4.x.redhat-1.zip

3. Move the archive to the directory created during the original installation of AMQ Broker. The following example uses /opt/redhat.

   sudo mv amq-broker-7.4.x.redhat-1.zip /opt/redhat

4. As the directory owner, extract the contents of the compressed archive. In the following example, the user amq-broker extracts the archive using the unzip command.

   su - amq-broker
   cd /opt/redhat
   unzip amq-broker-7.4.x.redhat-1.zip

5. If the broker is running, stop it.

   BROKER_INSTANCE_DIR/bin/artemis stop

6. Back up the instance directory of the broker by copying it to the home directory of the current user.

   cp -r BROKER_INSTANCE_DIR ~/

7. (Optional) Note the current version of the broker. After the broker stops, you see a line similar to the one below at the end of the BROKER_INSTANCE_DIR/log/artemis.log file.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.7.0.redhat-00054 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

8. Edit the BROKER_INSTANCE_DIR/etc/artemis.profile configuration file. Set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

   ARTEMIS_HOME='/opt/redhat/amq-broker-7.4.x-redhat-1'

9. Restart the broker.

   BROKER_INSTANCE_DIR/bin/artemis run

10. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the BROKER_INSTANCE_DIR/log/artemis.log file. Find two lines similar to the ones below. Note the new version number that appears in the log when the broker is live.

    INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
    ...
    INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.9.0.redhat-00001 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

Procedure

1. Download the desired archive from the Red Hat Customer Portal. Follow the instructions provided in Downloading the AMQ Broker archive.
2. Use a file manager to move the archive to the folder you created during the last installation of AMQ Broker.
3. Extract the file contents into the installation directory. Right-click the .zip file and select Extract All.

4. If the broker is running, stop it.

   BROKER_INSTANCE_DIR\bin\artemis-service.exe stop

5. Back up the broker using a file manager.

   1. Right click the BROKER_INSTANCE_DIR folder. Select Copy.
   2. Right click in the same window. Select Paste.

6. (Optional) Note the current version of the broker. After the broker stops, you see a line similar to the one below at the end of the BROKER_INSTANCE_DIR\log\artemis.log file.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221002: Apache ActiveMQ Artemis Message Broker version 2.7.0.redhat-00054 [4782d50d-47a2-11e7-a160-9801a793ea45] stopped, uptime 28 minutes

7. Edit the BROKER_INSTANCE_DIR\etc\artemis.profile.cmd and BROKER_INSTANCE_DIR\bin\artemis-service.xml configuration files. Set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

   ARTEMIS_HOME=NEW_INSTALL_DIR

8. Restart the broker.

   BROKER_INSTANCE_DIR\bin\artemis-service.exe start

9. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the BROKER_INSTANCE_DIR\log\artemis.log file. Find two lines similar to the ones below. Note the new version number that appears in the log when the broker is live.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
   ...
   INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.9.0.redhat-00001 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

Procedure

1. Download the desired archive from the Red Hat Customer Portal. Follow the instructions provided in Downloading the AMQ Broker archive.

2. Change the owner of the archive to the same user that owns the AMQ Broker installation to be upgraded. The following example shows a user called amq-broker.

   sudo chown amq-broker:amq-broker amq-broker-7.5.0.redhat-1.zip

3. Move the archive to the directory created during the original installation of AMQ Broker. The following example uses /opt/redhat.

   sudo mv amq-broker-7.5.0.redhat-1.zip /opt/redhat

4. As the directory owner, extract the contents of the compressed archive. In the following example, the user amq-broker extracts the archive using the unzip command.

   su - amq-broker
   cd /opt/redhat
   unzip amq-broker-7.5.0.redhat-1.zip

5. If the broker is running, stop it.

   BROKER_INSTANCE_DIR/bin/artemis stop

6. Back up the instance directory of the broker by copying it to the home directory of the current user.

   cp -r BROKER_INSTANCE_DIR ~/

7. (Optional) Note the current version of the broker. After the broker stops, you see a line similar to the one below at the end of the BROKER_INSTANCE_DIR/log/artemis.log file.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.7.0.redhat-00054 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

8. Edit the BROKER_INSTANCE_DIR/etc/artemis.profile configuration file.

   1. Set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

      ARTEMIS_HOME='/opt/redhat/amq-broker-7.5.0-redhat-1'

   2. Edit the JAVA_ARGS property. Add the bootstrap class path argument, which references a dependent file for the log manager.

      -Xbootclasspath/a:$ARTEMIS_HOME/lib/wildfly-common-1.5.2.Final-redhat-00001.jar

9. Restart the broker.

   BROKER_INSTANCE_DIR/bin/artemis run

10. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the BROKER_INSTANCE_DIR/log/artemis.log file. Find two lines similar to the ones below. Note the new version number that appears in the log when the broker is live.

    INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
    ...
    INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.9.0.redhat-00001 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

Procedure

1. Download the desired archive from the Red Hat Customer Portal. Follow the instructions provided in Downloading the AMQ Broker archive.
2. Use a file manager to move the archive to the folder you created during the last installation of AMQ Broker.
3. Extract the file contents into the installation directory. Right-click the .zip file and select Extract All.

4. If the broker is running, stop it.

   BROKER_INSTANCE_DIR\bin\artemis-service.exe stop

5. Back up the broker using a file manager.

   1. Right click the BROKER_INSTANCE_DIR folder. Select Copy.
   2. Right click in the same window. Select Paste.

6. (Optional) Note the current version of the broker. After the broker stops, you see a line similar to the one below at the end of the BROKER_INSTANCE_DIR\log\artemis.log file.

   INFO  [org.apache.activemq.artemis.core.server] AMQ221002: Apache ActiveMQ Artemis Message Broker version 2.7.0.redhat-00054 [4782d50d-47a2-11e7-a160-9801a793ea45] stopped, uptime 28 minutes

7. Edit the BROKER_INSTANCE_DIR\etc\artemis.profile.cmd and BROKER_INSTANCE_DIR\bin\artemis-service.xml configuration files. Set the ARTEMIS_HOME property to the new directory created when the archive was extracted.

   ARTEMIS_HOME=NEW_INSTALL_DIR

8. Edit the BROKER_INSTANCE_DIR\etc\artemis.profile.cmd configuration file. Set the JAVA_ARGS environment variable to reference the correct log manager version and dependent file.

   JAVA_ARGS=-Xbootclasspath/%ARTEMIS_HOME%\lib\jboss-logmanager-2.1.10.Final-redhat-00001.jar;%ARTEMIS_HOME%\lib\wildfly-common-1.5.2.Final-redhat-00001.jar

9. Edit the BROKER_INSTANCE_DIR\bin\artemis-service.xml configuration file. Set the bootstrap class path argument to reference the correct log manager version and dependent file.

   <argument>-Xbootclasspath/a:%ARTEMIS_HOME%\lib\jboss-logmanager-2.1.10.Final-redhat-00001.jar;%ARTEMIS_HOME%\lib\wildfly-common-1.5.2.Final-redhat-00001.jar</argument>

10. Restart the broker.

    BROKER_INSTANCE_DIR\bin\artemis-service.exe start

11. (Optional) Confirm that the broker is running and that the version has changed. After starting the broker, open the BROKER_INSTANCE_DIR\log\artemis.log file. Find two lines similar to the ones below. Note the new version number that appears in the log when the broker is live.

    INFO  [org.apache.activemq.artemis.core.server] AMQ221007: Server is now live
    ...
    INFO  [org.apache.activemq.artemis.core.server] AMQ221001: Apache ActiveMQ Artemis Message Broker version 2.9.0.redhat-00001 [0.0.0.0, nodeID=554cce00-63d9-11e8-9808-54ee759954c4]

Procedure

1. Open the <broker-instance-dir>/etc/jolokia-access.xml file in a text editor.

2. Within the <cors> section, edit the allow-origin settings to add each URL that you want to allow to access AMQ Console. For example:

   <cors>
      <!-- allow access to web console from localhost -->
      <allow-origin>https://localhost:8161/*</allow-origin>
      <!-- Check for the proper origin on the server side, too -->
      <strict-checking/>
   </cors>

3. Save the file.

Procedure

1. Open the <broker-instance-dir>/etc/bootstrap.xml file.

2. In the <web> element, add the following attributes:

   <web bind="https://localhost:8161"
       path="web"
       keyStorePath="<path_to_KeyStore>"
       keyStorePassword="<password>"
       clientAuth="<true/false>"
       trustStorePath="<path_to_TrustStore>"
       trustStorePassword="<password>">
       ...
   </web>

   Attribute	Description
   bind	Change the URI scheme to https.
   keyStorePath	The path of the KeyStore file. For example: keyStorePath="${artemis.instance}/etc/keystore.jks"
   keyStorePassword	The KeyStore’s password.
   clientAuth	Specifies whether client authentication is required. The default is false, but you can change it to true to enable authentication.
   trustStorePath	The path of the TrustStore file. This attribute is only needed if clientAuth is true.
   trustStorePassword	The TrustStore’s password.

Procedure

1. In AMQ Console, click the Dashboard tab.

   The Monitor dashboard appears, displaying real-time data about hawtio.

   
2. To switch to a different dashboard, click the dashboard tab.

Procedure

1. In AMQ Console, click the Dashboard tab.

2. On the navigation bar, click Manage.

   Note

   The Manage page appears displaying a list of existing dashboards.

   

3. Do one of the following:

   To…​	Do this…​
   Create a new, blank dashboard	Click Create.
   Create a dashboard similar to an existing dashboard	Click the checkbox next to an existing dashboard. Click Duplicate.

4. To change the name of the dashboard:

   1. Hover over the dashboard name and click the pencil icon ( ).
   2. Enter a new name for the dashboard and then click the checkmark icon ( ).

Procedure

1. Create a new dashboard.
2. Add AMQ Broker data to the dashboard.
3. Change the dashboard layout as needed.

Procedure

1. Click the Artemis tab.

2. On the navigation bar, click the add icon ( ).

   The Dashboard tab appears, displaying a list of available dashboards.

3. Select the dashboard (or dashboards) which you want the chart to appear, and then click Add View To Dashboard. The chart is added to the dashboards you selected.

Procedure

1. On the Artemis tab, click Diagram.

   This example shows three brokers with 10 queues.

   
2. To change what objects are displayed on the diagram, click the View drop-down and select the items that you want to be displayed.

Procedure

1. On the Artemis tab, in the folder tree, expand the acceptors folder.

2. Click an acceptor to view details about how it is configured.

   This example shows the configuration properties for the amqp acceptor, which is the default acceptor provided for the AMQP protocol:

   

Procedure

1. Switch to the user account you created during installation.

   $ su - amq-broker

2. Use the artemis run command to start the broker instance.

   $ /var/opt/amq-broker/mybroker/bin/artemis run
   
             __  __  ____    ____            _
       /\   |  \/  |/ __ \  |  _ \          | |
      /  \  | \  / | |  | | | |_) |_ __ ___ | | _____ _ __
     / /\ \ | |\/| | |  | | |  _ <| '__/ _ \| |/ / _ \ '__|
    / ____ \| |  | | |__| | | |_) | | | (_) |   <  __/ |
   /_/    \_\_|  |_|\___\_\ |____/|_|  \___/|_|\_\___|_|
   
   Red Hat JBoss AMQ 7.2.1.GA
   
   10:53:43,959 INFO  [org.apache.activemq.artemis.integration.bootstrap] AMQ101000: Starting ActiveMQ Artemis Server
   10:53:44,076 INFO  [org.apache.activemq.artemis.core.server] AMQ221000: live Message Broker is starting with configuration Broker Configuration (clustered=false,journalDirectory=./data/journal,bindingsDirectory=./data/bindings,largeMessagesDirectory=./data/large-messages,pagingDirectory=./data/paging)
   10:53:44,099 INFO  [org.apache.activemq.artemis.core.server] AMQ221012: Using AIO Journal
   ...

   The broker starts and displays log output with the following information:

   • The location of the transaction logs and cluster configuration.
   • The type of journal being used for message persistence (AIO in this case).

   • The URI(s) that can accept client connections.

     By default, port 61616 can accept connections from any of the supported protocols (CORE, MQTT, AMQP, STOMP, HORNETQ, and OPENWIRE). There are separate, individual ports for each protocol as well.

   • The web console is available at http://localhost:8161.
   • The Jolokia service (JMX over REST) is available at http://localhost:8161/jolokia.

Procedure

1. Create a new amq-broker.service file in the /etc/systemd/system/ directory.

2. Copy the following text into the file.

   Modify the path and user fields according to the information provided during the broker instance creation. In the example below, the user amq-broker starts the broker service installed under the /var/opt/amq-broker/mybroker/ directory.

   [Unit]
   Description=AMQ Broker
   After=syslog.target network.target
   
   [Service]
   ExecStart=/var/opt/amq-broker/mybroker/bin/artemis run
   Restart=on-failure
   User=amq-broker
   Group=amq-broker
   
   # A workaround for Java signal handling
   SuccessExitStatus=143
   
   [Install]
   WantedBy=multi-user.target

3. Open a terminal.

4. Enable the broker service using the following command:

   sudo systemctl enable amq-broker

5. Run the broker service using the following command:

   sudo systemctl start amq-broker

Procedure

1. Open a command prompt to enter the commands

2. Install the broker as a service with the following command:

   <broker-instance-dir>\bin\artemis-service.exe install

3. Start the service by using the following command:

   <broker-instance-dir>\bin\artemis-service.exe start

4. (Optional) Uninstall the service:

   <broker-instance-dir>\bin\artemis-service.exe uninstall

Procedure

1. Open the configuration file <broker-instance-dir>\etc\broker.xml.

2. Add the graceful-shutdown-enabled configuration element and set the value to true.

   <configuration>
        <core>
             ...
             <graceful-shutdown-enabled>
                 true
             </graceful-shutdown-enabled>
             ...
        </core>
   </configuration>

3. Add the graceful-shutdown-timeout configuration element and set a value for the timeout in milliseconds. In the following example, client connections are forcefully closed 30 seconds (30000 milliseconds) after the stop command is issued.

   <configuration>
        <core>
             ...
             <graceful-shutdown-enabled>
                 true
             </graceful-shutdown-enabled>
             <graceful-shutdown-timeout>
                 30000
             </graceful-shutdown-timeout>
             ...
        </core>
   </configuration>

Procedure

1. Implement the appropriate interface and override its intercept() method.

   1. If you are using the AMQP protocol, implement the org.apache.activemq.artemis.protocol.amqp.broker.AmqpInterceptor interface.

      package com.example;
      
      import org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage;
      import org.apache.activemq.artemis.protocol.amqp.broker.AmqpInterceptor;
      import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection;
      
      public class MyInterceptor implements AmqpInterceptor
      {
        private final int ACCEPTABLE_SIZE = 1024;
      
        @Override
        public boolean intercept(final AMQPMessage message, RemotingConnection connection)
        {
          int size = message.getEncodeSize();
          if (size <= ACCEPTABLE_SIZE) {
            System.out.println("This AMQPMessage has an acceptable size.");
            return true;
          }
          return false;
        }
      }

   2. If you are using the Core protocol, your interceptor must implement the org.apache.artemis.activemq.api.core.Interceptor interface.

      package com.example;
      
      import org.apache.artemis.activemq.api.core.Interceptor;
      import org.apache.activemq.artemis.core.protocol.core.Packet;
      import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection;
      
      public class MyInterceptor implements Interceptor
      {
        private final int ACCEPTABLE_SIZE = 1024;
      
        @Override
        boolean intercept(Packet packet, RemotingConnection connection)
        throws ActiveMQException
        {
          int size = packet.getPacketSize();
          if (size <= ACCEPTABLE_SIZE) {
            System.out.println("This Packet has an acceptable size.");
            return true;
          }
          return false;
        }
      }

   3. If you are using the MQTT protocol, implement the org.apache.activemq.artemis.core.protocol.mqtt.MQTTInterceptor interface.

      package com.example;
      
      import org.apache.activemq.artemis.core.protocol.mqtt.MQTTInterceptor;
      import io.netty.handler.codec.mqtt.MqttMessage;
      import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection;
      
      public class MyInterceptor implements Interceptor
      {
        private final int ACCEPTABLE_SIZE = 1024;
      
        @Override
        boolean intercept(MqttMessage mqttMessage, RemotingConnection connection)
        throws ActiveMQException
        {
          byte[] msg = (mqttMessage.toString()).getBytes();
          int size = msg.length;
          if (size <= ACCEPTABLE_SIZE) {
            System.out.println("This MqttMessage has an acceptable size.");
            return true;
          }
          return false;
        }
      }

   4. If you are using the Stomp protocol, implement the org.apache.activemq.artemis.core.protocol.stomp.StompFrameInterceptor interface.

      package com.example;
      
      import org.apache.activemq.artemis.core.protocol.stomp.StompFrameInterceptor;
      import org.apache.activemq.artemis.core.protocol.stomp.StompFrame;
      import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection;
      
      public class MyInterceptor implements Interceptor
      {
        private final int ACCEPTABLE_SIZE = 1024;
      
        @Override
        boolean intercept(StompFrame stompFrame, RemotingConnection connection)
        throws ActiveMQException
        {
          int size = stompFrame.getEncodedSize();
          if (size <= ACCEPTABLE_SIZE) {
            System.out.println("This StompFrame has an acceptable size.");
            return true;
          }
          return false;
        }
      }

Procedure

1. Open <broker-instance-dir>/etc/broker.xml

2. Configure the broker to use an interceptor by adding configuration to _<broker-instance-dir>/etc/broker.xml

   1. If the interceptor is intended for incoming messages, add its class-name to the list of remoting-incoming-interceptors.

      <configuration>
        <core>
          ...
          <remoting-incoming-interceptors>
             <class-name>org.example.MyIncomingInterceptor</class-name>
          </remoting-incoming-interceptors>
          ...
        </core>
      </configuration>

   2. If the interceptor is intended for outgoing messages, add its class-name to the list of remoting-outgoing-interceptors.

      <configuration>
        <core>
          ...
          <remoting-outgoing-interceptors>
             <class-name>org.example.MyOutgoingInterceptor</class-name>
          </remoting-outgoing-interceptors>
        </core>
      </configuration>

Procedure

1. Open the <broker-instance-dir>/etc/broker.xml configuration file.

2. Set <jmx-management-enabled>.

   <jmx-management-enabled>true</jmx-management-enabled>

   If JMX is enabled, the broker can be managed locally using jconsole.

   Note

   Remote connections to JMX are not enabled by default for security reasons.

3. If you want to manage multiple brokers from the same MBeanServer, configure the JMX domain for each of the brokers.

   By default, the broker uses the JMX domain org.apache.activemq.artemis.

   <jmx-domain>my.org.apache.activemq</jmx-domain>

   Note

   If you are using AMQ Broker on a Windows system, system properties must be set in artemis, or artemis.cmd. A shell script is located under <install-dir>/bin.

Procedure

1. Open the <broker-instance-dir>/etc/broker.xml configuration file.

2. Add the <management-address> element, and specify a management address.

   By default, the management address is queue.activemq.management. You only need to specify a different address if you do not want to use the default.

   <management-address>my.management.address</management-address>

3. Provide the management address with the manage user permission type.

   This permission type enables the management address to receive and handle management messages.

   <security-setting-match="queue.activemq.management">
       <permission-type="manage" roles="admin"/>
   </security-setting>

Procedure

1. Create a QueueRequestor to send messages to the management address and receive replies.
2. Create a Message.
3. Use the helper class org.apache.activemq.artemis.api.jms.management.JMSManagementHelper to fill the message with the management properties.
4. Send the message using the QueueRequestor.
5. Use the helper class org.apache.activemq.artemis.api.jms.management.JMSManagementHelper to retrieve the operation result from the management reply.

Procedure

1. Open the <broker-instance-dir>/etc/broker.xml configuration file.

2. Enable message counters.

   <message-counter-enabled>true</message-counter-enabled>

3. Set the message counter history and sampling period.

   <message-counter-max-day-history>7</message-counter-max-day-history>
   <message-counter-sample-period>60000</message-counter-sample-period>

   message-counter-max-day-history

   The number of days the broker should store queue metrics. The default is 10 days.

   message-counter-sample-period

   How often (in milliseconds) the broker should sample its queues to collect metrics. The default is 10000 milliseconds (10 seconds).