You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by kw...@apache.org on 2014/10/06 08:57:01 UTC
svn commit: r1629579 [4/4] - in /qpid/trunk/qpid/doc/book/src: java-broker/
java-broker/concepts/ java-broker/images/ java-broker/management/
java-broker/management/channels/ java-broker/management/managing/
jms-client-0-8/
Added: qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml?rev=1629579&view=auto
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml (added)
+++ qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml Mon Oct 6 06:56:59 2014
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+ 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.
+
+-->
+
+<section id="Java-Broker-Management-Managing-Truststores">
+ <title>Truststores</title>
+ <para> A <link linkend="Java-Broker-Concepts-Truststores">Truststore</link> is required by a
+ Port in order to SSL client authentication. Some authentication provides also use a
+ truststore when connecting to authentication systems that are protected by a private issuer
+ SSL certificate.</para>
+ <section id="Java-Broker-Management-Managing-Truststores-Attributes">
+ <title>Attributes</title>
+ <para><itemizedlist>
+ <listitem>
+ <para><emphasis>Name the truststore</emphasis>. Used to identify the
+ truststore.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Path</emphasis>. Path to truststore file</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Truststore password</emphasis>. Password used to secure the truststore<important>
+ <para> The password of the certificate used by the Broker <emphasis
+ role="bold">must</emphasis> match the password of the keystore
+ itself. </para>
+ </important></para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Certificate Alias</emphasis>. An optional way of specifying
+ which certificate the broker should use if the keystore contains multiple
+ entries.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Manager Factory Algorithm</emphasis>. In keystores the have more
+ than one certificate, the alias identifies the certificate to be
+ used.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Key Store Type</emphasis>. Type of Keystore.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Peers only</emphasis>. When "Peers Only" option is selected for
+ the Truststore it will allow logging in for the clients with the certificate
+ exactly matching the certificate loaded in the Truststore database, thus,
+ authenticating the connections with self signed certificates not nessesary
+ signed by CA.</para>
+ </listitem>
+ </itemizedlist></para>
+ </section>
+ <section id="Java-Broker-Management-Managing-Truststores-Children">
+ <title>Children</title>
+ <para>None</para>
+ </section>
+ <section id="Java-Broker-Management-Managing-Truststores-Lifecycle">
+ <title>Lifecycle</title>
+ <para>Not supported</para>
+ </section>
+</section>
Added: qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-VirtualHostNodes.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-VirtualHostNodes.xml?rev=1629579&view=auto
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-VirtualHostNodes.xml (added)
+++ qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-VirtualHostNodes.xml Mon Oct 6 06:56:59 2014
@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+ 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.
+
+-->
+
+<section id="Java-Broker-Management-Managing-Virtualhost-Nodes">
+ <title>Virtualhost Nodes</title>
+ <para>Virtualhost nodes can only be managed by the HTTP management channel.</para>
+ <section id="Java-Broker-Management-Managing-Virtualhost-Nodes-Types">
+ <title>Types</title>
+ <para> The following virtualhost nodes types are supported. <itemizedlist>
+ <listitem><para>BDB - Node backed with Oracle BDB <footnote>
+ <para>Oracle BDB JE is optional. See <xref
+ linkend="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE"/>.</para>
+ </footnote></para></listitem>
+ <listitem><para>BDB HA - Node backed with Oracle BDB utilising High Availablity</para></listitem>
+ <listitem><para>DERBY - Node backed with Apache Derby</para></listitem>
+ <listitem><para>JDBC - Node backed with an external database <footnote>
+ <para>JDBC 4.0 compatible drivers must be available. See <xref
+ linkend="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver"/></para>
+ </footnote></para></listitem>
+ <listitem><para>JSON - Node backed with a file containing json</para></listitem>
+ <listitem><para>Memory - In-memory node (changes lost on Broker restart)</para></listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section id="Java-Broker-Management-Managing-Virtualhost-Nodes-Attributes">
+ <title>Attributes</title>
+ <para><itemizedlist>
+ <listitem>
+ <para><emphasis>Name the virtualhost node</emphasis>.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Store Path or JDBC URL.</emphasis> Refers the location used to store the
+ configuration of the virtualhost.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Role</emphasis> (HA only). The role that this node is currently playing in the
+ group. <itemizedlist>
+ <listitem>
+ <para>MASTER - Virtualhost node is a master.</para>
+ </listitem>
+ <listitem>
+ <para>REPLICA - Virtualhost node is a replica.</para>
+ </listitem>
+ <listitem>
+ <para>WAITING - Virtualhost node is awaiting an election result, or may be awaiting
+ more nodes to join in order that an election may be held.</para>
+ </listitem>
+ <listitem>
+ <para>DETACHED - Virtualhost node is disconnected from the group.</para>
+ </listitem>
+ </itemizedlist></para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Priority</emphasis> (HA only). The priority of this node when elections occurs. The attribute can be used to make it more likely for a node to be elected than other nodes, or disallow the node from never being elected at all. See <xref linkend="Java-Broker-High-Availability"/></para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Minimum Number Of Nodes</emphasis> (HA only - groups of three or more). Allows the number of nodes required to hold an election to be reduced in order that service can be restore when less than quorum nodes are present. See <xref linkend="Java-Broker-High-Availability"/></para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Designated Primary</emphasis> (HA only - groups of two). Allows a single node in a two node group to operate solo. See <xref linkend="Java-Broker-High-Availability"/></para>
+ </listitem>
+ </itemizedlist></para>
+ </section>
+ <section id="Java-Broker-Management-Managing-Virtualhost-Node-Children">
+ <title>Children</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para><link linkend="Java-Broker-Management-Managing-Virtualhosts">Virtualhost</link></para>
+ </listitem>
+ <listitem>
+ <para><link linkend="Java-Broker-Management-Managing-RemoteReplicationNodes">Remote Replication Nodes</link></para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section id="Java-Broker-Management-Managing-Virtualhost-Node-Lifecycle">
+ <title>Lifecycle</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>Stop</emphasis>. Stops the virtualhost node. This closes any existing
+ messaging connections to the virtualhost and prevents new ones. Any inflight
+ transactions are rolled back. Non durable queues and exchanges are lost. Transient
+ messages or persistent messages on non-durable queues are lost.</para>
+ <para>When HA is in use, stopping the virtualhost node stops the virtualhost node from
+ participating in the group. If the node was in the master role, the remaining nodes will
+ try to conduct an election and elect a new master. If the node was in the replica role,
+ the node will cease to keep up to date with later transactions. A stopped node does not
+ vote in elections. Other nodes in the group will report the stopped node as
+ unreachable.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Start</emphasis>. Activates the virtualhost node.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Delete</emphasis>. Deletes the virtualhost node and the virtualhost
+ contained within it. All exchanges and queues, any the messages contained within it are
+ removed. In the HA case, deleting the virtualhost node causes it be be removed
+ permantently from the group.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+</section>
Added: qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml?rev=1629579&view=auto
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml (added)
+++ qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml Mon Oct 6 06:56:59 2014
@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+ 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.
+
+-->
+
+<section id="Java-Broker-Management-Managing-Virtualhosts">
+ <title>VirtualHosts</title>
+ <para>A virtualhost is a independent namespace in which messaging is performed. Virtualhosts are
+ responsible for the storage of message data.</para>
+ <para>Virtualhosts can only be managed by the HTTP management channel.</para>
+ <section id="Java-Broker-Management-Managing-Virtualhosts-Types">
+ <title>Types</title>
+ <para>The following virtualhost types are supported. <itemizedlist>
+ <listitem>
+ <para>BDB - Virtualhost backed with Oracle BDB <footnote>
+ <para>Oracle BDB JE is optional. See <xref
+ linkend="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE"/>.</para>
+ </footnote></para>
+ </listitem>
+ <listitem>
+ <para>BDB HA - Virtualhost backed with Oracle BDB utilising High Availablity</para>
+ </listitem>
+ <listitem>
+ <para>DERBY - Virtualhost backed with Apache Derby</para>
+ </listitem>
+ <listitem>
+ <para>JDBC - Virtualhost backed with an external database <footnote>
+ <para>JDBC 4.0 compatible drivers must be available. See <xref
+ linkend="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver"/></para>
+ </footnote></para>
+ </listitem>
+ <listitem>
+ <para>Memory - In-memory node (changes lost on Broker restart)</para>
+ </listitem>
+ <listitem>
+ <para>Provided - Virtualhost that colocates message data within the parent virtualhost
+ node <footnote>
+ <para>Not available if Virtualhost Node type is JSON.</para>
+ </footnote>.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section id="Java-Broker-Management-Managing-Virtualhost-Attributes">
+ <title>Attributes</title>
+ <para><itemizedlist>
+ <listitem>
+ <para><emphasis>Name the virtualhost</emphasis>. This is the name the messaging clients
+ refer to when forming a connection to the Broker.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Store Path/JDBC URL</emphasis>. Refers the file system location or
+ database URL used to store the message data.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Store overflow/underflow</emphasis>. Some virtualhosts have the ability to
+ limit the of the cumulative size of all the messages contained within the store. This
+ feature is described in detail <xref linkend="Java-Broker-Runtime-Disk-Space-Management"
+ />.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Store transaction timeouts</emphasis>. Warns of long running producer
+ transactions. See <xref linkend="Java-Broker-Runtime-Producer-Transaction-Timeout"
+ /></para>
+ </listitem>
+ </itemizedlist></para>
+ </section>
+ <section id="Java-Broker-Management-Managing-Virtualhost-Children">
+ <title>Children</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para><link linkend="Java-Broker-Management-Managing-Exchanges">Exchange</link></para>
+ </listitem>
+ <listitem>
+ <para><link linkend="Java-Broker-Management-Managing-Queues">Queue</link></para>
+ </listitem>
+ <listitem>
+ <para>Connection</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section id="Java-Broker-Management-Managing-Virtualhost-Lifecycle">
+ <title>Lifecycle</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>Stop</emphasis>. Stops the virtualhost. This closes any existing messaging
+ connections to the virtualhost and prevents new ones. Any inflight transactions are
+ rolled back. Non durable queues and non durable exchanges are lost. Transient messages
+ or persistent messages on non-durable queues are lost.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Start</emphasis>. Activates the virtualhost.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+</section>
Modified: qpid/trunk/qpid/doc/book/src/jms-client-0-8/JMS-Client-Book.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/jms-client-0-8/JMS-Client-Book.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/jms-client-0-8/JMS-Client-Book.xml (original)
+++ qpid/trunk/qpid/doc/book/src/jms-client-0-8/JMS-Client-Book.xml Mon Oct 6 06:56:59 2014
@@ -28,9 +28,6 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JMS-Client-Getting-And-Dependencies.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JMS-Client-Examples.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JMS-Client-Understanding.xml"/>
- <!-- TODO:
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JMS-Client-JMS-Extensions.xml"/>
- -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JMS-Client-JNDI-Properties-Format.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JMS-Client-Connection-URL.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JMS-Client-Binding-URL.xml"/>
@@ -42,7 +39,8 @@
-->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JMS-Client-Appendix-Exceptions.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JMS-Client-Appendix-Maven.xml"/>
-
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="JMS-Client-JMS-Extensions.xml"/>
+
</book>
Modified: qpid/trunk/qpid/doc/book/src/jms-client-0-8/JMS-Client-JMS-Extensions.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/jms-client-0-8/JMS-Client-JMS-Extensions.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/jms-client-0-8/JMS-Client-JMS-Extensions.xml (original)
+++ qpid/trunk/qpid/doc/book/src/jms-client-0-8/JMS-Client-JMS-Extensions.xml Mon Oct 6 06:56:59 2014
@@ -26,8 +26,66 @@
-->
-<chapter id="JMS-Client-0-8-JMS-Extensions">
+<appendix id="JMS-Client-0-8-Appendix-JMS-Extensions">
<title>JMS Extensions</title>
+ <para>This section illustrates using Qpid specific JMX extentions for the managament of queues,
+ exchanges and bindings.</para>
+ <para>
+ <important>It is not recommended that these extensions are normally used. Instead, the reader is
+ directed towards the Managment interfaces of the Broker.</important></para>
+ <section id="JMS-Client-0-8-Appendix-JMS-Extensions-Queue">
+ <title>Queue Management</title>
+ <para>These extensions allow queues to be created or removed.</para>
+ <section id="JMS-Client-0-8-Appendix-JMS-Extensions-Queue-Creation">
+ <title>Queue creation</title>
+ <para>The following example illustrates the creation of the a LVQ queue from a
+ javax.jms.Session object. Note that this utilises a Qpid specific extension to JMS and
+ involves casting the session object back to its Qpid base-class.</para>
+ <example>
+ <title>Creation of an LVQ using the Qpid extension to JMS</title>
+ <programlisting><![CDATA[Map<String,Object> arguments = new HashMap<String, Object>();
+arguments.put("qpid.last_value_queue_key","ISIN");
+AMQDestination amqQueue = (AMQDestination) context.lookup("myqueue");
+((AMQSession<?,?>) session).createQueue(
+ AMQShortString.valueOf(amqQueue.getQueueName()),
+ amqQueue.isAutoDelete(),
+ amqQueue.isDurable(),
+ amqQueue.isExclusive(),
+ arguments);
+]]></programlisting>
+ </example>
+ </section>
+ <section id="JMS-Client-0-8-Appendix-JMS-Extensions-Binding">
+ <title>Binding Management</title>
+ <para>These extensions allow bindings to be created or removed.</para>
- <para>TODO</para>
-</chapter>
+ <section id="JMS-Client-0-8-Appendix-JMS-Extensions-Binding-Creation">
+ <title>Binding creation</title>
+ <para>The following example illustrates the creation of queue binding to topic exchange with
+ JMS client.</para>
+ <example>
+ <title>Binding a queue using JMS</title>
+ <programlisting><![CDATA[ConnectionFactory connectionFactory = ...
+Connection connection = connectionFactory.createConnection();
+AMQSession<?, ?> session = (AMQSession<?,?>)connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
+
+...
+
+AMQShortString queueName = new AMQShortString("testQueue");
+AMQShortString routingKey = new AMQShortString("testRoutingKey");
+AMQDestination destination = (AMQDestination) session.createQueue(queueName.asString());
+
+...
+
+// binding arguments
+Map<String, Object> arguments = new HashMap<String, Object>();
+arguments.put("x-filter-jms-selector", "application='app1'");
+
+// create binding
+session.bindQueue(queueName, routingKey, FieldTable.convertToFieldTable(arguments),
+ new AMQShortString("amq.topic"), destination);]]></programlisting>
+ </example>
+ </section>
+ </section>
+ </section>
+</appendix>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org