This is an automated email from the ASF dual-hosted git repository. orudyy pushed a commit to branch 7.1.x in repository https://gitbox.apache.org/repos/asf/qpid-broker-j.git
The following commit(s) were added to refs/heads/7.1.x by this push: new 13bcee3 QPID-8307:[Broker-J][Documentation] Document how to specify virtualhost initial configuration 13bcee3 is described below commit 13bcee3126ca99506713bcc29921583715cac9f0 Author: Alex Rudyy <oru...@apache.org> AuthorDate: Wed May 8 20:58:35 2019 +0100 QPID-8307:[Broker-J][Documentation] Document how to specify virtualhost initial configuration (cherry picked from commit 6dc4f78e7fca09b6466103324f388715d5c43327) --- .../docbkx/Java-Broker-Initial-Configuration.xml | 36 +++++++++++++++++++--- .../Java-Broker-Concepts-Virtualhost-Nodes.xml | 5 +++ 2 files changed, 36 insertions(+), 5 deletions(-) diff --git a/doc/java-broker/src/docbkx/Java-Broker-Initial-Configuration.xml b/doc/java-broker/src/docbkx/Java-Broker-Initial-Configuration.xml index bfd68f2..3a99393 100644 --- a/doc/java-broker/src/docbkx/Java-Broker-Initial-Configuration.xml +++ b/doc/java-broker/src/docbkx/Java-Broker-Initial-Configuration.xml @@ -363,11 +363,7 @@ $ ./qpid-server -prop "qpid.amqp_port=10000" -prop "qpid.http_port=10001" </para> </listitem> <listitem> - <para> Virtualhost Node called default. On initial startup, it - virtualHostInitialConfiguration will cause a virtualhost to be created - with the same name. The configuration will be stored in a - <emphasis>JSON</emphasis> configuration store, the message data will - be stored in a <emphasis>DERBY</emphasis> message store.</para> + <para> Virtualhost Node called <emphasis>default</emphasis>.</para> </listitem> <listitem> <para>One management plugin: "httpManagement" of type "MANAGEMENT-HTTP".</para> @@ -380,4 +376,34 @@ $ ./qpid-server -prop "qpid.amqp_port=10000" -prop "qpid.http_port=10001" </example> </section> + <section xml:id="Java-Broker-Virtual-Host-Initial-Configuration"> + <title>Virtualhost Initial Configuration</title> + <para> + <emphasis>Virtualhost</emphasis> initial configuration can be specified in <emphasis>Virtualhost node</emphasis> + attribute <emphasis>virtualHostInitialConfiguration</emphasis>. On first startup, + the <emphasis>virtualhost</emphasis> is created based on provided initial configuration. + You can define there manageable <emphasis>Virtualhost</emphasis> attributes and children like exchanges, queues, etc. + </para> + <para> + The attribute <varname>virtualHostInitialConfiguration</varname> can have a value of <emphasis>URL</emphasis> + to an external resource where <emphasis>virtualhost</emphasis> initial configuration is provided in json format, or, + it can hold a string value with initial configuration in stringified json format. If required, you can + specify initial configuration as context variable which can be resolved as <emphasis>URL</emphasis> + to external resource or stringified json. + </para> + <example> + <title>Example of virtual host initial configuration provided as stringified JSON</title> + <programlisting> + ... + "virtualhostnodes" : [ { + "name" : "default", + "type" : "JSON", + "defaultVirtualHostNode" : "true", + "virtualHostInitialConfiguration" : "{\"type\":\"BDB\",\"nodeAutoCreationPolicies\":[{\"patterns\":\".*\",\"createdOnPublish\":\"true\",\"createdOnConsume\":\"true\",\"nodeType\":\"queue\"}]}" + } ] + ...</programlisting> + </example> + <para>After creation of <emphasis>virtualhost</emphasis> the value of + <varname>virtualHostInitialConfiguration</varname> is set to an empty string.</para> + </section> </chapter> diff --git a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml index b4b9e41..ee7e8f0 100644 --- a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml +++ b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml @@ -31,4 +31,9 @@ the group. The virtualhost nodes together elect a master. When the high availability feature is in use, the virtualhost node has <link linkend="Java-Broker-Concepts-RemoteReplicationNodes">remote replications nodes</link>. There is a remote replication node corresponding to each remote virtualhost node that form part of the group.</para> + <para> + <emphasis>Virtualhost node</emphasis> also provides an initial configuration for its <emphasis>virtualhost</emphasis>. + How to specify initial configuration for <emphasis>virtual host</emphasis> is described at + <xref linkend="Java-Broker-Virtual-Host-Initial-Configuration"/>. + </para> </section> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org