<div class="wiki-content maincontent"><p>We support an XML deployment descriptor for configuring the ActiveMQ Message Broker. There are many things which can be configured such as</p><ul><li><a shape="rect" href="configuring-version-5-transports.xml">transport connectors</a> which consist of transport channels and wire formats</li><li><a shape="rect" href="networks-of-brokers.xml">network connectors</a> using network channels or discovery agents</li><li><a shape="rect" href="persistence.xml">persistence providers</a> &amp; locations</li><li>custom message containers (such as last image caching etc)</li></ul><p>So we decided that using XML would make this configuration much easier. From version 4.0 onwards we use <a shape="rect" class="external-link" href="http://xbean.org/" rel="nofollow">XBean</a> to perform the XML configuration.</p><p>For details of the XML see the <a shape="rect" href="xml-reference.xml">Xml Reference</a></p><parameter ac:name="title">Be careful with broker names and URIs</parameter><rich-text-body><p>Make sure you do not use any strange characters in the names of brokers as they are converted to URIs which <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URI.html" rel="nofollow">do not allow things like underscores</a> in them etc.</p></rich-text-body><h2 id="XmlConfiguration-Examples">Examples</h2><p>The default ActiveMQ configuration: <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/activemq/trunk/assembly/src/release/conf/activemq.xml">current default config</a>.</p><parameter ac:name="">xml</parameter><plain-text-body>&lt;beans
  xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
  http://activemq.apache.org/schema/core http://activemq.apache.org/schema/core/activemq-core.xsd"&gt;
    &lt;!-- Allows us to use system properties as variables in this configuration file --&gt;
    &lt;bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"&gt;
        &lt;property name="locations"&gt;
            &lt;value&gt;file:${activemq.conf}/credentials.properties&lt;/value&gt;
        &lt;/property&gt;
    &lt;/bean&gt;
   &lt;!-- Allows accessing the server log --&gt;
    &lt;bean id="logQuery" class="io.fabric8.insight.log.log4j.Log4jLogQuery"
          lazy-init="false" scope="singleton"
          init-method="start" destroy-method="stop"&gt;
    &lt;/bean&gt;
    &lt;!--
        The &lt;broker&gt; element is used to configure the ActiveMQ broker.
    --&gt;
    &lt;broker xmlns="http://activemq.apache.org/schema/core" brokerName="localhost" dataDirectory="${activemq.data}"&gt;
        &lt;destinationPolicy&gt;
            &lt;policyMap&gt;
              &lt;policyEntries&gt;
                &lt;policyEntry topic="&gt;" &gt;
                    &lt;!-- The constantPendingMessageLimitStrategy is used to prevent
                         slow topic consumers to block producers and affect other consumers
                         by limiting the number of messages that are retained
                         For more information, see:
                         http://activemq.apache.org/slow-consumer-handling.html
                    --&gt;
                  &lt;pendingMessageLimitStrategy&gt;
                    &lt;constantPendingMessageLimitStrategy limit="1000"/&gt;
                  &lt;/pendingMessageLimitStrategy&gt;
                &lt;/policyEntry&gt;
              &lt;/policyEntries&gt;
            &lt;/policyMap&gt;
        &lt;/destinationPolicy&gt;

        &lt;!--
            The managementContext is used to configure how ActiveMQ is exposed in
            JMX. By default, ActiveMQ uses the MBean server that is started by
            the JVM. For more information, see:
            http://activemq.apache.org/jmx.html
        --&gt;
        &lt;managementContext&gt;
            &lt;managementContext createConnector="false"/&gt;
        &lt;/managementContext&gt;
        &lt;!--
            Configure message persistence for the broker. The default persistence
            mechanism is the KahaDB store (identified by the kahaDB tag).
            For more information, see:
            http://activemq.apache.org/persistence.html
        --&gt;
        &lt;persistenceAdapter&gt;
            &lt;kahaDB directory="${activemq.data}/kahadb"/&gt;
        &lt;/persistenceAdapter&gt;

          &lt;!--
            The systemUsage controls the maximum amount of space the broker will
            use before disabling caching and/or slowing down producers. For more information, see:
            http://activemq.apache.org/producer-flow-control.html
          --&gt;
          &lt;systemUsage&gt;
            &lt;systemUsage&gt;
                &lt;memoryUsage&gt;
                    &lt;memoryUsage percentOfJvmHeap="70" /&gt;
                &lt;/memoryUsage&gt;
                &lt;storeUsage&gt;
                    &lt;storeUsage limit="100 gb"/&gt;
                &lt;/storeUsage&gt;
                &lt;tempUsage&gt;
                    &lt;tempUsage limit="50 gb"/&gt;
                &lt;/tempUsage&gt;
            &lt;/systemUsage&gt;
        &lt;/systemUsage&gt;
        &lt;!--
            The transport connectors expose ActiveMQ over a given protocol to
            clients and other brokers. For more information, see:
            http://activemq.apache.org/configuring-transports.html
        --&gt;
        &lt;transportConnectors&gt;
            &lt;!-- DOS protection, limit concurrent connections to 1000 and frame size to 100MB --&gt;
            &lt;transportConnector name="openwire" uri="tcp://0.0.0.0:61616?maximumConnections=1000&amp;amp;wireFormat.maxFrameSize=104857600"/&gt;
            &lt;transportConnector name="amqp" uri="amqp://0.0.0.0:5672?maximumConnections=1000&amp;amp;wireFormat.maxFrameSize=104857600"/&gt;
            &lt;transportConnector name="stomp" uri="stomp://0.0.0.0:61613?maximumConnections=1000&amp;amp;wireFormat.maxFrameSize=104857600"/&gt;
            &lt;transportConnector name="mqtt" uri="mqtt://0.0.0.0:1883?maximumConnections=1000&amp;amp;wireFormat.maxFrameSize=104857600"/&gt;
            &lt;transportConnector name="ws" uri="ws://0.0.0.0:61614?maximumConnections=1000&amp;amp;wireFormat.maxFrameSize=104857600"/&gt;
        &lt;/transportConnectors&gt;
        &lt;!-- destroy the spring context on shutdown to stop jetty --&gt;
        &lt;shutdownHooks&gt;
            &lt;bean xmlns="http://www.springframework.org/schema/beans" class="org.apache.activemq.hooks.SpringContextHook" /&gt;
        &lt;/shutdownHooks&gt;
    &lt;/broker&gt;
    &lt;!--
        Enable web consoles, REST and Ajax APIs and demos
        The web consoles requires by default login, you can disable this in the jetty.xml file
        Take a look at ${ACTIVEMQ_HOME}/conf/jetty.xml for more details
    --&gt;
    &lt;import resource="jetty.xml"/&gt;
&lt;/beans&gt;</plain-text-body><p>From a binary distribution, from version 1.1 onwards there is an <em>activemq</em> script allowing you to run a Message Broker as a stand alone process from the command line easily providing the $ACTIVEMQ_HOME/bin directory is on your PATH.</p><p><strong>AMQ 4.x</strong></p><p>if myConfig.xml is in the classpath</p><plain-text-body>activemq  xbean:myConfig.xml
</plain-text-body><p>or to use the file path system</p><plain-text-body>activemq  xbean:file:../conf/myConfig.xml
</plain-text-body><p><strong>AMQ 3.x</strong></p><plain-text-body>activemq myConfig.xml
</plain-text-body><p>Or to use the default config file its just</p><plain-text-body>activemq
</plain-text-body><p>If you have a source distribution you can run a broker using Maven specifying one of these configuration files as follows<br clear="none"> under the assembly module run :</p><plain-text-body>maven server -Dconfig=xbean:file:src/release/conf/activemq.xml
</plain-text-body><p>If your <a shape="rect" href="initial-configuration.xml">classpath is set up correctly</a> you can achieve the same thing from the command line</p><plain-text-body>java org.apache.activemq.broker.Main  xbean:file:src/release/conf/activemq.xml
</plain-text-body><h2 id="XmlConfiguration-Configuringembeddedbrokers">Configuring embedded brokers</h2><p>You can also use the XML Configuration to configure <a shape="rect" href="how-do-i-embed-a-broker-inside-a-connection.xml">embedded brokers</a>. For example using the JNDI configuration mechanism you can do the following<br clear="none"> <a shape="rect" class="external-link" href="http://svn.apache.org/repos/asf/activemq/trunk/activemq-unit-tests/src/test/java/org/apache/activemq/config/BrokerXmlConfigFromJNDITest.java">BrokerXmlConfigFromJNDITest</a><br clear="none"> Or of you want to explicitly configure the embedded broker via Java code you can do the following<br clear="none"> <a shape="rect" class="external-link" href="https://svn.apache.org/repos/asf/activemq/trunk/assembly/src/test/java/org/apache/activemq/config/BrokerXmlConfigStartTest.java">BrokerXmlConfigStartTest</a></p><h2 id="XmlConfiguration-UserSubmittedConfigurations">User Submitted Configurations</h2><p>We have a page which allows users to submit details of their configurations.</p><ul><li><a shape="rect" href="user-submitted-configurations.xml">User Submitted Configurations</a></li></ul><h2 id="XmlConfiguration-Background">Background</h2><p>Since ActiveMQ has so many strategy pattern plugins for transports, wire formats, persistence and many other things, we wanted to leave the configuration format open so that you the developer can configure and extend ActiveMQ in any direction you wish.</p><p>So we use the <a shape="rect" class="external-link" href="http://www.springframework.org/docs/reference/beans.html#beans-basics" rel="nofollow">Spring XML</a> configuration file format, which allows any beans / POJOs to be wired together and configured. However often Spring's XML can be kinda verbose at times, so we have implemented an ActiveMQ extension to the Spring XML which knows about the common, standard ActiveMQ things you're likely to do (e.g. tags like connector, wireFormat, serverTransport, persistence) - but at any time you can fall back to the normal Spring way of doing things (with tags like bean, property etc).</p><p>To see documentation of the XML file we use or to get access to the XSD/DTD see the <a shape="rect" href="xml-reference.xml">Xml Reference</a></p></div>