Version 5.5
Copyright © 2012-2013 Red Hat, Inc. and/or its affiliates.
Updated: 27 Mar 2014
Table of Contents
List of Tables
List of Examples
Once a messaging solution is deployed it needs to be monitored to ensure it performs at peak performance. When problems do arise, many of them can be solved using the broker's administrative tools. The broker's administrative tools can also be used to provide important debugging information when troubleshooting problems.
Message brokers are long lived and usually form the backbone of the applications of which they are a part. Over the course of a broker's life span, there are a number of management tasks that you may need to do to keep the broker running at peak performance. This includes monitoring the health of the broker, adding destinations, and security certificates.
If applications run into trouble one of the first places to look for clues is the broker. The broker is unlikely to be the root cause of the problem, but its logs and metrics will provide clues as to what is the root cause. You may also be able to resolve the problem using the broker's administrative interface.
While Fuse Message Broker is designed to require a light touch for management, there are a few routine management tasks that need to be performed:
installing SSL certificates
starting the broker
creating destinations
stopping the broker
maintaining the advisory topics
monitoring the health of the broker
monitoring the health of the destinations
If an application runs into issues the broker will usually be able to provide clues to what is going wrong. Because the broker is central to the operation of any application that relies on messaging, it will be able to provide clues even if the broker is functioning properly. You may also be able to solve the problem by making adjustments to the broker's configuration.
Common things to check for clues as to the nature of a problem include:
the broker's log file
the advisory topics
the broker's overall memory footprint
the size of individual destination
the total number of messages in the broker
the size of the broker's persistent store
a thread dump of the broker
One or more of these items can provide information about the problem. For example, if a destination grows to a very large size it could indicate that one of its consumers is having trouble keeping up with the messages. If the broker's log also shows that the consumer is repeatedly connecting and disconnecting from the destination, that could indicate a networking problem or a problem with the machine hosting the consumer.
There are a number of tools that you can use to monitor and administer Fuse Message Broker.
The following tools are included with Fuse Message Broker:
administration tool—a command line tool that can be used to manage a broker and do rudimentary metric reporting
Web console—a browser based console that provides metric reporting, destination browsing, and other administrative functions
For more advanced monitoring and management capabilities FuseSource offers Fuse HQ.
In addition to the FuseSource supplied tools there are a number of third party tools that can be used to administer and monitor a broker including:
jconsole—a JMX tool that is shipped with the JDK
VisualVM—a visual tool integrating several command line JDK tools and lightweight profiling capabilities
Fuse Message Broker's administrative tool requires the shell's environment be set up properly. This involves setting a number of environment variables and can typically be accomplished by creating a simple shell script.
The administration tool requires that brokers have JMX enabled. By default, JMX is enabled. For more information see Using JMX.
The Windows Fuse Message Broker administrative tool uses four environment variables to determine where to locate configuration files, runtime libraries, and data files. In addition, it requires that your Java environment is properly set up.
Optionally, you may also want to add the administrative tool to the shell's path so that you can use the tool from anywhere.
Table 2.1 describes the environment variables used by the administration tool on Windows platforms.
Table 2.1. Windows Administration Tool Environment Variables
| Variable | Description |
|---|---|
ACTIVEMQ_HOME
| Specifies the directory where Fuse Message Broker is installed. |
ACTIVEMQ_BASE
| Specifies the directory containing files associated with the current broker
instance. Default value is the value of ACTIVEMQ_HOME. |
ACTIVEMQ_CLASSPATH
| Specifies the classpath used by the current broker instance. |
SSL_OPTS
| Specifies Java properties required to support SSL/TLS protocols. See Security Guide for details. |
You must set the JAVA_HOME environment variable to the location of the
Java installation you want to use for running Fuse Message Broker.
Example 2.1 shows a sample script for setting up the administration tool's environment.
Example 2.1. Sample Windows Environment Script
@echo off set ACTIVEMQ_HOME=ActiveMQInstallDirset ACTIVEMQ_BASE=BrokerInstanceDirset PATH=%PATH%;%ACTIVEMQ_HOME%\bin REM Configure Java set JAVA_HOME=JavaInstallDirset PATH=%JAVA_HOME%\bin;%PATH% set ACTIVEMQ_CLASSPATH=%ACTIVEMQ_HOME%\lib\optional\activemq-optional-5.5.1-fuse-00-xx.jar echo Setting Apache ActiveMQ 5.5 environment
This sample script sets JAVA_HOME as well as the Fuse Message Broker specific
environment variables. In addition, it adds the
activemq-optional-5.5.1-fuse-00-xx.jar JAR file to your Fuse Message Broker classpath
so that the optional feature of the broker are available.
The Fuse Message Broker administrative tool on Unix and Unix-like platforms uses a number of environment variables. The environment variables are used to configure the broker's runtime environment and configure the behavior of the administration tool. The tool can also call one or more start up scripts to effect its execution.
In addition, it requires that your Java environment is properly set up.
Optionally, you may also want to add the administrative tool to the shell's path so that you can use the tool from anywhere.
Table 2.2 describes the environment variables used by the administration tool on Unix and Unix-like platforms.
Table 2.2. Unix Administration Tool Environment Variables
| Variable | Description |
|---|---|
ACTIVEMQ_HOME
| Specifies the directory where Fuse Message Broker is installed. |
ACTIVEMQ_CLASSPATH
| Specifies the classpath used by the current broker instance. |
ACTIVEMQ_SSL_OPTS
| Specifies Java properties required to support SSL/TLS protocols. See Security Guide for details. |
ACTIVEMQ_CONFIG_DIR
| Specifies the location of the broker's configuration directory. Default is
$ACTIVEMQ_HOME/conf. |
ACTIVEMQ_DATA_DIR
| Specifies the location of the broker's data directory. Default is
$ACTIVEMQ_HOME/data. |
ACTIVEMQ_PIDFILE
| Specifies the location of the file that holds the broker's process ID(PID). |
ACTIVEMQ_USER
| Specifies the user as which the broker daemon runs. The user should be a user with non-root privileges. Default value is a blank string, which implies that the broker does not change user. |
ACTIVEMQ_OPTS_MEMORY
| Specifies the JVM memory configuration. Default value is
-Xms256M -Xmx256M. |
ACTIVEMQ_QUEUEMANAGERURL
| Specifies the default connection URL that is used with the
browse task. Default value is
--amqurl tcp://localhost:61616. |
ACTIVEMQ_KILL_MAXSECONDS
| Specifies how many seconds the stop task will wait for an
orderly shutdown to complete before killing the broker using
SIGKILL. |
The default setting for ACTIVEMQ_OPTS_MEMORY is very low for
systems that run under a heavy load. You will want to change this value to provide the
broker with more memory.
On Unix, the administration tool can find and source a startup script immediately before it executes the specified task. The startup script is a shell script, which is normally used to set some environment variables.
The administration tool looks for startup scripts in the following locations:
/etc/default/activemq
/home/User/.activemqrc
If both of these scripts exist, they will both be sourced by the administration tool, in the order shown.
Fuse Message Broker's Web console is an easy way to query the broker for JMX statistics, destination statuses, and information on any routes deployed in the broker.
The Fuse Message Broker Web console is an embedded console for administering your broker, its destination, and the routes deployed in the broker. Using the embedded console is an easy way to manage your broker with minimal configuration.
If you want more security, more reliability, or the ability to monitor master/slave clusters, you can deploy the Web console as a standalone application. It is easy to deploy into Tomcat or any standard Web container.
The Web console is loaded along with the broker and deployed into an embedded Jetty
container. By default, the console is insecure and accessed on port 8161.
The default configuration can easily be modified to add security and change the port number.
The Fuse Message Broker Web console has two main areas:
broker administration—http://hostName:portNum/admin
route administration—http://hostName:portNum/camel
For example, to access the default broker administration console on your local machine,
you would point your Web browser at http://localhost:8161/admin.
To change the port at which the embedded Web console is accessed, you need to edit the broker's configuration file to as follows:
Open the broker's configuration file in an XML, or text, editor.
The configuration file is typically called activemq.xml and
is located in the conf folder.
Determine if the configuration imports the Jetty configuration used by the Web consoles.
The default configuration includes an import element that
imports the Jetty configuration.
If the broker configuration imports the Jetty configuration, open the Jetty configuration file in your text editor.
If the Jetty configuration is included in the broker's configuration file, then you can locate the required configuration in the broker's configuration.
Locate the property element whose
name attribute is set to
connectors.
It will look similar to Example 3.1.
Example 3.1. Jetty Connector Configuration
... <property name="connectors"> <list> <bean id="Connector" class="org.eclipse.jetty.server.nio.SelectChannelConnector"> <property name="port" value="8161" /> </bean> </list> </property>
In the property element with the
name attribute set to
port, set the value attribute
to the number of port at which you want to access the Web console.
The configuration shown in Example 3.2 configures
the Web console such that the routing console can be accessed from
http://localhost:8563/camel.
Example 3.2. Configuring the Web Console's Port
... <property name="connectors"> <list> <bean id="Connector" class="org.eclipse.jetty.server.nio.SelectChannelConnector"> <property name="port" value="8536" /> </bean> </list> </property>
The security for the Web console is provided by the Web container in which it is
deployed. For the embedded instance of the Web console, you need to configure the
embedded Jetty container's security by editing conf/jetty.xml.
See Web Console Security in Security Guide for details.
For more security or reliability reasons you can deploy the Web console as a standalone application in Tomcat or another Web container. When running as a standalone application, the Web console can be set up to monitor Master/Slave clusters.
There is no need to disable the embedded console when using a standalone console. However, If you are using a standalone Web console, there is no reason to use the resources required by the embedded console. Nor is there a reason to leave an extra administrative access point open.
To disable the embedded Web console, you simply need to comment out, or remove, the
import element that imports the Jetty configuration into your
broker's configuration file as shown in
Example 3.3.
Example 3.3. Disabling the Embedded Web Console
<beans ... > <broker ... > ... </broker> <!-- <import resource="jetty.xml"/> --> </beans>
To deploy the Web console in Tomcat 5.x:
Download the Web console's WAR,
activemq-web-console-5.5.1-fuse-00-xx.war, from
http://repo.fusesource.com/nexus/content/groups/m2-release-proxy/org/apache/activemq/activemq-web-console/5.5.1-fuse-00-xx/.
Copy the Web console's WAR to the
folder.TOMCAT_HOME/webapps
Download activemq-all-5.5.1-fuse-00-xx.jar from
http://repo.fusesource.com/nexus/content/groups/m2-release-proxy/org/apache/activemq/activemq-all/5.5.1-fuse-00-xx/.
Copy activemq-all-5.5.1-fuse-00-xx.jar to the
folder.TOMCAT_HOME/common/lib
Modify
to
include the configuration in Example 3.4.TOMCAT_HOME/bin/catalina.sh(.bat)
Example 3.4. Configuration for Deploying the Web Console in Tomcat
JAVA_OPTS="-Dwebconsole.type=properties \ -Dwebconsole.jms.url=brokerURL\ -Dwebconsole.jmx.url=brokerJMXURL\ -Dwebconsole.jmx.user=JMXUserName\ -Dwebconsole.jmx.password=JMXPassword"
Restart Tomcat.
The Web console will be available at
.tomcatURI/activemq-web-console-5.5.1-fuse-00-xx
It's possible to configure the Web console to monitor a master/slave cluster. To do so:
Specify the JMS URL, webconsole.jms.url, with a failover:
URI specifying the brokers in the cluster.
Specify the JMX URL, webconsole.jmx.url as a comma separated list
that contains the JMX URL for each of the brokers in the cluster.
Example 3.5 shows the properties for monitoring a cluster using the Web console.
Example 3.5. Configuration for Monitoring a Cluster with the Web Console
-Dwebconsole.jms.url=failover:(tcp://serverA:61616,tcp://serverB:61616) -Dwebconsole.jmx.url=service:jmx:rmi:///jndi/rmi://serverA:1099/jmxrmi,service:jmx:rmi:///jndi/rmi://serverB:1099/jmxrmi
For more information about master/slave clusters see Master/Slave in Fault Tolerant Messaging.
Fuse Message Broker ships with wrapper that simplifies the process of installing it as a service on a machine running Windows.
Fuse Message Broker uses a wrapper, based on the Java service wrapper from Tanuki Software Ltd., that provides a solution to the problem of launching a Java application as a Windows service. The wrapper provides a mechanism for specifying all of the required JVM and application specific parameters to the Windows' service interface.
The wrapper is located in the bin/win32 folder
of a Windows Fuse Message Broker installation. This folder contains the following:
activemq.bat—script that starts the broker in the
foreground
InstallService.bat—script that installs the broker as a
Windows service
UninstallService.bat—script that uninstalls the broker
from the service registry
wrapper.conf—file that configures the wrapper service
wrapper.dll
wrapper.exe—wrapper service executable
FuseSource does support the 64 bit version of the service wrapper. However, due to licensing concerns, you must obtain it directly from Tanuki Software Ltd..
Before using the wrapper to install Fuse Message Broker as a Windows service, you will want to check the wrappers configuration to ensure it is set up properly.
The wrapper is configured by the wrapper.conf file, which is
located under the
directory.InstallDir/bin/win32/
A broker's environment is controlled by two environment variables:
ACTIVEMQ_HOME—the location of the Fuse Message Broker install
directory.
ACTIVEMQ_BASE—the root directory containing the configuration,
logging, and persistence data specific to the broker instance.
The configuration for the broker instance is stored in the
directory. The logging and persistence data is stored in the
ACTIVEMQ_BASE/conf
directory.ACTIVEMQ_BASE/data
It is likely that you will need to customize the values of the
ACTIVEMQ_HOME and ACTIVEMQ_BASE properties in the
wrapper.conf file. Example 4.1
shows the default values.
Example 4.1. Default Environment Settings
set.default.ACTIVEMQ_HOME=../.. set.default.ACTIVEMQ_BASE=../..
When specifying file and directory paths in wrapper.conf, the
forward slash, /, is used.
If you want to pass parameters to the JVM, you do so by setting wrapper properties using
the form wrapper.java.additional..
<n><n> is a sequence number that must be distinct for each
parameter.
One of the most useful things you can do by passing additional parameters to the JVM
is to set Java system properties. The syntax for setting a Java system property is
wrapper.java.additional..<n>=-DPropName=PropValue
Example 4.2 shows the default Java properties.
Example 4.2. Default Java System Properties
# Java Additional Parameters # note that n is the parameter number starting from 1. wrapper.java.additional.1=-Dactivemq.home="%ACTIVEMQ_HOME%" wrapper.java.additional.2=-Dactivemq.base="%ACTIVEMQ_BASE%" wrapper.java.additional.3=-Djavax.net.ssl.keyStorePassword=password wrapper.java.additional.4=-Djavax.net.ssl.trustStorePassword=password wrapper.java.additional.5=-Djavax.net.ssl.keyStore="%ACTIVEMQ_BASE%/conf/broker.ks" wrapper.java.additional.6=-Djavax.net.ssl.trustStore="%ACTIVEMQ_BASE%/conf/broker.ts" wrapper.java.additional.7=-Dcom.sun.management.jmxremote wrapper.java.additional.8=-Dorg.apache.activemq.UseDedicatedTaskRunner=true wrapper.java.additional.9=-Djava.util.logging.config.file=logging.properties
You specify application parameters using the syntax
wrapper.app.parameter..
<n><n> is a sequence number that must follow the
pattern:
1—specifies the name of the Java class executed by the
wrapper
>=2—specify properties passed to the application
Example 4.3 shows the default settings.
Example 4.3. Default Wrapper Application Settings
# Application parameters. Add parameters as needed starting from 1 wrapper.app.parameter.1=org.apache.activemq.console.Main wrapper.app.parameter.2=start
You add classpath entries using the syntax
wrapper.java.classpath..
<n><n> is a sequence number that must be distinct for each
classpath entry.
Example 4.4 shows the default classpath entries.
Example 4.4. Default Wrapper Classpath
# Java Classpath (include wrapper.jar) Add class path elements as # needed starting from 1 wrapper.java.classpath.1=%ACTIVEMQ_HOME%/bin/wrapper.jar wrapper.java.classpath.2=%ACTIVEMQ_HOME%/bin/run.jar
For a complete description of all the properties you can set in the
wrapper.conf configuration file, see
Configuration
Property Overview at the Tanuki Web site.
Fuse Message Broker provides the InstallService.bat and
UninstallService.bat scripts to install and uninstall the broker as a
Windows service.
After customizing the wrapper.conf configuration file as described
in Configuring the Wrapper, change directory to
, and
install the broker as a Windows service, using InstallDir\bin\win32InstallService.bat, as
follows:
C:\apache-activemq5.5.1-fuse-00-xx\bin\win32>InstallServicewrapper | ActiveMQ installed.
Once installed the Fuse Message Broker service will automatically start up when Windows is launched.
You can manually start the installed Fuse Message Broker service using the Windows net
start tool. The service is registered under the name
ActiveMQ.
You start the service as follows:
c:\>net start ActiveMQThe ActiveMQ service is starting......... The ActiveMQ service was started successfully.
You can manually stop the installed Fuse Message Broker service using the Windows net
stop tool. The service is registered under the name
ActiveMQ.
You stop the service as follows:
c:\>net stop ActiveMQThe ActiveMQ service is stopping... The ActiveMQ service was stopped successfully.
You can start a broker from the command line using either the administration tool or Maven. You specify the configuration for the started broker using a configuration URI.
There are three ways to pass configuration to a broker instance at start-up:
XBean URI—specifies the location a Spring XML configuration file
Broker URI—specifies the broker configuration as part of the URI
Properties URI—specifies the location of properties file containing Fuse Message Broker configuration
XBean configuration uses a Fuse Message Broker XML configuration file to configure the broker. You
pass the location of the configuration file to the administrative tool using a URI prefixed with
xbean:.
There are three ways to specify the location of the XML configuration file using an XBean URI:
on the Java classpath using the syntax xbean:fileName
For example the XBean URI xbean:activemq.xml specifies the file
activemq.xml that is located somewhere on the Java classpath.
on the file system using the syntax xbean:file:filePath
For example the XBean URI xbean:file:activemq.xml specifies the file
activemq.xml that is located in the current directory.
You can specify both relative and absolute paths to the file.
on a resource path using the syntax xbean:resourcePath
For more information on the Fuse Message Broker XML configuration see the XML Configuration Reference.
You can specify a broker's configuration entirely on the command line using a broker URI of the form shown in Example 5.1.
transportURI—a comma separated list of URIs at
which the broker listens for client connections
See Connectivity Guide for more information.
networkURI—a comma separated list of URIs at
which the broker listens for connections from other brokers
See Discovering Brokers in Using Networks of Brokers for more information.
brokerName—the broker's name
brokerOptions—an
ampersand(&) separated list configuration properties
See Table C.1 for a description of the properties.
For example, the URI shown in Example 5.2 starts up a
broker that accepts connections on port 61616, establishes a network connection to
remotehost:61616, and disables persistence.
Example 5.2. Broker URI
broker:(tcp://localhost:61616,network:static:tcp://remotehost:61616)?persistent=false&useJmx=true
Property configuration uses a Java properties file to configure the broker. You pass the
location of the configuration file to the administrative tool using a URI prefixed with
properties:. As with the XBean URI, you can specify a location on the classpath,
on the local file system, or using a resource path. For example the URI
properties:file:activemq.properties specifies the file
activemq.properties that is located in the current directory.
The properties file shown in Example 5.3 starts up a broker that accepts connections on port 61616, is named Cheese, and disables persistence and JMX.
See Appendix C for a description of all of the available properties.
On Windows the command to start a Fuse Message Broker broker is simple. It allows you to start a broker instance as a foreground process using the specified configuration.
The Unix start command provides more options. See Starting a Broker on Unix/Linux/OS X.
On Windows, the activemq tool to starts an instance of Fuse Message Broker in the foreground. The syntax for the command is shown in Example 5.4.
Example 5.4. Syntax for Starting a Broker on Windows
activemq {[xbean:file:confURI
[?validate=
{[true] | [false]}
]
] | [broker:brokerURI] | [properties:propURI]}
For a full description of the parameters see activemq.
For example, to start a broker using the default broker configuration, enter:
c:\fmq>activemq xbean:file:conf/activemq.xml
You can optionally disable schema validation of the configuration file using the
validate flag, as follows:
c:\fmq>activemq xbean:file:conf/activemq.xml?validate=false
On Windows the activemq command does not provide a mechanism for launching a broker instance as a background process. To start a broker in the background you can either:
install the broker instance as a Windows service. See Installing Fuse Message Broker as a Windows Service.
Use the Windows start command to spawn the broker in a new command window.
The command to start a broker on Unix and Unix-like platforms provides more flexibility than the Windows start-up command. On Unix, you can start a broker in either the foreground or in the background as a daemon process. In addition, the Unix start-up command can run pre-start scripts and associate an effective user to the broker process.
On Unix, the activemq start command to starts an instance of Fuse Message Broker in the background. The syntax for the command is shown in Example 5.5.
Example 5.5. Syntax for Starting a Daemon Broker on Unix
activemq start {[xbean:file:confURI
[?validate=
{[true] | [false]}
]
] | [broker:brokerURI] | [properties:propURI]}
For a full description of the parameters see activemq start.
For example, to start a daemon broker using the default broker configuration, enter:
%activemq start xbean:file:conf/activemq.xml
You can optionally disable schema validation of the configuration file using the
validate flag, as follows:
%activemq start xbean:file:conf/activemq.xml?validate=false
By default, the daemon broker runs as the current user. It is good practice to specify a special effective user for the broker. This special effective user should be given just enough privileges to run the broker. This provides added security by ensuring that the broker process has limited ability to corrupt sensitive part of your system.
The ACTIVEMQ_USER environment variable specifies the effective user for
the broker instances. By default, the broker will run as the currently logged in user. See
Setting up the Unix/Linux/OS X Environment.
On Unix, the activemq console command starts an instance of Fuse Message Broker as a foreground process. The syntax for the command is shown in Example 5.6.
Example 5.6. Syntax for Starting a Foreground Broker on Unix
activemq console {[xbean:file:confURI
[?validate=
{[true] | [false]}
]
] | [broker:brokerURI] | [properties:propURI]}
For a full description of the parameters see activemq console.
For example, you can start a broker in the foreground using the
default broker configuration, conf/activemq.xml, as follows:
%activemq console xbean:conf/activemq.xml
When developing messaging applications it can be helpful to have a test broker start up automatically when running the application. This can be accomplished using Fuse Message Broker's Apache Maven plug-in. The plug-in can be used directly from the command line or it can be included as part of a project's POM.
The Maven plug-in treats the broker as a part of the project's build and test
environment. Maven will download all of the Fuse Message Broker libraries from the configured Maven
repositories. The plug-in will store all of the broker's data in the project's
target folder.
Starting broker in a production environment from Maven is not recommended.
If a basic broker will suffice for testing an application, the Fuse Message Broker Maven plug-in can be loaded from the command line as shown in Example 5.7.
Example 5.7. Using the Maven Plug-in from the Command Line
mvn org.apache.activemq.tooling:maven-activemq-plugin:5.5.1-fuse-00-xx:runThis will create a broker that:
listens for client connections on tcp://localhost:61616
does not use JMX
does not persist messages
If the basic broker provided by adding the plug-in on the command line is insufficient for test an application the plug-in can be included in the project's POM. When included in a POM, the Fuse Message Broker plug-in uses a configuration URI to configure the broker. The plug-in can also set system properties when starting the broker.
Table 5.1 describes the configuration properties used by the Fuse Message Broker Maven plug-in.
Table 5.1. Maven Configuration Properties
| Property | Default | Description |
|---|---|---|
configUri
| broker:(tcp://localhost:61616)
?useJmx=false&persistent=false | Specifies the configuration URI used to configure the broker. See Specifying the Broker's Configuration for more information. |
fork
| false | Specifies whether the broker is started in a separate thread. Having the broker start in a separate thread can be useful for integration testing. |
systemProperties
| Specifies a collection of system properties that will be set. |
To start the configured broker when running the project use mvn activemq:run.
Example 5.8 shows a POM fragment that configures the
Fuse Message Broker plug-in to start a broker using the activemq.xml configuration
file on the project's class path.
Example 5.8. Using the Maven Plug-in from a POM
<project ... >
...
<repositories>
<!-- FuseSource maven repositories -->
<repository>
<id>fusesource.releases</id>
<name>FuseSoure releases repository</name>
<url>http://repo.fusesource.com/maven2/</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>fusesource.snapshots</id>
<name>FuseSource Snapshot Repository</name>
<url>http://repo.fusesource.com/maven2-snapshot</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
<releases>
<enabled>false</enabled>
</releases>
</repository>
</repositories>
<pluginRepositories>
<!-- FuseSource maven repositories -->
<pluginRepository>
<id>fusesource.releases</id>
<name>FuseSoure releases repository</name>
<url>http://repo.fusesource.com/maven2/</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>fusesource.snapshots</id>
<name>FuseSource Snapshot Repository</name>
<url>http://repo.fusesource.com/maven2-snapshot</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
<releases>
<enabled>false</enabled>
</releases>
</pluginRepository>
</pluginRepositories>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.activemq.tooling</groupId>
<artifactId>maven-activemq-plugin</artifactId>
<version>5.5</version>
<configuration>
<configUri>xbean:activemq.xml</configUri>
<fork>false</fork>
</configuration>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring</artifactId>
<version>2.5.5</version>
</dependency>
<dependency>
<groupId>org.mortbay.jetty</groupId>
<artifactId>jetty-xbean</artifactId>
<version>6.1.11</version>
</dependency>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-activemq</artifactId>
<version>1.1.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>The Fuse Message Broker's shutdown tool uses JMX to locate and gracefully shutdown brokers running as daemon processes.
The administration tool requires that brokers have JMX enabled. By default, JMX is enabled. For more information see Using JMX.
On Windows platforms brokers are run as either foreground processes or as system services. You can shutdown running brokers using operating system actions. For example, typing CTRL+C in a window in which a foreground broker is running will shutdown the broker. Closing the window will also shutdown a foreground broker.
However, if you want to properly shutdown a broker use the administration tool's stop task. It ensures that the broker is gracefully shutdown. It also allows you to shutdown brokers remotely.
On Windows, the command to shutdown a broker is activemq-admin stop. The syntax for the command is shown in Example 6.1.
Example 6.1. Syntax for Stopping a Broker on Windows
activemq-admin stop {[brokerName] | [--all]} [--jmxurl JMXUrl] [-jmxuser userName] [-jmxpassword password]
For a full description of the parameters see activemq-admin stop.
If you do not use the --jmxurl parameter, the default JMX url,
service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi, is used. This is the JMX url
specified in the default Fuse Message Broker configuration.
If you configured a broker to use a different JMX url, you must use the
--jmxurl parameter and provide the JMX url for connecting to
the broker.
If you have a broker running as a Windows service and have JMX turned on, you can use activemq-admin stop to shut it down. However, the recommended way to shut down a broker running as a Windows service is documented in Stopping the broker manually.
If you have secured JMX access to the broker, you will need to use the
-jmxuser and -jmxpassword parameters. They
specify the user name and password required to access the broker's JMX context. For
information about using security with JMX see
JMX Security in Security Guide.
The command shown in Example 6.2 shuts down a broker
named gatewayEast that is running in the default JMX context.
The command shown in Example 6.3 shuts down all of the brokers running in the default JMX context.
The command shown in Example 6.4 shuts down a broker
named gatewayEast that is running in the JMX context
service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi.
Example 6.4. Shutting Down a Broker on Windows in a Non-default JMX Context
c:\activemq-admin stop gatewayEast --jmxurl service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi
The administration tool's stop task uses JMX to locate and shutdown brokers on Unix and Unix-like platforms. This saves you from remembering a broker's PID each time it starts up.
The Unix stop task can also be configured to force a shutdown if an orderly shutdown hangs. It does this by waiting a predetermined amount of time and then killing the broker process.
On Unix and Unix-like systems, the command to shutdown a broker is activemq stop. The syntax for the command is shown in Example 6.5.
Example 6.5. Syntax for Stopping a Broker on Unix/Linux/OS X
activemq stop {[brokerName] | [--all]} [--jmxurl JMXUrl] [-jmxuser userName] [-jmxpassword password]
For a full description of the parameters see activemq stop.
If you do not use the --jmxurl parameter, the default JMX url,
service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi, is used. This is the JMX url
specified in the default Fuse Message Broker configuration.
If you configured a broker to use a different JMX url, you must use the
--jmxurl parameter and provide the JMX url for connecting to
the broker.
If you have secured JMX access to the broker, you will need to use the
-jmxuser and -jmxpassword parameters. They
specify the user name and password required to access the broker's JMX context. For
information about using security with JMX see
JMX Security in Security Guide.
When you execute the stop task, the administration tool initiates an
orderly shutdown of the broker (or brokers) by sending a shutdown request to the JMX port.
If the broker fails to shut down within a specified timeout, the administration tool sends
a SIGKILL signal to the broker process.
The duration of the kill timeout is set by the ACTIVEMQ_KILL_MAXSECONDS
environment variable. For more information about setting up your environment for the
administration tool see Setting up the Unix/Linux/OS X Environment.
The command shown in Example 6.6 shuts down a broker
named gatewayEast that is running in the default JMX context.
The command shown in Example 6.7 shuts down all of the brokers running in the default JMX context.
The command shown in Example 6.8 shuts down a broker
named gatewayEast that is running in the JMX context
service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi.
Example 6.8. Shutting Down a Broker in a Non-default JMX Context on Unix/Linux/OS X
>activemq stop gatewayEast --jmxurl service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi
Fuse Message Broker generates messages that advise the administrator of events that occur in the broker. These advisories are sent to special topics that you should monitor.
The broker's log contains information about all of the critical events that occur in the broker. You can configure the granularity of the logged messages to provide the level of detail that you require.
Fuse Message Broker is fully instrumented to provide statistics about its performance using JMX. You can monitor a broker using any JMX aware monitoring tool.
By default Fuse Message Broker creates MBeans, loads them into the MBean server created by the JVM, and creates a dedicated JMX connector that provides a Fuse Message Broker-specific view of the MBean server. The default settings are sufficient for simple deployments and make it easy to access the statistics and management operations provided by a broker. For more complex deployments you easily configure many aspects of how a broker configures itself for access through JMX. For example, you can change the JMX URI of the JMX connector created by the broker or force the broker to use the generic JMX connector created by the JVM.
By connecting a JMX aware management and monitoring tool to a broker's JMX connector, you can view detailed information about the broker. This information provides a good indication of broker health and potential problem areas. In addition to the collected statistics, Fuse Message Broker's JMX interface provides a number of operations that make it easy to manage a broker instance. These include stopping a broker, starting and stopping network connectors, and managing destinations.
By default a broker is set up to allow for JMX management. It uses the JVM's MBean
server and creates its own JMX connector at
service:jmx:rmi:///jndi/rmi://.
If the default configuration does not meet the needs of the deployment environment, the broker
provides configuration properties for customizing most aspects of its JMX behavior. For
instance, you can completely disable JMX for a broker. You can also force the broker to
create its own MBean server.hostname:1099/jmxrmi
By default JMX is enabled for a Fuse Message Broker broker. To disable JMX entirely you simply
set the broker element's useJmx
attribute to false. This will stop the broker from exposing itself
via JMX.
Disabling JMX will also disable the command-line administrative tools.
In a production environment it is advisable to secure the access to your brokers' management interfaces. The steps to secure access to a broker's JMX interface depends on the JMX connector the broker uses.
If the broker creates its own JMX connector you configure the security options directly in the broker's configuration. If the broker uses the JMX connector provided by the JVM, you need to modify the scripts used to start the broker to pass the security configuration to the JVM.
For a detailed description of the steps required see JMX Security in Security Guide.
If the default JMX behavior is not appropriate for your deployment environment, you can
customize how the broker exposes its MBeans. To customize a broker's JMX configuration, you
add a managementContext child element to the broker's
broker element. The managementContext
element uses a managementContext child to configure the broker.
The attributes of the inner managementContext element specify the
broker's JMX configuration.
Table 9.1 describes the configuration properties for controlling a broker's JMX behavior.
Table 9.1. Broker JMX Configuration Properties
Example 9.1 shows configuration for a broker that will only use the JVM's MBean server and will not create its own JMX connector.
Example 9.1. Configuring a Broker's JMX Connection
<broker ... > ... <managementContext> <managementContext createMBeanServer="false" createConnector="false" /> </managementContext> ... </broker>
Table 9.2 describes the statistics collected for a broker.
Table 9.2. Broker JMX Statistics
Table 9.3 describes the statistics collected for a destination.
Table 9.3. Destination JMX Statistics
Table 9.4 describes the statistics collected for a subscription.
Table 9.4. Connection JMX Statistics
The MBeans exposed by Fuse Message Broker provide a number of operations for monitoring and managing a broker instance. You can access these operations through any tool that supports JMX.
Table 9.5 describes the operations exposed by the MBean for a broker.
Table 9.5. Broker MBean Operations
Table 9.6 describes the operations exposed by the MBean for a transport connector.
Table 9.6. Connector MBean Operations
Table 9.7 describes the operations exposed by the MBean for a network connector.
Table 9.8 describes the operations exposed by the MBean for a queue destination.
Table 9.8. Queue MBean Operations
Table 9.9 describes the operations exposed by the MBean for a topic destination.
Table 9.9. Topic MBean Operations
Table 9.10 describes the operations exposed by the MBean for a durable subscription.
Table 9.10. Subscription MBean Operations
Fuse Message Broker is fully instrumented to provide statistics about its performance using JMX. You can monitor a broker using any JMX aware monitoring tool.
The administration tool requires that brokers have JMX enabled. By default, JMX is enabled. For more information see Using JMX.
activemq — starts a foreground broker on Windows
activemq [-Dname=value...] [--version] [[--help] | [-h] | [-?]] {[xbean:file:confURI
[?validate=
{[true] | [false]}
]
] | [broker:brokerURI] | [properties:propURI]}
| Argument | Description |
|---|---|
-Dname=value | Specifies a system property to be interpreted by the VM. |
| --version | Displays the version of the tool. |
| --help, -?, -h | Displays the help for the command. |
xbean:file:confURI | Specifies the path of the broker configuration file to use. |
broker:brokerURI | Specifies the broker URI to use. |
properties:propURI | Specifies the path to a properties file to configure the broker. |
activemq setup — creates default configurations for the activemq command on Unix, and Unix-like, platforms
activemq setup [-Dname=value...] [--version] [[--help] | [-h] | [-?]] {refFile}
activemq start — starts a daemon broker on Unix, and Unix-like, platforms
activemq start [-Dname=value...] [--version] [[--help] | [-h] | [-?]] {[xbean:file:confURI
[?validate=
{[true] | [false]}
]
] | [broker:brokerURI] | [properties:propURI]}
| Argument | Description |
|---|---|
-Dname=value | Specifies a system property to be interpreted by the VM. |
| --version | Displays the version of the tool. |
| --help, -?, -h | Displays the help for the command. |
xbean:file:confURI | Specifies the path of the broker configuration file to use. |
broker:brokerURI | Specifies the broker URI to use. |
properties:propURI | Specifies the path to a properties file to configure the broker. |
The following command starts a broker with the default configuration using an XBean URI:
%activemq start xbean:activemq.xml
The following command starts a broker using a broker URI:
%activemq start broker:(tcp://localhost:61616,network:static:tcp://remotehost:61616)?persistent=false&useJmx=true
activemq console — starts a foreground broker on Unix, and Unix-like, platforms
activemq console [-Dname=value...] [--version] [[--help] | [-h] | [-?]] {[xbean:file:confURI] | [broker:brokerURI] | [properties:propURI]}
| Argument | Description |
|---|---|
-Dname=value | Specifies a system property to be interpreted by the VM. |
| --version | Displays the version of the tool. |
| --help, -?, -h | Displays the help for the command. |
xbean:file:confURI | Specifies the path of the broker configuration file to use. |
broker:brokerURI | Specifies the broker URI to use. |
properties:propURI | Specifies the path to a properties file to configure the broker. |
The following command starts a broker with the default configuration using an XBean URI:
%activemq console xbean:activemq.xml
The following command starts a broker using a broker URI:
%activemq console broker:(tcp://localhost:61616,network:static:tcp://remotehost:61616)?persistent=false&useJmx=true
activemq restart — restarts a running broker on Unix, and Unix-like, platforms
activemq restart {[brokerName] | [--all] | [--jmxurl JMXUrl]} [-jmxuser userName] [-jmxpassword password] [-Dname=value...] [--version] [[--help] | [-h] | [-?]]
| Argument | Description |
|---|---|
brokerName | Specifies the name of the broker to be restarted. |
--all | Restart all brokers running in the default JMX context. |
--jmxurl | Sets the JMX URL to connect to. |
--jmxuser | Sets the JMX user, used for authentication. |
--jmxpassword | Sets the JMX password, used for authentication. |
-D | Sets a Java system property. For example, -Dactivemq.home=C:/ActiveMQ. |
--version
| Displays the version information. |
-h, -?, --help
| Displays the online help for this command. |
activemq status — checks the status of a running broker on Unix, and Unix-like, platforms
activemq status [-Dname=value...] [--version] [[--help] | [-h] | [-?]]
activemq stop — shuts down a running broker on Unix, and Unix-like, platforms
activemq stop {[brokerName] | [--all]} [--jmxurl JMXUrl] [-jmxuser userName] [-jmxpassword password] [-Dname=value...] [--version] [[--help] | [-h] | [-?]]
| Argument | Description |
|---|---|
brokerName | Specifies the name of the broker to be stopped. |
--all | Stop all brokers running in the default JMX context. |
--jmxurl | Sets the JMX URL used to locate the broker. |
--jmxuser | Sets the JMX user, used for authentication. |
--jmxpassword | Sets the JMX password, used for authentication. |
-D | Sets a Java system property. For example, -Dactivemq.home=C:/ActiveMQ. |
--version
| Displays the version information. |
-h, -?, --help
| Displays the online help for this command. |
activemq-admin start — creates and starts a broker using a configuration file or a broker URI
activemq-admin start [--version] [[--help] | [-h] | [-?]] {URI}
| Argument | Description |
|---|---|
| --version | Displays the version of the tool. |
| --help, -?, -h | Displays the help for the command. |
URI | Specifies the XBean URI of the configuration file to use or the full broker URI to use. |
The following command starts a broker using the activemq.xml
configuration file located on your classpath:
activemq-admin start xbean:activemq.xml
The following command starts a broker with one transport connector, one network connector and persistence disabled:
activemq-admin start broker:(tcp://localhost:61616, network:tcp://localhost:5000)?persistent=false
activemq-admin create — creates a new instance of the broker's file structure
activemq-admin create [--amqconf confFile] [--version] [[--help] | [-h] | [-?]] {brokerPath}
activemq-admin stop — shuts down a running broker
activemq-admin stop {[brokerName] | [--all]} [--jmxurl JMXUrl] [-jmxuser userName] [-jmxpassword password] [-Dname=value...] [--version] [[--help] | [-h] | [-?]]
| Argument | Description |
|---|---|
brokerName | Specifies the name of the broker to be stopped. |
--all | Stop all brokers running in the default JMX context. |
--jmxurl | Sets the JMX URL used to locate the broker. |
--jmxuser | Sets the JMX user, used for authentication. |
--jmxpassword | Sets the JMX password, used for authentication. |
-D | Sets a Java system property. For example,
-Dactivemq.home=C:/ActiveMQ. |
--version
| Displays the version information. |
-h, -?, --help
| Displays the online help for this command. |
activemq-admin list — lists the available brokers
activemq-admin list [--jmxurl JMXUrl] [-jmxuser userName] [-jmxpassword password] [-Dname=value...] [--version] [[--help] | [-h] | [-?]]
| Argument | Description |
|---|---|
--jmxurl | Sets the JMX URL used to locate the brokers. |
--jmxuser
| Sets the JMX user, used for authentication. |
--jmxpassword
| Sets the JMX password, used for authentication. |
-D | Sets a Java system property. For example,
-Dactivemq.home=C:/ActiveMQ. |
--version
| Displays the version information. |
-h, -?, --help
| Displays the online help for this command. |
activemq-admin query — queries the for broker information on specific objects
activemq-admin query [-QMBeanType=name] [-xQMBeanType=name] [--objname query] [--xobjname query] [--view {attr...}] [--jmxurl JMXUrl] [-jmxuser userName] [-jmxpassword password] [-Dname=value...] [--version] [[--help] | [-h] | [-?]]
| Argument | Description |
|---|---|
-Q | Adds to the search list the specific object type matched by the defined object identifier. |
-xQ
| Removes from the search list the specific object type matched by the object identifier. |
--objname
| Adds to the search list objects matched by the query similar. |
--xobjname
| Removes from the search list objects matched by the query. |
--view
| Selects the specific attribute of the object to view. By default, all attributes are displayed. |
--jmxurl
| Sets the JMX URL to connect to. |
--jmxuser
| Sets the JMX user, used for authentication. |
--jmxpassword
| Sets the JMX password, used for authentication. |
--jmxlocal
| Use the local JMX server instead of a remote server. |
-D | Sets a Java system property. For example,
-Dactivemq.home=C:/ActiveMQ. |
--version
| Displays the version information. |
-h, -?, --help
| Displays the online help for this command. |
The following command displays all attributes and object name information for all registered MBeans in the default JMX context:
%activemq-admin query
The following command displays all attributes and object name information of the
destination topic TEST.FOO:
%activemq-admin query -QTopic=TEST.FOO
The following command displays all the brokers in a context whose name ends in
host:
%activemq-admin query -QBroker=*host
the Following command displays all attributes and object name information for all registered queues:
%activemq-admin query -QQueue=*
The following command displays all attributes and object name information for all
topics ending with .FOO except those that also begin with
ActiveMQ.Advisory.:
%activemq-admin query -QTopic=*.FOO -xQTopic=ActiveMQ.Advisory.*
activemq-admin bstat — summarizes the statistics for a broker
activemq-admin bstat [--jmxurl JMXUrl] [-jmxuser userName] [-jmxpassword password] [-Dname=value...] [--version] [[--help] | [-h] | [-?]]
| Argument | Description |
|---|---|
--jmxurl
| Sets the JMX URL used to locate brokers. |
--jmxuser
| Sets the JMX user, used for authentication. |
--jmxpassword
| Sets the JMX password, used for authentication. |
--jmxlocal
| Use the local JMX server instead of a remote server. |
-D | Sets a Java system property. For example,
-Dactivemq.home=C:/ActiveMQ. |
--version
| Displays the version information. |
-h, -?, --help
| Displays the online help for this command. |
activemq-admin browse — browse the contents of a destination
activemq-admin browse {--amqurl brokerURL} [--msgsel {msgsel...}] [--view {attr...}] [[-Vheader] | [-Vcustom] | [-Vbody]] [--version] [[--help] | [-h] | [-?]] destName
| Argument | Description |
|---|---|
--amqurl
| Specifies the URL of the broker to which you are connecting. |
--msgsel | Displays messages matched by the message selector. See Message filters. |
-Vheader
| Shows all the standard JMS message headers. |
-Vcustom | Shows all the custom fields added to each JMS message. |
-Vbody | Shows the body of the message. |
--view
| Selects the specific attribute of the message to view. |
-D | Sets a Java system property. For example,
-Dactivemq.home=C:/ActiveMQ. |
--version | Displays the version information. |
-h, -?, --help | Displays the online help for this command. |
Message filters specified using the --msgsel option take the form
.
Table B.1 lists the headers you can use to filter
messages.header=value
Table B.1. Message Headers for Filtering
| Name | Type |
|---|---|
JMSCorrelationID | String |
JMSDeliveryMode | 1-Non-Persistent, 2-Persistent |
JMSDestination | javax.jms.Destination |
JMSExpiration | long |
JMSMessageID | String |
JMSPriority | int |
JMSRedelivered
| boolean |
JMSReplyTo | javax.jms.Destination |
JMSTimestamp | long |
JMSType | String |
The following command prints the JMS message header, custom message header, and message body of all the
messages in the queue TEST.FOO on a broker:
c:\>activemq-admin browse --amqurl tcp://localhost:61616 TEST.FOO
The following command displays the attributes from the body of the messages in the TEST.FOO queue:
c:\>activemq-admin browse --amqurl tcp://localhost:61616 -Vbody TEST.FOO
The following command displays any messages with an ID ending in 10:
c:\>activemq-admin browse --amqurl tcp://localhost:61616 --msgsel JMSMessaageID='*:10' TEST.FOO
The following command displays messages with a priority of 3, enter:
c:\>activemq-admin browse --amqurl tcp://localhost:61616 --msgsel JMSPriority=3 TEST.FOO
The message selectors from the preceding two examples can be combined as follows:
c:\>activemq-admin browse --amqurl tcp://localhost:61616 --msgsel JMSMessaageID='*:10',JMSPriority=3 TEST.FOO
activemq-admin journal-audit — audits the log files of the AMQ persistence store. It does not work with the KahaDB persistence store.
activemq-admin journal-audit [--message-format=VelocityTemplate] [--topic-ack-format=VelocityTemplate] [--queue-ack-format=VelocityTemplate] [--transaction-format=VelocityTemplate] [--trace-format=VelocityTemplate] [--where=JoSQLExp] [-Dname=value...] [--version] [[--help] | [-h] | [-?]] journalDir
| Argument | Description |
|---|---|
--message-format= | Specifies the Apache Velocity template used to format the displayed messages. |
--topic-ack-format=
| Specifies the Apache Velocity template used to display topic ack messages. |
--queue-ack-format=
| Specifies the Apache Velocity template used to display queue ack messages. |
--transaction-format= | Specifies the Apache Velocity template used to display transaction records. |
--trace-format=
| Specifies the Apache Velocity template used to display trace records. |
--where= | Select the records to display, using a SQL-like syntax implemented by JoSQL. |
-D | Sets a Java system property. For example,
-Dactivemq.home=C:/ActiveMQ. |
-h, -?, --help | Displays the online help for this command. |
The default Velocity expression for messages is:
${location.dataFileId},${location.offset}|${type}|${record.destination}|${record.messageId}|${record.properties}|${body}The default Velocity expression for topic acks is:
${location.dataFileId},${location.offset}|${type}|${record.destination}|${record.clientId}|${record.subscriptionName}|${record.messageId}The default Velocity expression for queue acks is:
${location.dataFileId},${location.offset}|${type}|${record.destination}|${record.messageAck.lastMessageId}The default Velocity expression for transaction records is:
${location.dataFileId},${location.offset}|${type}|${record.transactionId}The default Velocity expression for trace records is:
${location.dataFileId},${location.offset}|${type}|${record.message}activemq-admin purge — purges messages from a destination
activemq-admin purge [--jmxurl JMXUrl] [-jmxuser userName] [-jmxpassword password] [--msgsel {msgsel...}] [-Dname=value...] [--version] [[--help] | [-h] | [-?]] destName
| Argument | Description |
|---|---|
--jmxurl
| Sets the JMX URL used to locate the broker. |
--jmxuser
| Sets the JMX user, used for authentication. |
--jmxpassword
| Sets the JMX password, used for authentication. |
--msgsel | Purges messages matched by the message selector. See Message filters. |
-D | Sets a Java system property. For example,
-Dactivemq.home=C:/ActiveMQ. |
--version
| Displays the version information. |
-h, -?, --help
| Displays the online help for this command. |
The following command purges all the messages in the queue TEST.FOO on a broker:
c:\activemq-admin purge TEST.FOO
The following command purges any messages with an ID ending in 10:
c:\activemq-admin purge --msgsel JMSMessaageID='*:10' TEST.FOO
The following command purges messages with a priority of 3, enter:
c:\activemq-admin purge --msgsel JMSPriority=3 TEST.FOO
The message selectors from the preceding two examples can be combined as follows:
c:\activemq-admin purge --msgsel JMSMessaageID='*:10',JMSPriority=3 TEST.FOO
activemq-admin encrypt — encrypts the specified text
activemq-admin encrypt [--jmxurl JMXUrl] [-jmxuser userName] [-jmxpassword password] {--password password} {--input text} [--version] [[--help] | [-h] | [-?]]
| Argument | Description |
|---|---|
--jmxurl
| Sets the JMX URL used to locate the broker. |
--jmxuser
| Sets the JMX user, used for authentication. |
--jmxpassword
| Sets the JMX password, used for authentication. |
--password | Specifies the password used to encrypt the text. |
--input | Specifies the text to encrypt. |
--version
| Displays the version information. |
-h, -?, --help
| Displays the online help for this command. |
activemq-admin decrypt — decrypts an encrypted message
activemq-admin decrypt [--jmxurl JMXUrl] [-jmxuser userName] [-jmxpassword password] {--password password} {--input text} [--version] [[--help] | [-h] | [-?]]
| Argument | Description |
|---|---|
--jmxurl
| Sets the JMX URL used to locate the broker. |
--jmxuser
| Sets the JMX user, used for authentication. |
--jmxpassword
| Sets the JMX password, used for authentication. |
--password | Specifies the password used to encrypt the text. |
--input | Specifies the text to decrypt. |
--version
| Displays the version information. |
-h, -?, --help
| Displays the online help for this command. |
Table C.1 describes the broker properties you can set as options on a broker URI or in a broker properties file.
Table C.1. Broker URI Properties
Table C.2 describes additional properties that you can set in a broker properties file.
Table C.2. Property File Properties
| Property | Default | Description |
|---|---|---|
| transportConnectors | tcp:\\localhost:61616 | Specifies a comma separated list of transport URIs on which the broker will listen for client connections. See Connectivity Guide for more information. |
| networkConnectors | Specifies a comma separated list of URIs on which the broker will listen for connections with other brokers. See Using Networks of Brokers for more information. |