content/releases/qpid-broker-j-7.1.9/book/Java-Broker-Initial-Configuration.html - qpid-site - Git at Google

 <!DOCTYPE html>
 <!--
  -
  - Licensed to the Apache Software Foundation (ASF) under one
  - or more contributor license agreements.  See the NOTICE file
  - distributed with this work for additional information
  - regarding copyright ownership.  The ASF licenses this file
  - to you under the Apache License, Version 2.0 (the
  - "License"); you may not use this file except in compliance
  - with the License.  You may obtain a copy of the License at
  -
  -   http://www.apache.org/licenses/LICENSE-2.0
  -
  - Unless required by applicable law or agreed to in writing,
  - software distributed under the License is distributed on an
  - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  - KIND, either express or implied.  See the License for the
  - specific language governing permissions and limitations
  - under the License.
  -
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   <head>
     <title>Chapter&#160;5.&#160;Initial Configuration - Apache Qpid&#8482;</title>
     <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
     <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
     <link rel="stylesheet" href="/site.css" type="text/css" async="async"/>
     <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/>
     <script type="text/javascript">var _deferredFunctions = [];</script>
     <script type="text/javascript" src="/deferred.js" defer="defer"></script>
     <!--[if lte IE 8]>
       <link rel="stylesheet" href="/ie.css" type="text/css"/>
       <script type="text/javascript" src="/html5shiv.js"></script>
     <![endif]-->

     <!-- Redirects for `go get` and godoc.org -->
     <meta name="go-import"
           content="qpid.apache.org git https://gitbox.apache.org/repos/asf/qpid-proton.git"/>
     <meta name="go-source"
           content="qpid.apache.org
 https://github.com/apache/qpid-proton/blob/go1/README.md
 https://github.com/apache/qpid-proton/tree/go1{/dir}
 https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/>
   </head>
   <body>
     <div id="-content">
       <div id="-top" class="panel">
         <a id="-menu-link"><img width="16" height="16" src="" alt="Menu"/></a>

         <a id="-search-link"><img width="22" height="16" src="" alt="Search"/></a>

         <ul id="-global-navigation">
           <li><a id="-logotype" href="/index.html">Apache Qpid<sup>&#8482;</sup></a></li>
           <li><a href="/documentation.html">Documentation</a></li>
           <li><a href="/download.html">Download</a></li>
           <li><a href="/discussion.html">Discussion</a></li>
         </ul>
       </div>

       <div id="-menu" class="panel" style="display: none;">
         <div class="flex">
           <section>
             <h3>Project</h3>

             <ul>
               <li><a href="/overview.html">Overview</a></li>
               <li><a href="/components/index.html">Components</a></li>
               <li><a href="/releases/index.html">Releases</a></li>
             </ul>
           </section>

           <section>
             <h3>Messaging APIs</h3>

             <ul>
               <li><a href="/proton/index.html">Qpid Proton</a></li>
               <li><a href="/components/jms/index.html">Qpid JMS</a></li>
               <li><a href="/components/messaging-api/index.html">Qpid Messaging API</a></li>
             </ul>
           </section>

           <section>
             <h3>Servers and tools</h3>

             <ul>
               <li><a href="/components/broker-j/index.html">Broker-J</a></li>
               <li><a href="/components/cpp-broker/index.html">C++ broker</a></li>
               <li><a href="/components/dispatch-router/index.html">Dispatch router</a></li>
             </ul>
           </section>

           <section>
             <h3>Resources</h3>

             <ul>
               <li><a href="/dashboard.html">Dashboard</a></li>
               <li><a href="https://cwiki.apache.org/confluence/display/qpid/Index">Wiki</a></li>
               <li><a href="/resources.html">More resources</a></li>
             </ul>
           </section>
         </div>
       </div>

       <div id="-search" class="panel" style="display: none;">
         <form action="http://www.google.com/search" method="get">
           <input type="hidden" name="sitesearch" value="qpid.apache.org"/>
           <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/>
           <button type="submit">Search</button>
           <a href="/search.html">More ways to search</a>
         </form>
       </div>

       <div id="-middle" class="panel">
         <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-broker-j-7.1.9/index.html">Qpid Broker-J 7.1.9</a></li><li><a href="/releases/qpid-broker-j-7.1.9/book/index.html">Apache Qpid Broker-J</a></li><li>Chapter&#160;5.&#160;Initial Configuration</li></ul>

         <div id="-middle-content">
           <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter&#160;5.&#160;Initial Configuration</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Concepts-Other-Services.html">Prev</a>&#160;</td><th align="center" width="60%">&#160;</th><td align="right" width="20%">&#160;<a accesskey="n" href="Java-Broker-Initial-Configuration-Location.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Initial-Configuration"></a>Chapter&#160;5.&#160;Initial Configuration</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="Java-Broker-Initial-Configuration.html#Java-Broker-Initial-Configuration-Introduction">5.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Location.html">5.2. Configuration Store Location</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Initial-Config-Location.html">5.3. 'Initial Configuration' Location</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Create-Initial-Config.html">5.4. Creating an 'Initial Configuration' JSON File</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Type.html">5.5. Configuration Store Type</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Configuration-Properties.html">5.6. Customising Configuration using Configuration Properties</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Example.html">5.7. Example of JSON 'Initial Configuration'</a></span></dt><dt><span class="section"><a href="Java-Broker-Virtual-Host-Initial-Configuration.html">5.8. Virtualhost Initial Configuration</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Initial-Configuration-Introduction"></a>5.1.&#160;Introduction</h2></div></div></div><p>This section describes how to perform initial configuration on the command line. Once
             the Broker is started, subsequent management is performed using the <a class="link" href="Java-Broker-Management-Channel.html" title="Chapter&#160;6.&#160;Management Channels">Management interfaces</a></p><p> The configuration for each component is stored as an entry in the broker
             configuration store, currently implemented as a JSON file which persists changes to
             disk, BDB or Derby database or an in-memory store which does not. The following
             components configuration is stored there: </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Broker</p></li><li class="listitem"><p>Virtual Host Nodes</p></li><li class="listitem"><p>Loggers</p></li><li class="listitem"><p>Ports</p></li><li class="listitem"><p>Authentication Providers (optionally with Users for managing users Authentication Providers)</p></li><li class="listitem"><p>Access Control Providers</p></li><li class="listitem"><p>Group Providers (optionally with Groups and GroupMembers for managing groups Group Providers)</p></li><li class="listitem"><p>Key stores</p></li><li class="listitem"><p>Trust stores</p></li><li class="listitem"><p>Plugins</p></li></ul></div><p>
         </p><p>Broker startup involves two configuration related items, the 'Initial Configuration'
             and the Configuration Store. When the broker is started, if a Configuration Store does
             not exist at the current <a class="link" href="Java-Broker-Initial-Configuration-Location.html" title="5.2.&#160;Configuration Store Location">store location</a> then one will be initialised with the current <a class="link" href="Java-Broker-Initial-Configuration-Initial-Config-Location.html" title="5.3.&#160;'Initial Configuration' Location">'Initial
                 Configuration'</a>. Subsequent broker restarts will use the existing configuration
             store and ignore the contents of the 'Initial Configuration'. </p></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Concepts-Other-Services.html">Prev</a>&#160;</td><td align="center" width="20%">&#160;</td><td align="right" width="40%">&#160;<a accesskey="n" href="Java-Broker-Initial-Configuration-Location.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">4.10.&#160;Other Services&#160;</td><td align="center" width="20%"><a accesskey="h" href="Apache-Qpid-Broker-J-Book.html">Home</a></td><td align="right" valign="top" width="40%">&#160;5.2.&#160;Configuration Store Location</td></tr></table></div></div>

           <hr/>

           <ul id="-apache-navigation">
             <li><a href="http://www.apache.org/">Apache</a></li>
             <li><a href="http://www.apache.org/licenses/">License</a></li>
             <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
             <li><a href="http://www.apache.org/foundation/thanks.html">Thanks!</a></li>
             <li><a href="/security.html">Security</a></li>
             <li><a href="http://www.apache.org/"><img id="-apache-feather" width="48" height="14" src="" alt="Apache"/></a></li>
           </ul>

           <p id="-legal">
             Apache Qpid, Messaging built on AMQP; Copyright &#169; 2015
             The Apache Software Foundation; Licensed under
             the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache
             License, Version 2.0</a>; Apache Qpid, Qpid, Qpid Proton,
             Proton, Apache, the Apache feather logo, and the Apache Qpid
             project logo are trademarks of The Apache Software
             Foundation; All other marks mentioned may be trademarks or
             registered trademarks of their respective owners
           </p>
         </div>
       </div>
     </div>
   </body>
 </html>
	<!DOCTYPE html>
	<!--
	-
	- Licensed to the Apache Software Foundation (ASF) under one
	- or more contributor license agreements. See the NOTICE file
	- distributed with this work for additional information
	- regarding copyright ownership. The ASF licenses this file
	- to you under the Apache License, Version 2.0 (the
	- "License"); you may not use this file except in compliance
	- with the License. You may obtain a copy of the License at
	-
	- http://www.apache.org/licenses/LICENSE-2.0
	-
	- Unless required by applicable law or agreed to in writing,
	- software distributed under the License is distributed on an
	- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	- KIND, either express or implied. See the License for the
	- specific language governing permissions and limitations
	- under the License.
	-
	-->
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
	<head>
	<title>Chapter 5. Initial Configuration - Apache Qpid™</title>
	<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
	<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
	<link rel="stylesheet" href="/site.css" type="text/css" async="async"/>
	<link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/>
	<script type="text/javascript">var _deferredFunctions = [];</script>
	<script type="text/javascript" src="/deferred.js" defer="defer"></script>
	<!--[if lte IE 8]>
	<link rel="stylesheet" href="/ie.css" type="text/css"/>
	<script type="text/javascript" src="/html5shiv.js"></script>
	<![endif]-->

	<!-- Redirects for `go get` and godoc.org -->
	<meta name="go-import"
	content="qpid.apache.org git https://gitbox.apache.org/repos/asf/qpid-proton.git"/>
	<meta name="go-source"
	content="qpid.apache.org
	https://github.com/apache/qpid-proton/blob/go1/README.md
	https://github.com/apache/qpid-proton/tree/go1{/dir}
	https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/>
	</head>
	<body>
	<div id="-content">
	<div id="-top" class="panel">
	<a id="-menu-link"><img width="16" height="16" src="" alt="Menu"/></a>

	<a id="-search-link"><img width="22" height="16" src="" alt="Search"/></a>

	<ul id="-global-navigation">
	<li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li>
	<li><a href="/documentation.html">Documentation</a></li>
	<li><a href="/download.html">Download</a></li>
	<li><a href="/discussion.html">Discussion</a></li>
	</ul>
	</div>

	<div id="-menu" class="panel" style="display: none;">
	<div class="flex">
	<section>
	<h3>Project</h3>

	<ul>
	<li><a href="/overview.html">Overview</a></li>
	<li><a href="/components/index.html">Components</a></li>
	<li><a href="/releases/index.html">Releases</a></li>
	</ul>
	</section>

	<section>
	<h3>Messaging APIs</h3>

	<ul>
	<li><a href="/proton/index.html">Qpid Proton</a></li>
	<li><a href="/components/jms/index.html">Qpid JMS</a></li>
	<li><a href="/components/messaging-api/index.html">Qpid Messaging API</a></li>
	</ul>
	</section>

	<section>
	<h3>Servers and tools</h3>

	<ul>
	<li><a href="/components/broker-j/index.html">Broker-J</a></li>
	<li><a href="/components/cpp-broker/index.html">C++ broker</a></li>
	<li><a href="/components/dispatch-router/index.html">Dispatch router</a></li>
	</ul>
	</section>

	<section>
	<h3>Resources</h3>

	<ul>
	<li><a href="/dashboard.html">Dashboard</a></li>
	<li><a href="https://cwiki.apache.org/confluence/display/qpid/Index">Wiki</a></li>
	<li><a href="/resources.html">More resources</a></li>
	</ul>
	</section>
	</div>
	</div>

	<div id="-search" class="panel" style="display: none;">
	<form action="http://www.google.com/search" method="get">
	<input type="hidden" name="sitesearch" value="qpid.apache.org"/>
	<input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/>
	<button type="submit">Search</button>
	<a href="/search.html">More ways to search</a>
	</form>
	</div>

	<div id="-middle" class="panel">
	<ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-broker-j-7.1.9/index.html">Qpid Broker-J 7.1.9</a></li><li><a href="/releases/qpid-broker-j-7.1.9/book/index.html">Apache Qpid Broker-J</a></li><li>Chapter 5. Initial Configuration</li></ul>

	<div id="-middle-content">
	<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 5. Initial Configuration</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Concepts-Other-Services.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Initial-Configuration-Location.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Initial-Configuration"></a>Chapter 5. Initial Configuration</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="Java-Broker-Initial-Configuration.html#Java-Broker-Initial-Configuration-Introduction">5.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Location.html">5.2. Configuration Store Location</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Initial-Config-Location.html">5.3. 'Initial Configuration' Location</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Create-Initial-Config.html">5.4. Creating an 'Initial Configuration' JSON File</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Type.html">5.5. Configuration Store Type</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Configuration-Properties.html">5.6. Customising Configuration using Configuration Properties</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Example.html">5.7. Example of JSON 'Initial Configuration'</a></span></dt><dt><span class="section"><a href="Java-Broker-Virtual-Host-Initial-Configuration.html">5.8. Virtualhost Initial Configuration</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Initial-Configuration-Introduction"></a>5.1. Introduction</h2></div></div></div><p>This section describes how to perform initial configuration on the command line. Once
	the Broker is started, subsequent management is performed using the <a class="link" href="Java-Broker-Management-Channel.html" title="Chapter 6. Management Channels">Management interfaces</a></p><p> The configuration for each component is stored as an entry in the broker
	configuration store, currently implemented as a JSON file which persists changes to
	disk, BDB or Derby database or an in-memory store which does not. The following
	components configuration is stored there: </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Broker</p></li><li class="listitem"><p>Virtual Host Nodes</p></li><li class="listitem"><p>Loggers</p></li><li class="listitem"><p>Ports</p></li><li class="listitem"><p>Authentication Providers (optionally with Users for managing users Authentication Providers)</p></li><li class="listitem"><p>Access Control Providers</p></li><li class="listitem"><p>Group Providers (optionally with Groups and GroupMembers for managing groups Group Providers)</p></li><li class="listitem"><p>Key stores</p></li><li class="listitem"><p>Trust stores</p></li><li class="listitem"><p>Plugins</p></li></ul></div><p>
	</p><p>Broker startup involves two configuration related items, the 'Initial Configuration'
	and the Configuration Store. When the broker is started, if a Configuration Store does
	not exist at the current <a class="link" href="Java-Broker-Initial-Configuration-Location.html" title="5.2. Configuration Store Location">store location</a> then one will be initialised with the current <a class="link" href="Java-Broker-Initial-Configuration-Initial-Config-Location.html" title="5.3. 'Initial Configuration' Location">'Initial
	Configuration'</a>. Subsequent broker restarts will use the existing configuration
	store and ignore the contents of the 'Initial Configuration'. </p></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Concepts-Other-Services.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Initial-Configuration-Location.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">4.10. Other Services </td><td align="center" width="20%"><a accesskey="h" href="Apache-Qpid-Broker-J-Book.html">Home</a></td><td align="right" valign="top" width="40%"> 5.2. Configuration Store Location</td></tr></table></div></div>

	<hr/>

	<ul id="-apache-navigation">
	<li><a href="http://www.apache.org/">Apache</a></li>
	<li><a href="http://www.apache.org/licenses/">License</a></li>
	<li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
	<li><a href="http://www.apache.org/foundation/thanks.html">Thanks!</a></li>
	<li><a href="/security.html">Security</a></li>
	<li><a href="http://www.apache.org/"><img id="-apache-feather" width="48" height="14" src="" alt="Apache"/></a></li>
	</ul>

	<p id="-legal">
	Apache Qpid, Messaging built on AMQP; Copyright © 2015
	The Apache Software Foundation; Licensed under
	the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache
	License, Version 2.0</a>; Apache Qpid, Qpid, Qpid Proton,
	Proton, Apache, the Apache feather logo, and the Apache Qpid
	project logo are trademarks of The Apache Software
	Foundation; All other marks mentioned may be trademarks or
	registered trademarks of their respective owners
	</p>
	</div>
	</div>
	</div>
	</body>
	</html>