content/releases/qpid-broker-j-9.2.1/book/Java-Broker-Initial-Configuration-Create-Initial-Config.html (118 lines of code) (raw):

<!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> <meta charset="UTF-8"> <title>5.4. Creating an 'Initial Configuration' JSON File - 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-9.2.1/index.html">Qpid Broker-J 9.2.1</a></li><li><a href="/releases/qpid-broker-j-9.2.1/book/index.html">Apache Qpid Broker-J</a></li><li>5.4. Creating an 'Initial Configuration' JSON File</li></ul> <div id="-middle-content"> <div class="docbook"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">5.4. Creating an 'Initial Configuration' JSON File</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="Java-Broker-Initial-Configuration-Initial-Config-Location.html">Prev</a> </td><th width="60%" align="center">Chapter 5. Initial Configuration</th><td width="20%" align="right"> <a accesskey="n" href="Java-Broker-Initial-Configuration-Type.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Initial-Configuration-Create-Initial-Config"></a>5.4. Creating an 'Initial Configuration' JSON File</h2></div></div></div><p> It is possible to have the broker output its default internal 'Initial Configuration' file to disk using the command line argument <span class="emphasis"><em>-cic</em></span> (or <span class="emphasis"><em>--create-initial-config</em></span>). If the option is used without providing a path, a file called <span class="emphasis"><em>initial-config.json</em></span> will be created in the current directory, or alternatively the file can be created at a specified location: </p><pre class="screen"> $ ./qpid-server -cic ./initial-config.json </pre><p> The 'Initial Configuration' JSON file shares a common format with the brokers JSON Configuration Store implementation, so it is possible to use a Broker's Configuration Store output as an initial configuration. Typically 'Initial Configuration' files would not to contain IDs for the configured entities, so that IDs will be generated when the configuration store is initialised and prevent use of the same IDs across multiple brokers, however it may prove useful to include IDs if using the Memory <a class="link" href="Java-Broker-Initial-Configuration-Type.html" title="5.5. Configuration Store Type">Configuration Store Type</a>. </p><p> It can be useful to use <a class="link" href="Java-Broker-Initial-Configuration-Configuration-Properties.html" title="5.6. Customising Configuration using Configuration Properties">Configuration Properties</a> within 'Initial Configuration' files to allow a degree of customisation with an otherwise fixed file. </p><p> For an example file, see <a class="xref" href="Java-Broker-Initial-Configuration-Example.html" title="5.7. Example of JSON 'Initial Configuration'">Section 5.7, “Example of JSON 'Initial Configuration'”</a> </p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="Java-Broker-Initial-Configuration-Initial-Config-Location.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="Java-Broker-Initial-Configuration.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="Java-Broker-Initial-Configuration-Type.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">5.3. 'Initial Configuration' Location </td><td width="20%" align="center"><a accesskey="h" href="Apache-Qpid-Broker-J-Book.html">Home</a></td><td width="40%" align="right" valign="top"> 5.5. Configuration Store Type</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>