Installation Guide
Red Hat JBoss A-MQ
Installing Red Hat JBoss A-MQ on a computer
Version 6.0
Copyright © 2013 Red Hat, Inc. and/or its affiliates.
13 Oct 2017
Abstract
It is easy to install Red Hat JBoss A-MQ and tailor the installation to a particular environment.
Chapter 1. Installation Prerequisites
Abstract
Before attempting to install and use Red Hat JBoss A-MQ, make sure your system meets the minimum requirements.
1.1. Supported Platforms
Red Hat JBoss A-MQ is tested and supported on the platforms listed at https://access.redhat.com/site/articles/310613.
1.2. Java Runtime
Fuse runtime platforms need Java 6, JRE 1.6.0_18 or later.
To develop applications for Fuse runtime platforms, you need Java 6, JDK 1.6.0_18 or later.
Non-Oracle Java distributions
Fuse products are only guaranteed to run with Java runtimes distributed by, or OEMed from, Red Hat (OpenJDK), Oracle and IBM.
Red Hat Linux
On Red Hat-derived Linux systems, gcj is the default Java distribution. In these cases, you must download and install an Oracle Java runtime and set the
JAVA_HOME environment variable. You can also integrate the Oracle Java runtime into the alternatives(1) system. See the alternatives(1) man page for details.
Warning
Do not install the Java runtime under a directory path that includes whitespace. For example, the path,
C:\Program Files\Java\jde7, is not an acceptable install path and will lead to unpredictable errors in Red Hat JBoss Fuse at run time.
1.3. Hardware requirements
The minimum hardware specifications to install Red Hat JBoss A-MQ are:
- 220MB of free disk space
- 2GB of RAM
In addition to the disk space required for the base installation, a running system will require space for caching, persistent message stores, and other functions.
Chapter 2. Installing
Abstract
Red Hat JBoss A-MQ is installed by unpacking an archive system on a system. This provides an easy way for a developer to get up and running.
Getting the archive
You can download the Red Hat JBoss A-MQ archive from the Customer Portal>Downloads>JBoss Enterprise Middleware>Downloads page. After logging in, go to the sidebar menu under JBoss Enterprise Platforms and select A-MQ. Click the Download button next to the product that you want to download.
Note
Trial kits are also available from the developer Web site, at http://jboss.org/products/amq. These kits are not supported by Red Hat.
Unpacking the archive
Red Hat JBoss A-MQ is packaged as a
.zip file Using a suitable archive tool, such as Zip or Gunzip, unpack Red Hat JBoss A-MQ into a directory to which you have full access.
Warning
Do not unpack the archive file into a folder that has spaces in its path name. For example, do not unpack into
C:\Documents and Settings\Greco Roman\Desktop\amq.
Chapter 3. Adding a Remote Console User
Abstract
The server's remote command console is not configured with a default user. Before you can connect to the server's console remotely, you must add a user to the configuration.
Red Hat JBoss A-MQ is not installed with a default user for the remote console. Before you can remotely manage a server, you must add a user by editing
InstallDir/etc/users.properties.
Important
The information in this file is unencrypted so it is not suitable for environments that require strict security.
To add a user:
- Open
InstallDir/etc/users.propertiesin your favorite text editor. - Locate the line
# admin=admin,admin.This line specifies a useradminwith the passwordadminand the roleadmin. - Uncomment the line by removing the leading
#. - Change the first
adminto the desired user name. - Change the
adminto the desired password. - Save the changes.
- If you intend to use the ActiveMQ Web console, you must specify the credentials for it. Open
InstallDir/etc/system.propertiesin your favorite text editor and search for the following lines:# # Authentication - must match an entry in user.properties with the admin privilege # #activemq.jmx.user=admin #activemq.jmx.password=admin
Uncomment theactivemq.jmx.userandactivemq.jmx.passwordsettings (by removing the leading#) and change the username and password values to be the same as the values you just defined in theetc/users.propertiesfile.
Chapter 4. Verifying the Installation
Abstract
Once the installer has completed running it is a good idea to run a simple test to ensure that Red Hat JBoss A-MQ was properly installed.
JBoss A-MQ ships with a simple client utility that can be used to verify that the software was successfully installed. You use it to create a message producer and a message consumer that connect to the broker. If they run successfully, and you see—by checking the Web console—that the broker processed the messages, then you can be confident that JBoss A-MQ was installed successfully.
To verify that JBoss A-MQ is properly installed:
- Log in as the user with ownership permissions for the JBoss A-MQ installation.
- Open a command shell at
InstallDir. - Start the broker using the start command.
Windows bin\start.bat Unix ./bin/start - Run the producer client using
java -jar extras/mq-client.jar producer --user admin --password admin.The producer will connect to the broker and produce 100 messages. Example 4.1, “Test Producer Output” shows the producer's output.Example 4.1. Test Producer Output
$java -jar extras/mq-client.jar producer --user admin --password adminUsing destination: queue://TEST, on broker: failover://tcp://localhost:61616 [org.apache.activemq.transport.failover.FailoverTransport] : Successfully connected to tcp://localhost:61616 [org.fusesource.mq.ProducerThread] : Sent 'test message: 0' [org.fusesource.mq.ProducerThread] : Sent 'test message: 1' [org.fusesource.mq.ProducerThread] : Sent 'test message: 2' [org.fusesource.mq.ProducerThread] : Sent 'test message: 3' [org.fusesource.mq.ProducerThread] : Sent 'test message: 4' ... [org.fusesource.mq.ProducerThread] : Sent 'test message: 99' [org.fusesource.mq.ProducerThread] : Producer thread finished Produced: 100$ - Run the consumer client using
java -jar extras/mq-client.jar consumer --user admin --password admin.The consumer will connect to the broker and consume 100 messages. Example 4.2, “Test Consumer Output” shows the consumer's output.Example 4.2. Test Consumer Output
$java -jar extras/mq-client.jar consumer --user admin --password adminUsing destination: queue://TEST, on broker: failover://tcp://localhost:61616 [org.apache.activemq.transport.failover.FailoverTransport] : Successfully connected to tcp://localhost:61616 Waiting for: 100 messages [org.fusesource.mq.ConsumerThread] : Received test message: 0 [org.fusesource.mq.ConsumerThread] : Received test message: 1 [org.fusesource.mq.ConsumerThread] : Received test message: 2 [org.fusesource.mq.ConsumerThread] : Received test message: 3 [org.fusesource.mq.ConsumerThread] : Received test message: 4 ... [org.fusesource.mq.ConsumerThread] : Received test message: 99 [org.fusesource.mq.ConsumerThread] : Consumer thread finished Consumed: 100 messages$
Chapter 5. Monitoring Fuse Resources
Abstract
Using Red Hat JBoss Operations Network (JON), you can discover, import, and monitor Red Hat JBoss A-MQ.
Important
The Fuse Plugin Pack for JBoss ON 3.1.2 is not installed with the JON base distribution. You must download and install it separately after you have installed JON.
To install the
Fuse Plugin Pack for JBoss ON 3.1.2:
- Navigate to the Red Hat Customer Portal>Downloads>JBoss Enterprise Middleware>Downloads page.
- In the sidebar menu, under JBoss Enterprise Platforms, select A-MQ.
- Click Download next to JON 3.1.2 Plugin Pack for JBoss A-MQ 6.0.0 .
- Unzip the plugin package (
JON-3.1.2-Fuse/jon-plugin-pack-fuse-3.1.2.GA.zip) in the/installDir/server/directory. - Install the jar files in one of two ways:
- Hot DeployCopy the unpacked jar files into the JBoss Operations Network's
/installDir/server/plugins/directory. For details, see the JBoss Operations Network Installation Guide. - JON Server UIFor details, see the JBoss Operations Network Installation Guide, or watch the video Installing JBoss Operations Network - Part 4, Installing JON Agent Plugins.
Appendix A. Installing Just Apache ActiveMQ
Abstract
Red Hat JBoss A-MQ includes a standard distribution of Apache ActiveMQ in the installation's
extras directory.
If you simply want to use a standard distribution of Apache ActiveMQ you can use the archived version in the installation's
extras directory.
The following archive files are provided:
Apache ActiveMQapache-activemq-5.8.0.redhat-60024.zip
You can copy the file to the desired location and decompress it using the appropriate utility for your platform.
Warning
Do not unpack the archive file into a folder that has spaces in its path name. For example, do not unpack into
C:\Documents and Settings\Greco Roman\Desktop\fusesrc.
Legal Notice
Trademark Disclaimer
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Apache, ServiceMix, Camel, CXF, and ActiveMQ are trademarks of Apache Software Foundation. Any other names contained herein may be trademarks of their respective owners.
Legal Notice
Third Party Acknowledgements
One or more products in the Red Hat JBoss A-MQ release includes third party components covered by licenses that require that the following documentation notices be provided:
- JLine (http://jline.sourceforge.net) jline:jline:jar:1.0License: BSD (LICENSE.txt) - Copyright (c) 2002-2006, Marc Prud'hommeaux
mwp1@cornell.eduAll rights reserved.Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of JLine nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - Stax2 API (http://woodstox.codehaus.org/StAX2) org.codehaus.woodstox:stax2-api:jar:3.1.1License: The BSD License (http://www.opensource.org/licenses/bsd-license.php)Copyright (c) <YEAR>, <OWNER> All rights reserved.Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - jibx-run - JiBX runtime (http://www.jibx.org/main-reactor/jibx-run) org.jibx:jibx-run:bundle:1.2.3License: BSD (http://jibx.sourceforge.net/jibx-license.html) Copyright (c) 2003-2010, Dennis M. Sosnoski.All rights reserved.Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - JavaAssist (http://www.jboss.org/javassist) org.jboss.javassist:com.springsource.javassist:jar:3.9.0.GA:compileLicense: MPL (http://www.mozilla.org/MPL/MPL-1.1.html)
- HAPI-OSGI-Base Module (http://hl7api.sourceforge.net/hapi-osgi-base/) ca.uhn.hapi:hapi-osgi-base:bundle:1.2License: Mozilla Public License 1.1 (http://www.mozilla.org/MPL/MPL-1.1.txt)
