From f6dc65f5dc91dd267ee8bfde681faaf18d6a32db Mon Sep 17 00:00:00 2001 From: Jonathan Robie Date: Mon, 1 Mar 2010 22:34:29 +0000 Subject: Fixed many links, added Apache header to each file. git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@917763 13f79535-47bb-0310-9956-ffa450edef68 --- doc/book/src/82403.xml | 467 --------------------- doc/book/src/ACL.xml | 25 +- doc/book/src/AMQP-.NET-Messaging-Client.xml | 16 +- doc/book/src/AMQP-C++-Messaging-Client.xml | 2 +- doc/book/src/AMQP-Compatibility.xml | 2 +- doc/book/src/AMQP-Java-JMS-Messaging-Client.xml | 11 +- doc/book/src/AMQP-Messaging-Broker-CPP.xml | 24 +- doc/book/src/AMQP-Messaging-Broker-Java.xml | 41 +- doc/book/src/AMQP-Python-Messaging-Client.xml | 2 +- doc/book/src/AMQP-Ruby-Messaging-Client.xml | 2 +- doc/book/src/AMQP.xml | 27 +- doc/book/src/Add-New-Users.xml | 16 +- doc/book/src/Binding-URL-Format.xml | 8 +- doc/book/src/Book-Info.xml | 24 +- doc/book/src/Book.xml | 35 +- doc/book/src/Brokers.xml | 19 - ...heat-Sheet-for-configuring-Exchange-Options.xml | 17 +- .../Cheat-Sheet-for-configuring-Queue-Options.xml | 9 +- doc/book/src/Configure-ACLs.xml | 9 +- ...Configure-Java-Qpid-to-use-a-SSL-connection.xml | 5 +- .../Configure-Log4j-CompositeRolling-Appender.xml | 5 +- .../src/Configure-the-Broker-via-config.xml.xml | 8 +- ...gure-the-Virtual-Hosts-via-virtualhosts.xml.xml | 5 +- doc/book/src/Configuring-Management-Users.xml | 7 +- .../Configuring-Qpid-JMX-Management-Console.xml | 17 +- doc/book/src/Connection-URL-Format.xml | 5 +- doc/book/src/Debug-using-log4j.xml | 7 +- doc/book/src/Download.xml | 84 ++-- doc/book/src/Excel-AddIn.xml | 6 +- doc/book/src/Getting-Started.xml | 62 ++- .../src/How-to-Tune-M3-Java-Broker-Performance.xml | 6 +- doc/book/src/How-to-Use-JNDI.xml | 6 +- doc/book/src/Introduction.xml | 23 + doc/book/src/Java-Broker-Feature-Guide.xml | 4 +- doc/book/src/Java-Environment-Variables.xml | 4 +- doc/book/src/LVQ.xml | 25 +- doc/book/src/Management-Console-Security.xml | 14 +- doc/book/src/Management-Design-notes.xml | 8 +- doc/book/src/Managing-CPP-Broker.xml | 462 ++++++++++++++++++++ doc/book/src/MessageStore-Tool.xml | 6 +- doc/book/src/NET-User-Guide.xml | 6 +- doc/book/src/PythonBrokerTest.xml | 4 +- doc/book/src/QMF-Python-Console-Tutorial.xml | 6 +- doc/book/src/QMan-Qpid-Management-bridge.xml | 18 +- .../src/Qpid-Interoperability-Documentation.xml | 10 +- doc/book/src/Qpid-JMX-Management-Console-FAQ.xml | 6 +- .../src/Qpid-JMX-Management-Console-User-Guide.xml | 7 +- doc/book/src/Qpid-JMX-Management-Console.xml | 14 +- doc/book/src/Qpid-Java-Broker-Management-CLI.xml | 4 +- doc/book/src/Qpid-Java-Build-How-To.xml | 6 +- doc/book/src/Qpid-Java-FAQ.xml | 55 +-- doc/book/src/Qpid-Management-Features.xml | 11 +- doc/book/src/Qpid-Management-Framework.xml | 12 +- doc/book/src/Qpid-Troubleshooting-Guide.xml | 6 +- doc/book/src/RASC.xml | 327 --------------- doc/book/src/Running-CPP-Broker.xml | 328 +++++++++++++++ doc/book/src/SSL.xml | 4 +- doc/book/src/Starting-a-cluster.xml | 4 +- doc/book/src/System-Properties.xml | 6 +- doc/book/src/Use-Priority-Queues.xml | 6 +- doc/book/src/Using-Broker-Federation.xml | 12 +- .../src/Using-Qpid-with-other-JNDI-Providers.xml | 2 +- doc/book/src/WCF.xml | 4 +- doc/book/src/queue-state-replication.xml | 4 +- doc/book/src/schemas.xml | 6 + 65 files changed, 1269 insertions(+), 1124 deletions(-) delete mode 100644 doc/book/src/82403.xml delete mode 100644 doc/book/src/Brokers.xml create mode 100644 doc/book/src/Managing-CPP-Broker.xml delete mode 100644 doc/book/src/RASC.xml create mode 100644 doc/book/src/Running-CPP-Broker.xml diff --git a/doc/book/src/82403.xml b/doc/book/src/82403.xml deleted file mode 100644 index 6745f09477..0000000000 --- a/doc/book/src/82403.xml +++ /dev/null @@ -1,467 +0,0 @@ - - - - - Apache Qpid : MgmtC++ -
- Managing the C++ - Broker - - - There are quite a few ways to interact with the C++ broker. The - command line tools - include: - - qpid-route - used to configure federation (a set of federated - brokers) - - qpid-config - used to configure queues, exchanges, bindings - and list them etc - - qpid-tool - used to view management information/statistics - and call any management actions on the broker - - qpid-printevents - used to receive and print QMF events - - - -
- Using qpid-config - - - This utility can be used to create queues exchanges and bindings, - both durable and transient. Always check for latest options by - running --help command. - - -$ qpid-config --help -Usage: qpid-config [OPTIONS] - qpid-config [OPTIONS] exchanges [filter-string] - qpid-config [OPTIONS] queues [filter-string] - qpid-config [OPTIONS] add exchange <type> <name> [AddExchangeOptions] - qpid-config [OPTIONS] del exchange <name> - qpid-config [OPTIONS] add queue <name> [AddQueueOptions] - qpid-config [OPTIONS] del queue <name> - qpid-config [OPTIONS] bind <exchange-name> <queue-name> [binding-key] - qpid-config [OPTIONS] unbind <exchange-name> <queue-name> [binding-key] - -Options: - -b [ --bindings ] Show bindings in queue or exchange list - -a [ --broker-addr ] Address (localhost) Address of qpidd broker - broker-addr is in the form: [username/password@] hostname | ip-address [:<port>] - ex: localhost, 10.1.1.7:10000, broker-host:10000, guest/guest@localhost - -Add Queue Options: - --durable Queue is durable - --cluster-durable Queue becomes durable if there is only one functioning cluster node - --file-count N (8) Number of files in queue's persistence journal - --file-size N (24) File size in pages (64Kib/page) - --max-queue-size N Maximum in-memory queue size as bytes - --max-queue-count N Maximum in-memory queue size as a number of messages - --limit-policy [none | reject | flow-to-disk | ring | ring-strict] - Action taken when queue limit is reached: - none (default) - Use broker's default policy - reject - Reject enqueued messages - flow-to-disk - Page messages to disk - ring - Replace oldest unacquired message with new - ring-strict - Replace oldest message, reject if oldest is acquired - --order [fifo | lvq | lvq-no-browse] - Set queue ordering policy: - fifo (default) - First in, first out - lvq - Last Value Queue ordering, allows queue browsing - lvq-no-browse - Last Value Queue ordering, browsing clients may lose data - --generate-queue-events N - If set to 1, every enqueue will generate an event that can be processed by - registered listeners (e.g. for replication). If set to 2, events will be - generated for enqueues and dequeues - -Add Exchange Options: - --durable Exchange is durable - --sequence Exchange will insert a 'qpid.msg_sequence' field in the message header - with a value that increments for each message forwarded. - --ive Exchange will behave as an 'initial-value-exchange', keeping a reference - to the last message forwarded and enqueuing that message to newly bound - queues. - - - Get the summary page - - -$ qpid-config -Total Exchanges: 6 - topic: 2 - headers: 1 - fanout: 1 - direct: 2 - Total Queues: 7 - durable: 0 - non-durable: 7 - - - List the queues - - -$ qpid-config queues -Queue Name Attributes -================================================================= -pub_start -pub_done -sub_ready -sub_done -perftest0 --durable -reply-dhcp-100-18-254.bos.redhat.com.20713 auto-del excl -topic-dhcp-100-18-254.bos.redhat.com.20713 auto-del excl - - - - List the exchanges with bindings - - -$ ./qpid-config -b exchanges -Exchange '' (direct) - bind pub_start => pub_start - bind pub_done => pub_done - bind sub_ready => sub_ready - bind sub_done => sub_done - bind perftest0 => perftest0 - bind mgmt-3206ff16-fb29-4a30-82ea-e76f50dd7d15 => mgmt-3206ff16-fb29-4a30-82ea-e76f50dd7d15 - bind repl-3206ff16-fb29-4a30-82ea-e76f50dd7d15 => repl-3206ff16-fb29-4a30-82ea-e76f50dd7d15 -Exchange 'amq.direct' (direct) - bind repl-3206ff16-fb29-4a30-82ea-e76f50dd7d15 => repl-3206ff16-fb29-4a30-82ea-e76f50dd7d15 - bind repl-df06c7a6-4ce7-426a-9f66-da91a2a6a837 => repl-df06c7a6-4ce7-426a-9f66-da91a2a6a837 - bind repl-c55915c2-2fda-43ee-9410-b1c1cbb3e4ae => repl-c55915c2-2fda-43ee-9410-b1c1cbb3e4ae -Exchange 'amq.topic' (topic) -Exchange 'amq.fanout' (fanout) -Exchange 'amq.match' (headers) -Exchange 'qpid.management' (topic) - bind mgmt.# => mgmt-3206ff16-fb29-4a30-82ea-e76f50dd7d15 - -
- -
- Using qpid-route - - - This utility is to create federated networks of brokers, This - allows you for forward messages between brokers in a network. - Messages can be routed statically (using "qpid-route route add") - where the bindings that control message forwarding are supplied - in the route. Message routing can also be dynamic (using - "qpid-route dynamic add") where the messages are automatically - forwarded to clients based on their bindings to the local broker. - - -$ qpid-route -Usage: qpid-route [OPTIONS] dynamic add <dest-broker> <src-broker> <exchange> [tag] [exclude-list] - qpid-route [OPTIONS] dynamic del <dest-broker> <src-broker> <exchange> - - qpid-route [OPTIONS] route add <dest-broker> <src-broker> <exchange> <routing-key> [tag] [exclude-list] - qpid-route [OPTIONS] route del <dest-broker> <src-broker> <exchange> <routing-key> - qpid-route [OPTIONS] queue add <dest-broker> <src-broker> <exchange> <queue> - qpid-route [OPTIONS] queue del <dest-broker> <src-broker> <exchange> <queue> - qpid-route [OPTIONS] route list [<dest-broker>] - qpid-route [OPTIONS] route flush [<dest-broker>] - qpid-route [OPTIONS] route map [<broker>] - - qpid-route [OPTIONS] link add <dest-broker> <src-broker> - qpid-route [OPTIONS] link del <dest-broker> <src-broker> - qpid-route [OPTIONS] link list [<dest-broker>] - -Options: - -v [ --verbose ] Verbose output - -q [ --quiet ] Quiet output, don't print duplicate warnings - -d [ --durable ] Added configuration shall be durable - -e [ --del-empty-link ] Delete link after deleting last route on the link - -s [ --src-local ] Make connection to source broker (push route) - -t <transport> [ --transport <transport>] - Specify transport to use for links, defaults to tcp - - dest-broker and src-broker are in the form: [username/password@] hostname | ip-address [:<port>] - ex: localhost, 10.1.1.7:10000, broker-host:10000, guest/guest@localhost - - - A few examples: - - -qpid-route dynamic add host1 host2 fed.topic -qpid-route dynamic add host2 host1 fed.topic - -qpid-route -v route add host1 host2 hub1.topic hub2.topic.stock.buy -qpid-route -v route add host1 host2 hub1.topic hub2.topic.stock.sell -qpid-route -v route add host1 host2 hub1.topic 'hub2.topic.stock.#' -qpid-route -v route add host1 host2 hub1.topic 'hub2.#' -qpid-route -v route add host1 host2 hub1.topic 'hub2.topic.#' -qpid-route -v route add host1 host2 hub1.topic 'hub2.global.#' - - - The link map feature can be used to display the entire federated - network configuration by supplying a single broker as an entry - point: - - -$ qpid-route route map localhost:10001 - -Finding Linked Brokers: - localhost:10001... Ok - localhost:10002... Ok - localhost:10003... Ok - localhost:10004... Ok - localhost:10005... Ok - localhost:10006... Ok - localhost:10007... Ok - localhost:10008... Ok - -Dynamic Routes: - - Exchange fed.topic: - localhost:10002 <=> localhost:10001 - localhost:10003 <=> localhost:10002 - localhost:10004 <=> localhost:10002 - localhost:10005 <=> localhost:10002 - localhost:10006 <=> localhost:10005 - localhost:10007 <=> localhost:10006 - localhost:10008 <=> localhost:10006 - - Exchange fed.direct: - localhost:10002 => localhost:10001 - localhost:10004 => localhost:10003 - localhost:10003 => localhost:10002 - localhost:10001 => localhost:10004 - -Static Routes: - - localhost:10003(ex=amq.direct) <= localhost:10005(ex=amq.direct) key=rkey - localhost:10003(ex=amq.direct) <= localhost:10005(ex=amq.direct) key=rkey2 - -
- -
- Using qpid-tool - - - This utility provided a telnet style interface to be able to - view, list all stats and action - all the methods. Simple capture below. Best to just play with it - and mail the list if you have - questions or want features added. - - -qpid: -qpid: help -Management Tool for QPID -Commands: - list - Print summary of existing objects by class - list <className> - Print list of objects of the specified class - list <className> all - Print contents of all objects of specified class - list <className> active - Print contents of all non-deleted objects of specified class - list <list-of-IDs> - Print contents of one or more objects (infer className) - list <className> <list-of-IDs> - Print contents of one or more objects - list is space-separated, ranges may be specified (i.e. 1004-1010) - call <ID> <methodName> <args> - Invoke a method on an object - schema - Print summary of object classes seen on the target - schema <className> - Print details of an object class - set time-format short - Select short timestamp format (default) - set time-format long - Select long timestamp format - quit or ^D - Exit the program -qpid: list -Management Object Types: - ObjectType Active Deleted - ================================ - qpid.binding 21 0 - qpid.broker 1 0 - qpid.client 1 0 - qpid.exchange 6 0 - qpid.queue 13 0 - qpid.session 4 0 - qpid.system 1 0 - qpid.vhost 1 0 -qpid: list qpid.system -Objects of type qpid.system - ID Created Destroyed Index - ================================== - 1000 21:00:02 - host -qpid: list 1000 -Object of type qpid.system: (last sample time: 21:26:02) - Type Element 1000 - ======================================================= - config sysId host - config osName Linux - config nodeName localhost.localdomain - config release 2.6.24.4-64.fc8 - config version #1 SMP Sat Mar 29 09:15:49 EDT 2008 - config machine x86_64 -qpid: schema queue -Schema for class 'qpid.queue': - Element Type Unit Access Notes Description - =================================================================================================================== - vhostRef reference ReadCreate index - name short-string ReadCreate index - durable boolean ReadCreate - autoDelete boolean ReadCreate - exclusive boolean ReadCreate - arguments field-table ReadOnly Arguments supplied in queue.declare - storeRef reference ReadOnly Reference to persistent queue (if durable) - msgTotalEnqueues uint64 message Total messages enqueued - msgTotalDequeues uint64 message Total messages dequeued - msgTxnEnqueues uint64 message Transactional messages enqueued - msgTxnDequeues uint64 message Transactional messages dequeued - msgPersistEnqueues uint64 message Persistent messages enqueued - msgPersistDequeues uint64 message Persistent messages dequeued - msgDepth uint32 message Current size of queue in messages - msgDepthHigh uint32 message Current size of queue in messages (High) - msgDepthLow uint32 message Current size of queue in messages (Low) - byteTotalEnqueues uint64 octet Total messages enqueued - byteTotalDequeues uint64 octet Total messages dequeued - byteTxnEnqueues uint64 octet Transactional messages enqueued - byteTxnDequeues uint64 octet Transactional messages dequeued - bytePersistEnqueues uint64 octet Persistent messages enqueued - bytePersistDequeues uint64 octet Persistent messages dequeued - byteDepth uint32 octet Current size of queue in bytes - byteDepthHigh uint32 octet Current size of queue in bytes (High) - byteDepthLow uint32 octet Current size of queue in bytes (Low) - enqueueTxnStarts uint64 transaction Total enqueue transactions started - enqueueTxnCommits uint64 transaction Total enqueue transactions committed - enqueueTxnRejects uint64 transaction Total enqueue transactions rejected - enqueueTxnCount uint32 transaction Current pending enqueue transactions - enqueueTxnCountHigh uint32 transaction Current pending enqueue transactions (High) - enqueueTxnCountLow uint32 transaction Current pending enqueue transactions (Low) - dequeueTxnStarts uint64 transaction Total dequeue transactions started - dequeueTxnCommits uint64 transaction Total dequeue transactions committed - dequeueTxnRejects uint64 transaction Total dequeue transactions rejected - dequeueTxnCount uint32 transaction Current pending dequeue transactions - dequeueTxnCountHigh uint32 transaction Current pending dequeue transactions (High) - dequeueTxnCountLow uint32 transaction Current pending dequeue transactions (Low) - consumers uint32 consumer Current consumers on queue - consumersHigh uint32 consumer Current consumers on queue (High) - consumersLow uint32 consumer Current consumers on queue (Low) - bindings uint32 binding Current bindings - bindingsHigh uint32 binding Current bindings (High) - bindingsLow uint32 binding Current bindings (Low) - unackedMessages uint32 message Messages consumed but not yet acked - unackedMessagesHigh uint32 message Messages consumed but not yet acked (High) - unackedMessagesLow uint32 message Messages consumed but not yet acked (Low) - messageLatencySamples delta-time nanosecond Broker latency through this queue (Samples) - messageLatencyMin delta-time nanosecond Broker latency through this queue (Min) - messageLatencyMax delta-time nanosecond Broker latency through this queue (Max) - messageLatencyAverage delta-time nanosecond Broker latency through this queue (Average) -Method 'purge' Discard all messages on queue -qpid: list queue -Objects of type qpid.queue - ID Created Destroyed Index - =========================================================================== - 1012 21:08:13 - 1002.pub_start - 1014 21:08:13 - 1002.pub_done - 1016 21:08:13 - 1002.sub_ready - 1018 21:08:13 - 1002.sub_done - 1020 21:08:13 - 1002.perftest0 - 1038 21:09:08 - 1002.mgmt-3206ff16-fb29-4a30-82ea-e76f50dd7d15 - 1040 21:09:08 - 1002.repl-3206ff16-fb29-4a30-82ea-e76f50dd7d15 - 1046 21:09:32 - 1002.mgmt-df06c7a6-4ce7-426a-9f66-da91a2a6a837 - 1048 21:09:32 - 1002.repl-df06c7a6-4ce7-426a-9f66-da91a2a6a837 - 1054 21:10:01 - 1002.mgmt-c55915c2-2fda-43ee-9410-b1c1cbb3e4ae - 1056 21:10:01 - 1002.repl-c55915c2-2fda-43ee-9410-b1c1cbb3e4ae - 1063 21:26:00 - 1002.mgmt-8d621997-6356-48c3-acab-76a37081d0f3 - 1065 21:26:00 - 1002.repl-8d621997-6356-48c3-acab-76a37081d0f3 -qpid: list 1020 -Object of type qpid.queue: (last sample time: 21:26:02) - Type Element 1020 - ========================================================================== - config vhostRef 1002 - config name perftest0 - config durable False - config autoDelete False - config exclusive False - config arguments {'qpid.max_size': 0, 'qpid.max_count': 0} - config storeRef NULL - inst msgTotalEnqueues 500000 messages - inst msgTotalDequeues 500000 - inst msgTxnEnqueues 0 - inst msgTxnDequeues 0 - inst msgPersistEnqueues 0 - inst msgPersistDequeues 0 - inst msgDepth 0 - inst msgDepthHigh 0 - inst msgDepthLow 0 - inst byteTotalEnqueues 512000000 octets - inst byteTotalDequeues 512000000 - inst byteTxnEnqueues 0 - inst byteTxnDequeues 0 - inst bytePersistEnqueues 0 - inst bytePersistDequeues 0 - inst byteDepth 0 - inst byteDepthHigh 0 - inst byteDepthLow 0 - inst enqueueTxnStarts 0 transactions - inst enqueueTxnCommits 0 - inst enqueueTxnRejects 0 - inst enqueueTxnCount 0 - inst enqueueTxnCountHigh 0 - inst enqueueTxnCountLow 0 - inst dequeueTxnStarts 0 - inst dequeueTxnCommits 0 - inst dequeueTxnRejects 0 - inst dequeueTxnCount 0 - inst dequeueTxnCountHigh 0 - inst dequeueTxnCountLow 0 - inst consumers 0 consumers - inst consumersHigh 0 - inst consumersLow 0 - inst bindings 1 binding - inst bindingsHigh 1 - inst bindingsLow 1 - inst unackedMessages 0 messages - inst unackedMessagesHigh 0 - inst unackedMessagesLow 0 - inst messageLatencySamples 0 - inst messageLatencyMin 0 - inst messageLatencyMax 0 - inst messageLatencyAverage 0 -qpid: - -
- -
- Using - qpid-printevents - - - This utility connects to one or more brokers and collects events, - printing out a line per event. - - -$ qpid-printevents --help -Usage: qpid-printevents [options] [broker-addr]... - -Collect and print events from one or more Qpid message brokers. If no broker- -addr is supplied, qpid-printevents will connect to 'localhost:5672'. broker- -addr is of the form: [username/password@] hostname | ip-address [:<port>] ex: -localhost, 10.1.1.7:10000, broker-host:10000, guest/guest@localhost - -Options: - -h, --help show this help message and exit - - - You get the idea... have fun! - -
-
- diff --git a/doc/book/src/ACL.xml b/doc/book/src/ACL.xml index 123819b490..204884936f 100644 --- a/doc/book/src/ACL.xml +++ b/doc/book/src/ACL.xml @@ -20,17 +20,20 @@ --> - +<section id="qpid_ACL"> + <title> Apache Qpid : ACL -
- v2 ACL file format - for brokers - - - This new ACL implementation has been designed for implementation - and interoperability on all Qpid brokers. It is currently - supported in the following brokers: - + + +
+ + v2 ACL file format for brokers + + + This new ACL implementation has been designed for implementation + and interoperability on all Qpid brokers. It is currently + supported in the following brokers: + <tgroup cols="2"> <thead> @@ -789,4 +792,4 @@ ACL Options: <!--h3--></section> <!--h2--></section> -</chapter> +</section> diff --git a/doc/book/src/AMQP-.NET-Messaging-Client.xml b/doc/book/src/AMQP-.NET-Messaging-Client.xml index d4ea48e8ee..319a248cdd 100644 --- a/doc/book/src/AMQP-.NET-Messaging-Client.xml +++ b/doc/book/src/AMQP-.NET-Messaging-Client.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml" xmlns:xi="http://www.w3.org/2001/XInclude"> +<chapter> <title> Apache Qpid : AMQP .NET Messaging Client @@ -40,9 +40,9 @@ User Guides - - - + + +
@@ -68,7 +68,7 @@ - + @@ -79,7 +79,7 @@ - + @@ -89,12 +89,12 @@ - + - + diff --git a/doc/book/src/AMQP-C++-Messaging-Client.xml b/doc/book/src/AMQP-C++-Messaging-Client.xml index ff21c42b51..8449c00ab6 100644 --- a/doc/book/src/AMQP-C++-Messaging-Client.xml +++ b/doc/book/src/AMQP-C++-Messaging-Client.xml @@ -20,7 +20,7 @@ --> - + Apache Qpid : AMQP C++ Messaging Client diff --git a/doc/book/src/AMQP-Compatibility.xml b/doc/book/src/AMQP-Compatibility.xml index 867d027d56..e9a53772df 100644 --- a/doc/book/src/AMQP-Compatibility.xml +++ b/doc/book/src/AMQP-Compatibility.xml @@ -20,7 +20,7 @@ --> - + Apache Qpid : AMQP compatibility diff --git a/doc/book/src/AMQP-Java-JMS-Messaging-Client.xml b/doc/book/src/AMQP-Java-JMS-Messaging-Client.xml index 2ac1964793..8576870fb0 100644 --- a/doc/book/src/AMQP-Java-JMS-Messaging-Client.xml +++ b/doc/book/src/AMQP-Java-JMS-Messaging-Client.xml @@ -20,7 +20,7 @@ --> - + Apache Qpid : AMQP Java JMS Messaging Client @@ -42,13 +42,12 @@ Does not seem to exist! <listitem><para>AMQP Java JMS Client Feature Guide </para></listitem> -http://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=qpid&title=JMS%20Client%20Feature%20Guide&linkCreation=true&fromPageId=4589057 +http://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=qpid&title=JMS-Client-Feature-Guide&linkCreation=true&fromPageId=4589057 --> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Qpid%20Java%20FAQ.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="System%20Properties.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Connection%20URL%20Format.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Binding%20URL%20Format.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="System-Properties.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Connection-URL-Format.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Binding-URL-Format.xml"/> <!-- <listitem><para>How to Use JNDI to configure the AMQP Java JMS Client diff --git a/doc/book/src/AMQP-Messaging-Broker-CPP.xml b/doc/book/src/AMQP-Messaging-Broker-CPP.xml index 0373583af4..b9c513e511 100644 --- a/doc/book/src/AMQP-Messaging-Broker-CPP.xml +++ b/doc/book/src/AMQP-Messaging-Broker-CPP.xml @@ -40,29 +40,29 @@ Running the AMQP Messaging Broker - - - + + + - + - - + + - + Managing the AMQP Messaging Broker - - - - - + + + + + diff --git a/doc/book/src/AMQP-Messaging-Broker-Java.xml b/doc/book/src/AMQP-Messaging-Broker-Java.xml index 99928fe22e..14fe977670 100644 --- a/doc/book/src/AMQP-Messaging-Broker-Java.xml +++ b/doc/book/src/AMQP-Messaging-Broker-Java.xml @@ -38,34 +38,33 @@ General User Guides - - - - + + + + - + How Tos - - - - - - - - - - + + + + + + + + + + - -Management Tools - - - - + + +Management Tools + + diff --git a/doc/book/src/AMQP-Python-Messaging-Client.xml b/doc/book/src/AMQP-Python-Messaging-Client.xml index 4ccfeb3a3f..cd912431e0 100644 --- a/doc/book/src/AMQP-Python-Messaging-Client.xml +++ b/doc/book/src/AMQP-Python-Messaging-Client.xml @@ -20,7 +20,7 @@ --> - + Apache Qpid : AMQP Python Messaging Client diff --git a/doc/book/src/AMQP-Ruby-Messaging-Client.xml b/doc/book/src/AMQP-Ruby-Messaging-Client.xml index 6b8344197a..932a689b87 100644 --- a/doc/book/src/AMQP-Ruby-Messaging-Client.xml +++ b/doc/book/src/AMQP-Ruby-Messaging-Client.xml @@ -20,7 +20,7 @@ --> - + Apache Qpid : AMQP Ruby Messaging Client diff --git a/doc/book/src/AMQP.xml b/doc/book/src/AMQP.xml index 8633699db4..1a609649bb 100644 --- a/doc/book/src/AMQP.xml +++ b/doc/book/src/AMQP.xml @@ -1,4 +1,27 @@ + + + + AMQP (Advanced Message Queueing Protocol @@ -25,9 +48,9 @@ support and a lot more. AMQP version 0-10 AMQP 0-10 Specification (PDF) - url="https://jira.amqp.org/confluence/download/attachments/720900/amqp.0-10.xml?version=1" +AMQP 0-10 Protocol Definition XML - url="https://jira.amqp.org/confluence/download/attachments/720900/amqp.0-10.dfd?version=1" +AMQP 0-10 Protocol Definition DTD diff --git a/doc/book/src/Add-New-Users.xml b/doc/book/src/Add-New-Users.xml index 31e4495488..aa141c2531 100644 --- a/doc/book/src/Add-New-Users.xml +++ b/doc/book/src/Add-New-Users.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : Add New Users The Qpid Java Broker has a single reference source () that @@ -43,10 +43,10 @@ use they only need support the SASL mechanisms they provide. - + - + @@ -156,11 +156,11 @@ martin:X03MO1qnZdYdgyfeuILPmQ== for qpid passwd files. NOTE: For the changes to be seen by the broker you must either restart the broker or reload the data with the - management tools (see ) + management tools (see ) Use the management tools to create a new user. The changes will be made by the broker to the password file and the new user - will be immediately available to the system (see ). + will be immediately available to the system (see ).
@@ -176,7 +176,7 @@ martin:X03MO1qnZdYdgyfeuILPmQ== only read once on start up. To make changes dynamically there are two options, both require - administrator access via the Management Console (see ) + administrator access via the Management Console (see ) You can replace the file and use the console to reload its contents. @@ -229,8 +229,8 @@ martin:X03MO1qnZdYdgyfeuILPmQ==
- For details of SASL support see + For details of SASL support see
- +
diff --git a/doc/book/src/Binding-URL-Format.xml b/doc/book/src/Binding-URL-Format.xml index 65d619b470..4951eec64a 100644 --- a/doc/book/src/Binding-URL-Format.xml +++ b/doc/book/src/Binding-URL-Format.xml @@ -1,4 +1,5 @@ + - - Apache Qpid : BindingURLFormat +<section id="BindingURLFormat"> + <title> + Apache Qpid : Binding URL Format <Exchange Class>://<Exchange Name>/[<Destination>]/[<Queue>][?<option>='<value>'[&<option>='<value>']] @@ -169,4 +171,4 @@ topic://amq.topic?routingkey='stocks.nyse.ibm' - + diff --git a/doc/book/src/Book-Info.xml b/doc/book/src/Book-Info.xml index f8f7516917..2e02fbe8ea 100644 --- a/doc/book/src/Book-Info.xml +++ b/doc/book/src/Book-Info.xml @@ -1,4 +1,26 @@ + + + @@ -41,8 +63,6 @@ - - diff --git a/doc/book/src/Book.xml b/doc/book/src/Book.xml index 175814cb26..ee69532152 100644 --- a/doc/book/src/Book.xml +++ b/doc/book/src/Book.xml @@ -1,4 +1,5 @@ + - - - + + Basics - - - - + + + + - - + + AMQP Messaging Clients Clients - - - - - + + + + + Appendices - - - + + + diff --git a/doc/book/src/Brokers.xml b/doc/book/src/Brokers.xml deleted file mode 100644 index 52fd449464..0000000000 --- a/doc/book/src/Brokers.xml +++ /dev/null @@ -1,19 +0,0 @@ - - AMQP Messaging Brokers - - - Qpid provides two AMQP messaging brokers: - - - Implemented in C++ - high performance, low latency, and RDMA support. - Implemented in Java - Fully JMS compliant, runs on any Java platform. - - - Both AMQP messaging brokers support clients in multiple languages, as long as the messaging client and the messaging broker use the same version of AMQP. See to see which messaging clients work with each broker. - - - - - - - diff --git a/doc/book/src/Cheat-Sheet-for-configuring-Exchange-Options.xml b/doc/book/src/Cheat-Sheet-for-configuring-Exchange-Options.xml index 777fb05e09..2a90f8a93f 100644 --- a/doc/book/src/Cheat-Sheet-for-configuring-Exchange-Options.xml +++ b/doc/book/src/Cheat-Sheet-for-configuring-Exchange-Options.xml @@ -1,4 +1,5 @@ + - - Apache Qpid : Cheat Sheet for configuring Exchange Options -
- Configuring Exchange Options - +
+ + Apache Qpid : Cheat Sheet for configuring Exchange Options + + +
+ + Configuring Exchange Options + The C++ Broker M4 or later supports the following additional Exchange options in addition to the standard AMQP define options @@ -136,4 +141,4 @@
- +
diff --git a/doc/book/src/Cheat-Sheet-for-configuring-Queue-Options.xml b/doc/book/src/Cheat-Sheet-for-configuring-Queue-Options.xml index 6b5a89ca05..2946383285 100644 --- a/doc/book/src/Cheat-Sheet-for-configuring-Queue-Options.xml +++ b/doc/book/src/Cheat-Sheet-for-configuring-Queue-Options.xml @@ -1,4 +1,5 @@ + - +<section><title> Apache Qpid : Cheat Sheet for configuring Queue Options @@ -165,7 +166,7 @@ ignored. - A fully worked can be found here + A fully worked can be found here
@@ -210,7 +211,7 @@ This option is used to determine whether enqueue/dequeue events representing changes made to queue state are generated. These events can then be processed by plugins such as that used for - <xref linkend="qpid_queue-20state-20replication"/>. + <xref linkend="qpid_queue-state-replication"/>. </para><para> Example: </para> @@ -245,4 +246,4 @@ <!--h2--></section> -</chapter> +</section> diff --git a/doc/book/src/Configure-ACLs.xml b/doc/book/src/Configure-ACLs.xml index 086c323d80..f4464caac0 100644 --- a/doc/book/src/Configure-ACLs.xml +++ b/doc/book/src/Configure-ACLs.xml @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> + <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -20,7 +21,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"> +<section> <title> Apache Qpid : Configure ACLs @@ -34,7 +35,7 @@ - + @@ -62,7 +63,7 @@ - + Support for Version 2 specification is in progress. @@ -74,4 +75,4 @@
- + diff --git a/doc/book/src/Configure-Java-Qpid-to-use-a-SSL-connection.xml b/doc/book/src/Configure-Java-Qpid-to-use-a-SSL-connection.xml index b790b09f16..ad908c0dab 100644 --- a/doc/book/src/Configure-Java-Qpid-to-use-a-SSL-connection.xml +++ b/doc/book/src/Configure-Java-Qpid-to-use-a-SSL-connection.xml @@ -1,4 +1,5 @@ + - +<section><title> Apache Qpid : Configure Java Qpid to use a SSL connection. @@ -80,4 +81,4 @@ - + diff --git a/doc/book/src/Configure-Log4j-CompositeRolling-Appender.xml b/doc/book/src/Configure-Log4j-CompositeRolling-Appender.xml index d8dc88bb76..3f7be3e5c3 100644 --- a/doc/book/src/Configure-Log4j-CompositeRolling-Appender.xml +++ b/doc/book/src/Configure-Log4j-CompositeRolling-Appender.xml @@ -1,4 +1,5 @@ + - +<section><title> Apache Qpid : Configure Log4j CompositeRolling Appender
@@ -146,4 +147,4 @@ </listitem> </orderedlist> <!--h2--></section> -</chapter> +</section> diff --git a/doc/book/src/Configure-the-Broker-via-config.xml.xml b/doc/book/src/Configure-the-Broker-via-config.xml.xml index ac1f1d1fc6..a56c613965 100644 --- a/doc/book/src/Configure-the-Broker-via-config.xml.xml +++ b/doc/book/src/Configure-the-Broker-via-config.xml.xml @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> + <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -20,14 +21,13 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"> +<section> <title> Apache Qpid : Configure the Broker via config.xml
- Broker - config.xml Overview + Broker config.xml Overview The broker config.xml file which is shipped in the etc directory @@ -68,4 +68,4 @@
- +
diff --git a/doc/book/src/Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml b/doc/book/src/Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml index 9e54e39c85..f98b18614e 100644 --- a/doc/book/src/Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml +++ b/doc/book/src/Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml @@ -1,4 +1,5 @@ + - +<section><title> Apache Qpid : Configure the Virtual Hosts via virtualhosts.xml
virtualhosts.xml Overview @@ -127,4 +128,4 @@ </para> <!--h3--></section> <!--h2--></section> -</chapter> +</section> diff --git a/doc/book/src/Configuring-Management-Users.xml b/doc/book/src/Configuring-Management-Users.xml index e473a047b5..d338512ddc 100644 --- a/doc/book/src/Configuring-Management-Users.xml +++ b/doc/book/src/Configuring-Management-Users.xml @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> + <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -20,7 +21,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"><title> +<section><title> Apache Qpid : Configuring Management Users The Qpid Java broker has a single source of users for the system. @@ -42,7 +43,7 @@ There are two steps required to add a new user with rights for the JMX console. - Create a new user login, see HowTo: + Create a new user login, see HowTo: Grant the new user permission to the JMX Console @@ -113,4 +114,4 @@ user=readwrite
- + diff --git a/doc/book/src/Configuring-Qpid-JMX-Management-Console.xml b/doc/book/src/Configuring-Qpid-JMX-Management-Console.xml index 1bc5e1138e..9129569c70 100644 --- a/doc/book/src/Configuring-Qpid-JMX-Management-Console.xml +++ b/doc/book/src/Configuring-Qpid-JMX-Management-Console.xml @@ -1,4 +1,5 @@ + - +<section><title> Apache Qpid : Configuring Qpid JMX Management Console
Configuring Qpid JMX Management Console @@ -30,7 +31,7 @@ Qpid has a JMX management interface that exposes a number of components of the running broker. You can find out more about the features exposed by the JMX - interfaces <xref linkend="qpid_Qpid-20Management-20Features"/>. + interfaces <xref linkend="qpid_Qpid-Management-Features"/>. </para><para> </para> @@ -49,7 +50,7 @@ being connected to is making use of this ability then additional console configuration may be required, particularly when using self-signed certificates. See - <xref linkend="qpid_Management-20Console-20Security"/> for details. + <xref linkend="qpid_Management-Console-Security"/> for details. </para> </note> </listitem> @@ -66,7 +67,7 @@ However, if you wish to connect to an older broker using JMXMP the console will support this so long as the <emphasis>jmxremote_optional.jar</emphasis> file is provided to it. - For details see <xref linkend="qpid_Management-20Console-20Security"/>. + For details see <xref linkend="qpid_Management-Console-Security"/>. </para> </note> <!--h3--></section> @@ -98,7 +99,7 @@ - Please see for details on using this Eclipse RCP + Please see for details on using this Eclipse RCP application. @@ -124,7 +125,7 @@ HermesJMS also offers integration with the Qpid management interfaces. You can get instructions and more information from - . + HermesJMS.
@@ -134,7 +135,7 @@ - is an alternative + MC4J is an alternative management tool. It provide a richer "dashboard" that can customise the raw MBeans. @@ -177,4 +178,4 @@ - + diff --git a/doc/book/src/Connection-URL-Format.xml b/doc/book/src/Connection-URL-Format.xml index a50b379ceb..2195bb6c38 100644 --- a/doc/book/src/Connection-URL-Format.xml +++ b/doc/book/src/Connection-URL-Format.xml @@ -1,4 +1,5 @@ + - +
Apache Qpid : Connection URL Format @@ -378,4 +379,4 @@ amqp://guest:guest@/test?brokerlist='vm://:1'&failover='nofailover'
- + diff --git a/doc/book/src/Debug-using-log4j.xml b/doc/book/src/Debug-using-log4j.xml index fd49dcd2e4..bf948dfdc7 100644 --- a/doc/book/src/Debug-using-log4j.xml +++ b/doc/book/src/Debug-using-log4j.xml @@ -1,4 +1,5 @@ + - +<section><title> Apache Qpid : Debug using log4j @@ -59,7 +60,7 @@ deprecation notice Version 0.6 of the Java broker includes - functionality which improves upon these messages and + functionality which improves upon these messages and as such enabling status logging would be more beneficial. The configuration file has been left here for assistence with broker versions prior to 0.6. @@ -294,4 +295,4 @@ - + diff --git a/doc/book/src/Download.xml b/doc/book/src/Download.xml index 86ad4b65d8..6e2352d490 100644 --- a/doc/book/src/Download.xml +++ b/doc/book/src/Download.xml @@ -1,12 +1,32 @@ + - + + Download Apache Qpid + + +
Production Releases These releases are well tested and appropriate for production use. 0.5 is the latest release of Qpid. @@ -23,13 +43,17 @@
Multiple Component Packages - - +
Component Download AMQP 0-10 AMQP 0-8/0-9
+ +<tgroup cols='4' align='left' colsep='1' rowsep='1'> +<thead><row><entry> Component </entry><entry> Download </entry><entry> AMQP 0-10 </entry><entry> AMQP 0-8/0-9 </entry></row></thead> <tbody> -<tr><td> Full release & keys </td><td> <ulink url="http://www.apache.org/dist/qpid/0.5/">http://www.apache.org/dist/qpid/0.5/</ulink> </td><td> Y </td><td> Y </td></tr> -<tr><td> C++ broker & client </td><td> <ulink url="http://www.apache.org/dist/qpid/0.5/qpid-cpp-0.5.tar.gz">http://www.apache.org/dist/qpid/0.5/qpid-cpp-0.5.tar.gz</ulink> </td><td> Y </td><td> </td></tr> -<tr><td> Java broker, client & tools </td><td> <ulink url="http://www.apache.org/dist/qpid/0.5/qpid-java-0.5.tar.gz">http://www.apache.org/dist/qpid/0.5/qpid-java-0.5.tar.gz</ulink> </td><td> client </td><td> Y </td></tr> -</tbody></table> +<row><entry> Full release & keys </entry><entry> <ulink url="http://www.apache.org/dist/qpid/0.5/">http://www.apache.org/dist/qpid/0.5/</ulink> </entry><entry> Y </entry><entry> Y </entry></row> +<row><entry> C++ broker & client </entry><entry> <ulink url="http://www.apache.org/dist/qpid/0.5/qpid-cpp-0.5.tar.gz">http://www.apache.org/dist/qpid/0.5/qpid-cpp-0.5.tar.gz</ulink> </entry><entry> Y </entry><entry> </entry></row> +<row><entry> Java broker, client & tools </entry><entry> <ulink url="http://www.apache.org/dist/qpid/0.5/qpid-java-0.5.tar.gz">http://www.apache.org/dist/qpid/0.5/qpid-java-0.5.tar.gz</ulink> </entry><entry> client </entry><entry> Y </entry></row> +</tbody> +</tgroup> +</table> </section> <section><title>Single Component Package @@ -37,53 +61,61 @@
Broker - + + Language Download AMQP 0-10 AMQP 0-8/0-9 - + Java http://www.apache.org/dist/qpid/0.5/qpid-java-broker-0.5.tar.gz Y +
Language Download AMQP 0-10 AMQP 0-8/0-9
Java http://www.apache.org/dist/qpid/0.5/qpid-java-broker-0.5.tar.gz Y
Client - + + Language Download AMQP 0-10 AMQP 0-8/0-9 - - - - - + C# (.NET, WCF, Excel) 0-10 client (C++ Broker Compatible) http://www.apache.org/dist/qpid/0.5/qpid-dotnet-0-10-0.5.zip Y + C# (.NET) 0-8 client (Java Broker Compatible) http://www.apache.org/dist/qpid/0.5/qpid-dotnet-0-8-0.5.zip Y + Java http://www.apache.org/dist/qpid/0.5/qpid-java-client-0.5.tar.gz Y Y + Python http://www.apache.org/dist/qpid/0.5/qpid-python-0.5.tar.gz Y Y + Ruby http://www.apache.org/dist/qpid/0.5/qpid-ruby-0.5.tar.gz Y Y +
Language Download AMQP 0-10 AMQP 0-8/0-9
C# (.NET, WCF, Excel) 0-10 client (C++ Broker Compatible) http://www.apache.org/dist/qpid/0.5/qpid-dotnet-0-10-0.5.zip Y
C# (.NET) 0-8 client (Java Broker Compatible) http://www.apache.org/dist/qpid/0.5/qpid-dotnet-0-8-0.5.zip Y
Java http://www.apache.org/dist/qpid/0.5/qpid-java-client-0.5.tar.gz Y Y
Python http://www.apache.org/dist/qpid/0.5/qpid-python-0.5.tar.gz Y Y
Ruby http://www.apache.org/dist/qpid/0.5/qpid-ruby-0.5.tar.gz Y Y
C++ broker management - + + Component Download AMQP 0-10 - - + cmd line (packaged with python) http://www.apache.org/dist/qpid/0.5/qpid-python-0.5.tar.gz Y + QMan JMX bridge, WS-DM http://www.apache.org/dist/qpid/0.5/qpid-management-client-0.5.tar.gz Y +
Component Download AMQP 0-10
cmd line (packaged with python) http://www.apache.org/dist/qpid/0.5/qpid-python-0.5.tar.gz Y
QMan JMX bridge, WS-DM http://www.apache.org/dist/qpid/0.5/qpid-management-client-0.5.tar.gz Y
Java broker management - + + Component Download - - + + Command line interface http://www.apache.org/dist/qpid/0.5/qpid-management-tools-qpid-cli-0.5.tar.gz +
Component Download
Eclipse RCP client Linux x86 + Eclipse RCP client Linux x86 Linux x86_64 Mac OS X Windows x86 -
Command line interface http://www.apache.org/dist/qpid/0.5/qpid-management-tools-qpid-cli-0.5.tar.gz
-
QpidComponents.org +
QpidComponents.org http://QpidComponents.org provides further components for Apache Qpid, including both persistence and management tools. These components are open source, but are not developed as part of the Apache Qpid project due to licensing or other restrictions. diff --git a/doc/book/src/Excel-AddIn.xml b/doc/book/src/Excel-AddIn.xml index 86621370c0..7752cd94bf 100644 --- a/doc/book/src/Excel-AddIn.xml +++ b/doc/book/src/Excel-AddIn.xml @@ -1,4 +1,5 @@ + - - +
Apache Qpid : Excel AddIn @@ -166,4 +166,4 @@ value="<path>\qpid\dotnet\client-010\addins\ExcelAddInMessageProcessor\bin
- +
diff --git a/doc/book/src/Getting-Started.xml b/doc/book/src/Getting-Started.xml index b32e105a8f..afb81ff92a 100644 --- a/doc/book/src/Getting-Started.xml +++ b/doc/book/src/Getting-Started.xml @@ -1,16 +1,36 @@ - -
+ + + Getting Started To get started with Apache Qpid, follow the steps below. -Download the software [Download] + Start a broker. - Instructions for [running a Qpid Java broker (AMQP 0-8, 0-9) | Getting Started Guide] - Instructions for [running a Qpid C++ broker (AMQP 0-10) | RASC] - [Management tools | MgmtC++] (AMQP 0-10, works with the Qpid C++ broker) + + + (AMQP 0-10, works with the Qpid C++ broker) @@ -18,35 +38,35 @@ C++ (AMQP 0-10): - Examples: [https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/ | https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/] - [Running the C++ Examples | https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/README.txt] + Examples:https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/ + Running the C++ Examples:https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/README.txt Java JMS (AMQP 0-10): - Examples: [https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/ | https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/] - [Script for Running the Java JMS Examples | https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/src/main/java/runSample.sh] + Examples:https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/ + Script for Running the Java JMS Examples https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/src/main/java/runSample.sh Python (AMQP 0-10): - Examples: [https://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/ | https://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/] - [Running the Python Examples | https://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/README] + Examples:https://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/ + Running the Python Exampleshttps://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/README Ruby (AMQP 0-10): - Examples: [https://svn.apache.org/repos/asf/qpid/trunk/qpid/ruby/examples/ | https://svn.apache.org/repos/asf/qpid/trunk/qpid/ruby/examples/] + Examples: https://svn.apache.org/repos/asf/qpid/trunk/qpid/ruby/examples/ .NET (AMQP 0-10): - Examples: [http://svn.apache.org/viewvc/qpid/trunk/qpid/dotnet/client-010/examples/ | http://svn.apache.org/viewvc/qpid/trunk/qpid/dotnet/client-010/examples/] - [.NET Tutorial | http://cwiki.apache.org/confluence/display/qpid/.NET+User+Guide] + Examples:http://svn.apache.org/viewvc/qpid/trunk/qpid/dotnet/client-010/examples/ + @@ -54,19 +74,17 @@ Read the API Guides and Documentation - [C++ Client API (AMQP 0-10) | http://qpid.apache.org/docs/api/cpp/html/index.html] - [JNDI Configuration for Java JMS | http://cwiki.apache.org/confluence/display/qpid/How+to+Use+JNDI] - [Python Client API (AMQP 0-10) | http://qpid.apache.org/docs/api/python/html/index.html] - [Documentation] + C++ Client API (AMQP 0-10) + + Python Client API (AMQP 0-10)http://qpid.apache.org/docs/api/python/html/index.html Get your Questions Answered - Read the [FAQ|FAQ] - Ask a question on the user list mailto:users-subscribe@qpid.apache.org + Read the + Ask a question on the user listmailto:users-subscribe@qpid.apache.org -
 diff --git a/doc/book/src/How-to-Tune-M3-Java-Broker-Performance.xml b/doc/book/src/How-to-Tune-M3-Java-Broker-Performance.xml index 75eed5c452..9769a97031 100644 --- a/doc/book/src/How-to-Tune-M3-Java-Broker-Performance.xml +++ b/doc/book/src/How-to-Tune-M3-Java-Broker-Performance.xml @@ -1,4 +1,5 @@ + - - +
Apache Qpid : How to Tune M3 Java Broker Performance @@ -169,4 +169,4 @@
- +
diff --git a/doc/book/src/How-to-Use-JNDI.xml b/doc/book/src/How-to-Use-JNDI.xml index f4790af7f2..c1ebb03e6d 100644 --- a/doc/book/src/How-to-Use-JNDI.xml +++ b/doc/book/src/How-to-Use-JNDI.xml @@ -20,7 +20,7 @@ --> - + Apache Qpid : How to Use JNDI @@ -80,13 +80,13 @@ destination.direct = direct://amq.direct//directQueue The property file allows a number of queues to be defined that can then be discovered via JNDI. There are four properties used by the PFICFactory. - connectionfactory.<jndiname> this is the that the connection + connectionfactory.<jndiname> this is the that the connection factory will use to perform connections. queue.<jndiname> this defines a jms queue or in amqp a amq.direct exchange topic.<jndiname> this defines a jms topic or in amqp a amq.topic exchange - destination.<jndiname> this takes a + destination.<jndiname> this takes a and so can be used for defining all amq destinations, queues, topics and header matching. diff --git a/doc/book/src/Introduction.xml b/doc/book/src/Introduction.xml index d62f4fe6ac..8f92c207cf 100644 --- a/doc/book/src/Introduction.xml +++ b/doc/book/src/Introduction.xml @@ -1,4 +1,27 @@ + + + + Apache Qpid: Open Source AMQP Messaging Enterprise Messaging systems let programs communicate by exchanging messages, much as people communicate by exchanging email. Unlike email, enterprise messaging systems provide guaranteed delivery, speed, security, and freedom from spam. Until recently, there was no open standard for Enterprise Messaging systems, so programmers either wrote their own, or used expensive proprietary systems. diff --git a/doc/book/src/Java-Broker-Feature-Guide.xml b/doc/book/src/Java-Broker-Feature-Guide.xml index 394a864cd7..7f62b279d3 100644 --- a/doc/book/src/Java-Broker-Feature-Guide.xml +++ b/doc/book/src/Java-Broker-Feature-Guide.xml @@ -20,7 +20,7 @@ --> - +
Apache Qpid : Java Broker Feature Guide @@ -81,4 +81,4 @@
- + diff --git a/doc/book/src/Java-Environment-Variables.xml b/doc/book/src/Java-Environment-Variables.xml index 868ea470aa..129ec693fe 100644 --- a/doc/book/src/Java-Environment-Variables.xml +++ b/doc/book/src/Java-Environment-Variables.xml @@ -20,7 +20,7 @@ --> - +
Apache Qpid : Java Environment Variables @@ -81,4 +81,4 @@
- + diff --git a/doc/book/src/LVQ.xml b/doc/book/src/LVQ.xml index 5b7b4a2c9a..690f0f4718 100644 --- a/doc/book/src/LVQ.xml +++ b/doc/book/src/LVQ.xml @@ -1,5 +1,26 @@ - +<!-- + + 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><title> Apache Qpid : LVQ @@ -338,4 +359,4 @@ int main(int argc, char** argv) - + diff --git a/doc/book/src/Management-Console-Security.xml b/doc/book/src/Management-Console-Security.xml index 0c1e222115..cb3f9d09d7 100644 --- a/doc/book/src/Management-Console-Security.xml +++ b/doc/book/src/Management-Console-Security.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : Management Console Security
Management @@ -106,7 +106,7 @@ when starting the console. This can be done at the command line, or alternatively an example configuration has been made within the console's qpidmc.ini launcher configuration file that may - pre-configured in advance for repeated usage. See the <xref linkend="qpid_Qpid-20JMX-20Management-20Console-20User-20Guide"/> for more + pre-configured in advance for repeated usage. See the <xref linkend="Qpid-JMX-Management-Console-User-Guide"/> for more information on this configuration process. </para> <!--h3--></section> @@ -132,7 +132,7 @@ <para> More information on Java's handling of SSL certificate verification and customizing the keystores can be found in the - <xref linkend="qpid_JSSERefGuide"/> . + <ulink url="http://java.sun.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CustomizingStores">http://java.sun.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CustomizingStores</ulink>. </para> <!--h3--></section> <!--h2--></section> @@ -183,7 +183,7 @@ qpid-server -run:external-classpath=first </para> <!--h3--></section> - <section role="h3" id="ManagementConsoleSecurity-BrokerConfiguration"><title> + <section role="h3" id="ManagementConsoleSecurity-BrokerConfiguration2"><title> Broker Configuration @@ -209,7 +209,7 @@ qpid-server -run:external-classpath=first
-
+ <section role="h3" id="ManagementConsoleSecurity-JMXManagementConsoleConfiguration-2"><title> JMX Management Console Configuration @@ -243,10 +243,10 @@ qpid-server -run:external-classpath=first In order to access the management operations via JMX, users must have an account and have been assigned appropriate access rights. - See + See
- + diff --git a/doc/book/src/Management-Design-notes.xml b/doc/book/src/Management-Design-notes.xml index 07237c3ee2..46e13ac641 100644 --- a/doc/book/src/Management-Design-notes.xml +++ b/doc/book/src/Management-Design-notes.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : Management Design notes
Status @@ -35,7 +35,7 @@ </para><para> Development continues on the Qpid Management Framework (QMF) for M4. If you are using M3, this is the document you need. If you - are using the SVN trunk, please refer to <xref linkend="qpid_Qpid-20Management-20Framework"/> for + are using the SVN trunk, please refer to <xref linkend="qpid_Qpid-Management-Framework"/> for up-to-date information. </para> <!--h2--></section> @@ -70,7 +70,7 @@ - +
@@ -2132,5 +2132,5 @@ - + diff --git a/doc/book/src/Managing-CPP-Broker.xml b/doc/book/src/Managing-CPP-Broker.xml new file mode 100644 index 0000000000..2cb4def764 --- /dev/null +++ b/doc/book/src/Managing-CPP-Broker.xml @@ -0,0 +1,462 @@ + + + +
+ Managing the C++ Broker + + There are quite a few ways to interact with the C++ broker. The + command line tools + include: + + qpid-route - used to configure federation (a set of federated + brokers) + + qpid-config - used to configure queues, exchanges, bindings + and list them etc + + qpid-tool - used to view management information/statistics + and call any management actions on the broker + + qpid-printevents - used to receive and print QMF events + + + +
+ Using qpid-config + + + This utility can be used to create queues exchanges and bindings, + both durable and transient. Always check for latest options by + running --help command. + + +$ qpid-config --help +Usage: qpid-config [OPTIONS] + qpid-config [OPTIONS] exchanges [filter-string] + qpid-config [OPTIONS] queues [filter-string] + qpid-config [OPTIONS] add exchange <type> <name> [AddExchangeOptions] + qpid-config [OPTIONS] del exchange <name> + qpid-config [OPTIONS] add queue <name> [AddQueueOptions] + qpid-config [OPTIONS] del queue <name> + qpid-config [OPTIONS] bind <exchange-name> <queue-name> [binding-key] + qpid-config [OPTIONS] unbind <exchange-name> <queue-name> [binding-key] + +Options: + -b [ --bindings ] Show bindings in queue or exchange list + -a [ --broker-addr ] Address (localhost) Address of qpidd broker + broker-addr is in the form: [username/password@] hostname | ip-address [:<port>] + ex: localhost, 10.1.1.7:10000, broker-host:10000, guest/guest@localhost + +Add Queue Options: + --durable Queue is durable + --cluster-durable Queue becomes durable if there is only one functioning cluster node + --file-count N (8) Number of files in queue's persistence journal + --file-size N (24) File size in pages (64Kib/page) + --max-queue-size N Maximum in-memory queue size as bytes + --max-queue-count N Maximum in-memory queue size as a number of messages + --limit-policy [none | reject | flow-to-disk | ring | ring-strict] + Action taken when queue limit is reached: + none (default) - Use broker's default policy + reject - Reject enqueued messages + flow-to-disk - Page messages to disk + ring - Replace oldest unacquired message with new + ring-strict - Replace oldest message, reject if oldest is acquired + --order [fifo | lvq | lvq-no-browse] + Set queue ordering policy: + fifo (default) - First in, first out + lvq - Last Value Queue ordering, allows queue browsing + lvq-no-browse - Last Value Queue ordering, browsing clients may lose data + --generate-queue-events N + If set to 1, every enqueue will generate an event that can be processed by + registered listeners (e.g. for replication). If set to 2, events will be + generated for enqueues and dequeues + +Add Exchange Options: + --durable Exchange is durable + --sequence Exchange will insert a 'qpid.msg_sequence' field in the message header + with a value that increments for each message forwarded. + --ive Exchange will behave as an 'initial-value-exchange', keeping a reference + to the last message forwarded and enqueuing that message to newly bound + queues. + + + Get the summary page + + +$ qpid-config +Total Exchanges: 6 + topic: 2 + headers: 1 + fanout: 1 + direct: 2 + Total Queues: 7 + durable: 0 + non-durable: 7 + + + List the queues + + +$ qpid-config queues +Queue Name Attributes +================================================================= +pub_start +pub_done +sub_ready +sub_done +perftest0 --durable +reply-dhcp-100-18-254.bos.redhat.com.20713 auto-del excl +topic-dhcp-100-18-254.bos.redhat.com.20713 auto-del excl + + + + List the exchanges with bindings + + +$ ./qpid-config -b exchanges +Exchange '' (direct) + bind pub_start => pub_start + bind pub_done => pub_done + bind sub_ready => sub_ready + bind sub_done => sub_done + bind perftest0 => perftest0 + bind mgmt-3206ff16-fb29-4a30-82ea-e76f50dd7d15 => mgmt-3206ff16-fb29-4a30-82ea-e76f50dd7d15 + bind repl-3206ff16-fb29-4a30-82ea-e76f50dd7d15 => repl-3206ff16-fb29-4a30-82ea-e76f50dd7d15 +Exchange 'amq.direct' (direct) + bind repl-3206ff16-fb29-4a30-82ea-e76f50dd7d15 => repl-3206ff16-fb29-4a30-82ea-e76f50dd7d15 + bind repl-df06c7a6-4ce7-426a-9f66-da91a2a6a837 => repl-df06c7a6-4ce7-426a-9f66-da91a2a6a837 + bind repl-c55915c2-2fda-43ee-9410-b1c1cbb3e4ae => repl-c55915c2-2fda-43ee-9410-b1c1cbb3e4ae +Exchange 'amq.topic' (topic) +Exchange 'amq.fanout' (fanout) +Exchange 'amq.match' (headers) +Exchange 'qpid.management' (topic) + bind mgmt.# => mgmt-3206ff16-fb29-4a30-82ea-e76f50dd7d15 + +
+ +
+ Using qpid-route + + + This utility is to create federated networks of brokers, This + allows you for forward messages between brokers in a network. + Messages can be routed statically (using "qpid-route route add") + where the bindings that control message forwarding are supplied + in the route. Message routing can also be dynamic (using + "qpid-route dynamic add") where the messages are automatically + forwarded to clients based on their bindings to the local broker. + + +$ qpid-route +Usage: qpid-route [OPTIONS] dynamic add <dest-broker> <src-broker> <exchange> [tag] [exclude-list] + qpid-route [OPTIONS] dynamic del <dest-broker> <src-broker> <exchange> + + qpid-route [OPTIONS] route add <dest-broker> <src-broker> <exchange> <routing-key> [tag] [exclude-list] + qpid-route [OPTIONS] route del <dest-broker> <src-broker> <exchange> <routing-key> + qpid-route [OPTIONS] queue add <dest-broker> <src-broker> <exchange> <queue> + qpid-route [OPTIONS] queue del <dest-broker> <src-broker> <exchange> <queue> + qpid-route [OPTIONS] route list [<dest-broker>] + qpid-route [OPTIONS] route flush [<dest-broker>] + qpid-route [OPTIONS] route map [<broker>] + + qpid-route [OPTIONS] link add <dest-broker> <src-broker> + qpid-route [OPTIONS] link del <dest-broker> <src-broker> + qpid-route [OPTIONS] link list [<dest-broker>] + +Options: + -v [ --verbose ] Verbose output + -q [ --quiet ] Quiet output, don't print duplicate warnings + -d [ --durable ] Added configuration shall be durable + -e [ --del-empty-link ] Delete link after deleting last route on the link + -s [ --src-local ] Make connection to source broker (push route) + -t <transport> [ --transport <transport>] + Specify transport to use for links, defaults to tcp + + dest-broker and src-broker are in the form: [username/password@] hostname | ip-address [:<port>] + ex: localhost, 10.1.1.7:10000, broker-host:10000, guest/guest@localhost + + + A few examples: + + +qpid-route dynamic add host1 host2 fed.topic +qpid-route dynamic add host2 host1 fed.topic + +qpid-route -v route add host1 host2 hub1.topic hub2.topic.stock.buy +qpid-route -v route add host1 host2 hub1.topic hub2.topic.stock.sell +qpid-route -v route add host1 host2 hub1.topic 'hub2.topic.stock.#' +qpid-route -v route add host1 host2 hub1.topic 'hub2.#' +qpid-route -v route add host1 host2 hub1.topic 'hub2.topic.#' +qpid-route -v route add host1 host2 hub1.topic 'hub2.global.#' + + + The link map feature can be used to display the entire federated + network configuration by supplying a single broker as an entry + point: + + +$ qpid-route route map localhost:10001 + +Finding Linked Brokers: + localhost:10001... Ok + localhost:10002... Ok + localhost:10003... Ok + localhost:10004... Ok + localhost:10005... Ok + localhost:10006... Ok + localhost:10007... Ok + localhost:10008... Ok + +Dynamic Routes: + + Exchange fed.topic: + localhost:10002 <=> localhost:10001 + localhost:10003 <=> localhost:10002 + localhost:10004 <=> localhost:10002 + localhost:10005 <=> localhost:10002 + localhost:10006 <=> localhost:10005 + localhost:10007 <=> localhost:10006 + localhost:10008 <=> localhost:10006 + + Exchange fed.direct: + localhost:10002 => localhost:10001 + localhost:10004 => localhost:10003 + localhost:10003 => localhost:10002 + localhost:10001 => localhost:10004 + +Static Routes: + + localhost:10003(ex=amq.direct) <= localhost:10005(ex=amq.direct) key=rkey + localhost:10003(ex=amq.direct) <= localhost:10005(ex=amq.direct) key=rkey2 + +
+ +
+ Using qpid-tool + + + This utility provided a telnet style interface to be able to + view, list all stats and action + all the methods. Simple capture below. Best to just play with it + and mail the list if you have + questions or want features added. + + +qpid: +qpid: help +Management Tool for QPID +Commands: + list - Print summary of existing objects by class + list <className> - Print list of objects of the specified class + list <className> all - Print contents of all objects of specified class + list <className> active - Print contents of all non-deleted objects of specified class + list <list-of-IDs> - Print contents of one or more objects (infer className) + list <className> <list-of-IDs> - Print contents of one or more objects + list is space-separated, ranges may be specified (i.e. 1004-1010) + call <ID> <methodName> <args> - Invoke a method on an object + schema - Print summary of object classes seen on the target + schema <className> - Print details of an object class + set time-format short - Select short timestamp format (default) + set time-format long - Select long timestamp format + quit or ^D - Exit the program +qpid: list +Management Object Types: + ObjectType Active Deleted + ================================ + qpid.binding 21 0 + qpid.broker 1 0 + qpid.client 1 0 + qpid.exchange 6 0 + qpid.queue 13 0 + qpid.session 4 0 + qpid.system 1 0 + qpid.vhost 1 0 +qpid: list qpid.system +Objects of type qpid.system + ID Created Destroyed Index + ================================== + 1000 21:00:02 - host +qpid: list 1000 +Object of type qpid.system: (last sample time: 21:26:02) + Type Element 1000 + ======================================================= + config sysId host + config osName Linux + config nodeName localhost.localdomain + config release 2.6.24.4-64.fc8 + config version #1 SMP Sat Mar 29 09:15:49 EDT 2008 + config machine x86_64 +qpid: schema queue +Schema for class 'qpid.queue': + Element Type Unit Access Notes Description + =================================================================================================================== + vhostRef reference ReadCreate index + name short-string ReadCreate index + durable boolean ReadCreate + autoDelete boolean ReadCreate + exclusive boolean ReadCreate + arguments field-table ReadOnly Arguments supplied in queue.declare + storeRef reference ReadOnly Reference to persistent queue (if durable) + msgTotalEnqueues uint64 message Total messages enqueued + msgTotalDequeues uint64 message Total messages dequeued + msgTxnEnqueues uint64 message Transactional messages enqueued + msgTxnDequeues uint64 message Transactional messages dequeued + msgPersistEnqueues uint64 message Persistent messages enqueued + msgPersistDequeues uint64 message Persistent messages dequeued + msgDepth uint32 message Current size of queue in messages + msgDepthHigh uint32 message Current size of queue in messages (High) + msgDepthLow uint32 message Current size of queue in messages (Low) + byteTotalEnqueues uint64 octet Total messages enqueued + byteTotalDequeues uint64 octet Total messages dequeued + byteTxnEnqueues uint64 octet Transactional messages enqueued + byteTxnDequeues uint64 octet Transactional messages dequeued + bytePersistEnqueues uint64 octet Persistent messages enqueued + bytePersistDequeues uint64 octet Persistent messages dequeued + byteDepth uint32 octet Current size of queue in bytes + byteDepthHigh uint32 octet Current size of queue in bytes (High) + byteDepthLow uint32 octet Current size of queue in bytes (Low) + enqueueTxnStarts uint64 transaction Total enqueue transactions started + enqueueTxnCommits uint64 transaction Total enqueue transactions committed + enqueueTxnRejects uint64 transaction Total enqueue transactions rejected + enqueueTxnCount uint32 transaction Current pending enqueue transactions + enqueueTxnCountHigh uint32 transaction Current pending enqueue transactions (High) + enqueueTxnCountLow uint32 transaction Current pending enqueue transactions (Low) + dequeueTxnStarts uint64 transaction Total dequeue transactions started + dequeueTxnCommits uint64 transaction Total dequeue transactions committed + dequeueTxnRejects uint64 transaction Total dequeue transactions rejected + dequeueTxnCount uint32 transaction Current pending dequeue transactions + dequeueTxnCountHigh uint32 transaction Current pending dequeue transactions (High) + dequeueTxnCountLow uint32 transaction Current pending dequeue transactions (Low) + consumers uint32 consumer Current consumers on queue + consumersHigh uint32 consumer Current consumers on queue (High) + consumersLow uint32 consumer Current consumers on queue (Low) + bindings uint32 binding Current bindings + bindingsHigh uint32 binding Current bindings (High) + bindingsLow uint32 binding Current bindings (Low) + unackedMessages uint32 message Messages consumed but not yet acked + unackedMessagesHigh uint32 message Messages consumed but not yet acked (High) + unackedMessagesLow uint32 message Messages consumed but not yet acked (Low) + messageLatencySamples delta-time nanosecond Broker latency through this queue (Samples) + messageLatencyMin delta-time nanosecond Broker latency through this queue (Min) + messageLatencyMax delta-time nanosecond Broker latency through this queue (Max) + messageLatencyAverage delta-time nanosecond Broker latency through this queue (Average) +Method 'purge' Discard all messages on queue +qpid: list queue +Objects of type qpid.queue + ID Created Destroyed Index + =========================================================================== + 1012 21:08:13 - 1002.pub_start + 1014 21:08:13 - 1002.pub_done + 1016 21:08:13 - 1002.sub_ready + 1018 21:08:13 - 1002.sub_done + 1020 21:08:13 - 1002.perftest0 + 1038 21:09:08 - 1002.mgmt-3206ff16-fb29-4a30-82ea-e76f50dd7d15 + 1040 21:09:08 - 1002.repl-3206ff16-fb29-4a30-82ea-e76f50dd7d15 + 1046 21:09:32 - 1002.mgmt-df06c7a6-4ce7-426a-9f66-da91a2a6a837 + 1048 21:09:32 - 1002.repl-df06c7a6-4ce7-426a-9f66-da91a2a6a837 + 1054 21:10:01 - 1002.mgmt-c55915c2-2fda-43ee-9410-b1c1cbb3e4ae + 1056 21:10:01 - 1002.repl-c55915c2-2fda-43ee-9410-b1c1cbb3e4ae + 1063 21:26:00 - 1002.mgmt-8d621997-6356-48c3-acab-76a37081d0f3 + 1065 21:26:00 - 1002.repl-8d621997-6356-48c3-acab-76a37081d0f3 +qpid: list 1020 +Object of type qpid.queue: (last sample time: 21:26:02) + Type Element 1020 + ========================================================================== + config vhostRef 1002 + config name perftest0 + config durable False + config autoDelete False + config exclusive False + config arguments {'qpid.max_size': 0, 'qpid.max_count': 0} + config storeRef NULL + inst msgTotalEnqueues 500000 messages + inst msgTotalDequeues 500000 + inst msgTxnEnqueues 0 + inst msgTxnDequeues 0 + inst msgPersistEnqueues 0 + inst msgPersistDequeues 0 + inst msgDepth 0 + inst msgDepthHigh 0 + inst msgDepthLow 0 + inst byteTotalEnqueues 512000000 octets + inst byteTotalDequeues 512000000 + inst byteTxnEnqueues 0 + inst byteTxnDequeues 0 + inst bytePersistEnqueues 0 + inst bytePersistDequeues 0 + inst byteDepth 0 + inst byteDepthHigh 0 + inst byteDepthLow 0 + inst enqueueTxnStarts 0 transactions + inst enqueueTxnCommits 0 + inst enqueueTxnRejects 0 + inst enqueueTxnCount 0 + inst enqueueTxnCountHigh 0 + inst enqueueTxnCountLow 0 + inst dequeueTxnStarts 0 + inst dequeueTxnCommits 0 + inst dequeueTxnRejects 0 + inst dequeueTxnCount 0 + inst dequeueTxnCountHigh 0 + inst dequeueTxnCountLow 0 + inst consumers 0 consumers + inst consumersHigh 0 + inst consumersLow 0 + inst bindings 1 binding + inst bindingsHigh 1 + inst bindingsLow 1 + inst unackedMessages 0 messages + inst unackedMessagesHigh 0 + inst unackedMessagesLow 0 + inst messageLatencySamples 0 + inst messageLatencyMin 0 + inst messageLatencyMax 0 + inst messageLatencyAverage 0 +qpid: + +
+ +
+ Using + qpid-printevents + + + This utility connects to one or more brokers and collects events, + printing out a line per event. + + +$ qpid-printevents --help +Usage: qpid-printevents [options] [broker-addr]... + +Collect and print events from one or more Qpid message brokers. If no broker- +addr is supplied, qpid-printevents will connect to 'localhost:5672'. broker- +addr is of the form: [username/password@] hostname | ip-address [:<port>] ex: +localhost, 10.1.1.7:10000, broker-host:10000, guest/guest@localhost + +Options: + -h, --help show this help message and exit + + + You get the idea... have fun! + +
+
diff --git a/doc/book/src/MessageStore-Tool.xml b/doc/book/src/MessageStore-Tool.xml index c858ce6408..404018e714 100644 --- a/doc/book/src/MessageStore-Tool.xml +++ b/doc/book/src/MessageStore-Tool.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : MessageStore Tool
MessageStore Tool @@ -39,7 +39,7 @@ <itemizedlist> <listitem><para> - <xref linkend="qpid_BDBMessageStore-20-3rd-20Party-"/> + <xref linkend="qpid_BDBMessageStore--3rd-Party-"/> </para></listitem> <listitem><para> <xref linkend="qpid_JDBCStore"/> @@ -147,4 +147,4 @@ bdb$ </para> <!--h3--></section> <!--h2--></section> -</chapter> +</section> diff --git a/doc/book/src/NET-User-Guide.xml b/doc/book/src/NET-User-Guide.xml index 428e14377c..7bfa20b8c8 100644 --- a/doc/book/src/NET-User-Guide.xml +++ b/doc/book/src/NET-User-Guide.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"> +<section> <title> Apache Qpid: Open Source AMQP Messaging - .NET User Guide @@ -1024,7 +1024,7 @@ noMoreMessages(session);
-
+
Reading Messages from the Queue @@ -1380,4 +1380,4 @@ _session.messageTransfer("amq.direct", routingKey, response); </section> - </chapter> + </section> diff --git a/doc/book/src/PythonBrokerTest.xml b/doc/book/src/PythonBrokerTest.xml index 3d72023fef..218738f3a8 100644 --- a/doc/book/src/PythonBrokerTest.xml +++ b/doc/book/src/PythonBrokerTest.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"> +<section> <title> Apache Qpid : PythonBrokerTest @@ -95,4 +95,4 @@
- +
diff --git a/doc/book/src/QMF-Python-Console-Tutorial.xml b/doc/book/src/QMF-Python-Console-Tutorial.xml index 00ab12b4a1..71e681c356 100644 --- a/doc/book/src/QMF-Python-Console-Tutorial.xml +++ b/doc/book/src/QMF-Python-Console-Tutorial.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : QMF Python Console Tutorial @@ -84,7 +84,7 @@ network. Qpid can be downloaded as source from Apache, is packaged with a number of Linux distributions, and can be purchased from commercial vendors that use Qpid. Please see - for + for information as to where to get Qpid Messaging. Qpid Messaging includes a message broker (qpidd) which typically @@ -891,4 +891,4 @@ sess.bindClass("org.apache.qpid.broker", "queue") - + diff --git a/doc/book/src/QMan-Qpid-Management-bridge.xml b/doc/book/src/QMan-Qpid-Management-bridge.xml index 6cce51da6f..b64239abf2 100644 --- a/doc/book/src/QMan-Qpid-Management-bridge.xml +++ b/doc/book/src/QMan-Qpid-Management-bridge.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : QMan - Qpid Management bridge
QMan @@ -76,7 +76,7 @@ </row> <row> <entry> - <xref linkend="qpid_Get-20me-20up-20and-20running"/> + <xref linkend="qpid_Get-me-up-and-running"/> </entry> <entry> How to install & start QMan. @@ -84,7 +84,7 @@ </row> <row> <entry> - <xref linkend="qpid_QMan-20User-20Guide"/> + <xref linkend="qpid_QMan-User-Guide"/> </entry> <entry> QMan (WS-DM version only) Administration Console. @@ -92,7 +92,7 @@ </row> <row> <entry> - <xref linkend="qpid_JMX-20Interface-20Specification"/> + <xref linkend="qpid_JMX-Interface-Specification"/> </entry> <entry> Describes each JMX interface exposed by QMan. @@ -100,7 +100,7 @@ </row> <row> <entry> - <xref linkend="qpid_WS-DM-20Interface-20Specification"/> + <xref linkend="qpid_WS-DM-Interface-Specification"/> </entry> <entry> Describes each WS-DM interface exposed by QMan. @@ -108,7 +108,7 @@ </row> <row> <entry> - <xref linkend="qpid_QMan-20Messages-20Catalogue"/> + <xref linkend="qpid_QMan-Messages-Catalogue"/> </entry> <entry> Informational / Debug / Error / Warning messages catalogue. @@ -142,7 +142,7 @@ </row> <row> <entry> - <xref linkend="qpid_QMan-20System-20Overview"/> + <xref linkend="qpid_QMan-System-Overview"/> </entry> <entry> A short introduction about QMan deployment context. @@ -150,7 +150,7 @@ </row> <row> <entry> - <xref linkend="qpid_QMan-20Components-20View"/> + <xref linkend="qpid_QMan-Components-View"/> </entry> <entry> Describes QMan components, their interactions and @@ -163,4 +163,4 @@ <!--h2--></section> <!--h1--></section> -</chapter> +</section> diff --git a/doc/book/src/Qpid-Interoperability-Documentation.xml b/doc/book/src/Qpid-Interoperability-Documentation.xml index c67759a335..1bd07dca33 100644 --- a/doc/book/src/Qpid-Interoperability-Documentation.xml +++ b/doc/book/src/Qpid-Interoperability-Documentation.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"><title> +<chapter><title> Apache Qpid : Qpid Interoperability Documentation
Qpid Interoperability Documentation @@ -235,12 +235,14 @@ </entry> </row> </tbody> - </tgroup></table><para> - + </tgroup></table> + + <para id="QpidInteroperabilityDocumentation-1"> 1: Support for these will be in M3 (currently available on trunk). + </para> - 2: C++ Broker uses <xref linkend="qpid_"/> which + <para id="QpidInteroperabilityDocumentation-2">2: C++ Broker uses <ulink url="http://freshmeat.net/projects/cyrussasl/">Cyrus SASL</ulink> which supports CRAM-MD5 and GSSAPI but these have not been tested yet </para> <!--h4--></section> diff --git a/doc/book/src/Qpid-JMX-Management-Console-FAQ.xml b/doc/book/src/Qpid-JMX-Management-Console-FAQ.xml index 9f1fdf34ac..88f80999d4 100644 --- a/doc/book/src/Qpid-JMX-Management-Console-FAQ.xml +++ b/doc/book/src/Qpid-JMX-Management-Console-FAQ.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"><title> +<section><title> Apache Qpid : Qpid JMX Management Console FAQ
@@ -93,4 +93,4 @@ To remedy this issue you can set the _java.rmi.server.hostname_ system property
- + diff --git a/doc/book/src/Qpid-JMX-Management-Console-User-Guide.xml b/doc/book/src/Qpid-JMX-Management-Console-User-Guide.xml index 3d309d8831..8143ec4e28 100644 --- a/doc/book/src/Qpid-JMX-Management-Console-User-Guide.xml +++ b/doc/book/src/Qpid-JMX-Management-Console-User-Guide.xml @@ -20,7 +20,7 @@ --> - +<section id="Qpid-JMX-Management-Console-User-Guide"><title> Apache Qpid : Qpid JMX Management Console User Guide
Qpid JMX Management Console User Guide @@ -105,7 +105,8 @@ KeyStore and matching TrustStore. This script can serve as a guide on how to use the Java Keytool security utility to manipulate your own stores, and more information can be found in - the JSSE Reference Guide: <xref linkend="qpid_JSSERefGuide"/> + the JSSE Reference Guide: + <ulink url="http://java.sun.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CustomizingStores">http://java.sun.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CustomizingStores</ulink>. </para><para> Supplying the necessary details to the console is performed by setting the <emphasis>javax.net.ssl.trustStore</emphasis> and @@ -789,4 +790,4 @@ </para> <!--h1--></section> -</chapter> +</section> diff --git a/doc/book/src/Qpid-JMX-Management-Console.xml b/doc/book/src/Qpid-JMX-Management-Console.xml index 8503484f91..c6f471a280 100644 --- a/doc/book/src/Qpid-JMX-Management-Console.xml +++ b/doc/book/src/Qpid-JMX-Management-Console.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"> +<chapter id="Qpid-JMX-Management-Console"> <title> Apache Qpid : Qpid JMX Management Console @@ -42,12 +42,12 @@ JMX. </para> - <xi:include href="Configuring%20Management%20Users.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="Configuring%20Qpid%20JMX%20Management%20Console.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="Management%20Console%20Security.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="Qpid%20JMX%20Management%20Console%20FAQ.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="Qpid%20JMX%20Management%20Console%20User%20Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="Qpid%20Management%20Features.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="Configuring-Management-Users.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="Configuring-Qpid-JMX-Management-Console.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="Management-Console-Security.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="Qpid-JMX-Management-Console-FAQ.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="Qpid-JMX-Management-Console-User-Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="Qpid-Management-Features.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <!--h3--></section> <!--h2--></section> </chapter> diff --git a/doc/book/src/Qpid-Java-Broker-Management-CLI.xml b/doc/book/src/Qpid-Java-Broker-Management-CLI.xml index 5c670bb22f..8d6c9aaa8e 100644 --- a/doc/book/src/Qpid-Java-Broker-Management-CLI.xml +++ b/doc/book/src/Qpid-Java-Broker-Management-CLI.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"><title> +<section><title> Apache Qpid : Qpid Java Broker Management CLI
@@ -156,4 +156,4 @@ ant compile-tests <!--h3--></section> <!--h2--></section> -</chapter> +</section> diff --git a/doc/book/src/Qpid-Java-Build-How-To.xml b/doc/book/src/Qpid-Java-Build-How-To.xml index 8ea8b4c2db..ffb25093ea 100644 --- a/doc/book/src/Qpid-Java-Build-How-To.xml +++ b/doc/book/src/Qpid-Java-Build-How-To.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"><title> +<section><title> Apache Qpid : Qpid Java Build How To @@ -353,7 +353,7 @@ for i in `find . -name build.xml` ; do echo "$i:"; grep module.depends $i ; done What next ? - If you want to run your built Qpid package, see our for details of + If you want to run your built Qpid package, see our for details of how to do that. If you want to run our tests, you can use the ant test or @@ -362,4 +362,4 @@ for i in `find . -name build.xml` ; do echo "$i:"; grep module.depends $i ; done
- + diff --git a/doc/book/src/Qpid-Java-FAQ.xml b/doc/book/src/Qpid-Java-FAQ.xml index 181b0a3fcc..ec255dacea 100644 --- a/doc/book/src/Qpid-Java-FAQ.xml +++ b/doc/book/src/Qpid-Java-FAQ.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : Qpid Java FAQ @@ -55,7 +55,7 @@ Persistence using the high performance Berkeley DB Java Edition. The persistence layer is also pluggable should an alternative implementation be required. The BDB store is - available from the page + available from the page Pluggable security using SASL. Any Java SASL provider can be used @@ -168,7 +168,7 @@ at org.apache.qpid.server.security.auth.database.ConfigurationFilePrincipalDatab manifest files to your classpath. For more information on running the broker please see our - page. + page. @@ -178,7 +178,7 @@ at org.apache.qpid.server.security.auth.database.ConfigurationFilePrincipalDatab - Please see the documentation. + Please see the documentation. @@ -203,7 +203,7 @@ at org.apache.qpid.server.security.auth.database.ConfigurationFilePrincipalDatab Queue names may consist of any mixture of digits, letters, and underscores. - The is described in more + The is described in more detail on it's own page. @@ -252,7 +252,7 @@ at org.apache.qpid.server.security.auth.database.ConfigurationFilePrincipalDatab - see + see @@ -262,8 +262,10 @@ at org.apache.qpid.server.security.auth.database.ConfigurationFilePrincipalDatab - Here is a donated Spring configuration file which shows the - config for Qpid side by side with Weblogic. HtH ! + Here is a donated Spring configuration file appContext.zip + which shows the config for Qpid side by side with + Weblogic. HtH ! @@ -323,13 +325,13 @@ amqj.logging.level qpid-server -c <your_config_file's_path> For more detailed information on configuration, please see - + -
+ <section role="h3" id="QpidJavaFAQ-Whatportsdoesthebrokeruse"><title> What ports does the broker use? @@ -371,7 +373,7 @@ amqj.logging.level For additional details on what ports the broker uses see FAQ entry. For more detailed information on configuration, please see - +
@@ -586,7 +588,7 @@ amqj.logging.level There are a number of tuning options available, please see the - page for more information. + page for more information. @@ -678,12 +680,12 @@ amqj.logging.level For general questions, please subscribe to the - users@qpid.apache.org mailing list (). + users@qpid.apache.org mailing list. For development questions, please subscribe to the - dev@qpid.apache.org mailing list (). + dev@qpid.apache.org mailing list. - More details on these lists are available on our + More details on these lists are available on our page. @@ -693,7 +695,7 @@ amqj.logging.level - You can do this via the . To + You can do this via the . To do this simply log in to the management console as an admin user (you need to have created an admin account in the jmxremote.access file first) and then select the 'UserManagement' @@ -705,7 +707,7 @@ amqj.logging.level to be disconnected if they are already connected. For more information on the Management Console please see our - + @@ -740,14 +742,15 @@ amqj.logging.level - I would take a look at the testPassiveTTL in + I would take a look at the testPassiveTTL in + TimeToLiveTest.java The setUp and tearDown methods show how to correctly start up a broker for InVM testing. If you write your tests using a file for the JNDI you can then very easily swap between running your tests InVM and against a real broker. - See our on how to confgure it + See our on how to confgure it Basically though you just need to set two System Properites: @@ -771,10 +774,10 @@ amqj.logging.level There are two possibilities here: 1) The management console can be used to interogate an active - broker and browse the contents of a queue.See the + broker and browse the contents of a queue.See the page for further details. - 2) The can be used to inspect + 2) The can be used to inspect the contents of a persistent message store. Note: this can currently only be used when the broker is offline. @@ -821,7 +824,7 @@ amqj.logging.level You may also want to increase the memory allowance to the broker though this will only delay the exception if you are publishing - messages faster than you are consuming. See for + messages faster than you are consuming. See for details of changing the memory settings. @@ -899,7 +902,7 @@ java.lang.NullPointerException You have not configured the console's SSL trust store properly, - see for + see for more details. @@ -923,7 +926,7 @@ java.lang.NullPointerException Transfer accross the network and b) to be fully written to disk. These situations require that the default timeout value be - increased. A cilent 'amqj.default_syncwrite_timeout' can be set + increased. A cilent 'amqj.default_syncwrite_timeout' can be set on the client to increase the wait time. The default in 0.5 is 30000 (30s). @@ -935,7 +938,7 @@ java.lang.NullPointerException - See + See @@ -943,4 +946,4 @@ java.lang.NullPointerException - + diff --git a/doc/book/src/Qpid-Management-Features.xml b/doc/book/src/Qpid-Management-Features.xml index 2fb84ff291..c42f28c270 100644 --- a/doc/book/src/Qpid-Management-Features.xml +++ b/doc/book/src/Qpid-Management-Features.xml @@ -20,12 +20,12 @@ --> - +
Apache Qpid : Qpid Management Features - Management tool: See our for + Management tool: See our for details of how to use various console options with the Qpid management features. @@ -152,7 +152,7 @@ Dropping a connection. - The work for implies that + The work for implies that there are potentially some additional requirements Alert when tcp flow control kicks in @@ -179,8 +179,7 @@ Creating a Queue. - Deleting a - Queue.         + Deleting a Queue. - +
diff --git a/doc/book/src/Qpid-Management-Framework.xml b/doc/book/src/Qpid-Management-Framework.xml index f82be57317..8afd391e13 100644 --- a/doc/book/src/Qpid-Management-Framework.xml +++ b/doc/book/src/Qpid-Management-Framework.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : Qpid Management Framework @@ -58,7 +58,7 @@ - Please visit the for information + Please visit the for information about the future of QMF.
@@ -915,10 +915,10 @@ one another. </para><para> A description of the current version of the QMF protocol can be - found at <xref linkend="qpid_QMF-20Protocol"/>. + found at <xref linkend="qpid_QMF-Protocol"/>. </para><para> A proposal for an updated protocol based on map-messages is in - progress and can be found at <xref linkend="qpid_QMF-20Map-20Message-20Protocol"/>. + progress and can be found at <xref linkend="qpid_QMF-Map-Message-Protocol"/>. </para> <!--h1--></section> @@ -928,7 +928,7 @@ - Please see the for information about using the console API with + Please see the for information about using the console API with Python.
@@ -941,4 +941,4 @@ - + diff --git a/doc/book/src/Qpid-Troubleshooting-Guide.xml b/doc/book/src/Qpid-Troubleshooting-Guide.xml index 12cbd7ed25..86b0f5fa64 100644 --- a/doc/book/src/Qpid-Troubleshooting-Guide.xml +++ b/doc/book/src/Qpid-Troubleshooting-Guide.xml @@ -20,7 +20,7 @@ --> - +
Apache Qpid : Qpid Troubleshooting Guide @@ -149,8 +149,8 @@ should always be created at broker startup. If you don't want to use this config, then simply ensure that you consume first from queue before staring to publish to it. See the entry on our - <xref linkend="qpid_Qpid-20Java-20FAQ"/> for more details of using the virtualhosts.xml route. + <xref linkend="qpid_Qpid-Java-FAQ"/> for more details of using the virtualhosts.xml route. </para> <!--h2--></section> -</chapter> +</section> diff --git a/doc/book/src/RASC.xml b/doc/book/src/RASC.xml deleted file mode 100644 index 84a76ebff3..0000000000 --- a/doc/book/src/RASC.xml +++ /dev/null @@ -1,327 +0,0 @@ -<?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. - ---> - -<chapter xmlns:html="http://www.w3.org/1999/xhtml"><title> - Apache Qpid : RASC - - -
- Building the - C++ Broker and Client Libraries - - - The root directory for the C++ distribution is named - qpidc-0.4. The README file in that directory gives - instructions for building the broker and client libraries. In - most cases you will do the following: - - -[qpidc-0.4]$ ./configure}} -[qpidc-0.4]$ make - -
-
- Running the C++ Broker - - - Once you have built the broker and client libraries, you can - start the broker from the command line: - - -[qpidc-0.4]$ src/qpidd - - - Use the --daemon option to run the broker as a daemon - process: - - -[qpidc-0.4]$ src/qpidd --daemon - - - You can stop a running daemon with the --quit option: - - -[qpidc-0.4]$ src/qpidd --quit - - - You can see all available options with the --help option - - -[qpidc-0.4]$ src/qpidd --help - -
-
- Most - common questions getting qpidd running - -
- Error - when starting broker: "no data directory" - - - The qpidd broker requires you to set a data directory or specify - --no-data-dir (see help for more details). The data - directory is used for the journal, so it is important when - reliability counts. Make sure your process has write permission - to the data directory. - - The default location is - - -/lib/var/qpidd - - - An alternate location can be set with --data-dir - -
-
- Error - when starting broker: "that process is locked" - - - Note that when qpidd starts it creates a lock file is data - directory are being used. If you have a un-controlled exit, - please mail - the trace from the core to the dev@qpid.apache.org mailing list. - To clear the lock run - - -./qpidd -q - - - It should also be noted that multiple brokers can be run on the - same host. To do so set alternate data directories for each qpidd - instance. - -
-
- Using a configuration - file - - - Each option that can be specified on the command line can also be - specified in a configuration file. To see available options, use - --help on the command line: - - -./qpidd --help - - - A configuration file uses name/value pairs, one on each line. To - convert a command line option to a configuration file entry: - - a.) remove the '--' from the beginning of the option. - b.) place a '=' between the option and the value (use - yes or true to enable options that take no - value when specified on the command line). - c.) place one option per line. - - For instance, the --daemon option takes no value, the - --log-to-syslog option takes the values yes or - no. The following configuration file sets these two - options: - - -daemon=yes -log-to-syslog=yes - -
-
- Can I use - any Language client with the C++ Broker? - - - Yes, all the clients work with the C++ broker; it is written in - C+, but uses the AMQP wire protocol. Any broker can be used - with any client that uses the same AMQP version. When running the - C+ broker, it is highly recommended to run AMQP 0-10. - - Note that JMS also works with the C++ broker. For more details on - using the Java client refer to these pages: - - - - - - - - - - - -
-
-
- Authentication - -
- Linux - - - The PLAIN authentication is done on a username+password, which is - stored in the sasldb_path file. Usernames and passwords can be - added to the file using the command: - - -saslpasswd2 -f /var/lib/qpidd/qpidd.sasldb -u <REALM> <USER> - - - The REALM is important and should be the same as the - --auth-realm - option to the broker. This lets the broker properly find the user - in - the sasldb file. - - Existing user accounts may be listed with: - - -sasldblistusers2 -f /var/lib/qpidd/qpidd.sasldb - - - NOTE: The sasldb file must be readable by the user running the - qpidd daemon, and should be readable only by that user. - -
-
- Windows - - - On Windows, the users are authenticated against the local - machine. You should add the appropriate users using the standard - Windows tools (Control Panel->User Accounts). To run many of - the examples, you will need to create a user "guest" with - password "guest". - - If you cannot or do not want to create new users, you can run - without authentication by specifying the no-auth option to the - broker. - -
-
- -
- Slightly more - complex configuration - - - The easiest way to get a full listing of the broker's options are - to use the --help command, run it locally for the latest set of - options. These options can then be set in the conf file for - convenience (see above) - - -./qpidd --help - -Usage: qpidd OPTIONS -Options: - -h [ --help ] Displays the help message - -v [ --version ] Displays version information - --config FILE (/etc/qpidd.conf) Reads configuration from FILE - -Module options: - --module-dir DIR (/usr/lib/qpidd) Load all .so modules in this directory - --load-module FILE Specifies additional module(s) to be loaded - --no-module-dir Don't load modules from module directory - -Broker Options: - --data-dir DIR (/var/lib/qpidd) Directory to contain persistent data generated by the broker - --no-data-dir Don't use a data directory. No persistent - configuration will be loaded or stored - -p [ --port ] PORT (5672) Tells the broker to listen on PORT - --worker-threads N (3) Sets the broker thread pool size - --max-connections N (500) Sets the maximum allowed connections - --connection-backlog N (10) Sets the connection backlog limit for the - server socket - --staging-threshold N (5000000) Stages messages over N bytes to disk - -m [ --mgmt-enable ] yes|no (1) Enable Management - --mgmt-pub-interval SECONDS (10) Management Publish Interval - --ack N (0) Send session.ack/solicit-ack at least every - N frames. 0 disables voluntary ack/solitict - -ack - -Daemon options: - -d [ --daemon ] Run as a daemon. - -w [ --wait ] SECONDS (10) Sets the maximum wait time to initialize the - daemon. If the daemon fails to initialize, prints - an error and returns 1 - -c [ --check ] Prints the daemon's process ID to stdout and - returns 0 if the daemon is running, otherwise - returns 1 - -q [ --quit ] Tells the daemon to shut down -Logging options: - --log-output FILE (stderr) Send log output to FILE. FILE can be a file name - or one of the special values: - stderr, stdout, syslog - -t [ --trace ] Enables all logging - --log-enable RULE (error+) Enables logging for selected levels and component - s. RULE is in the form 'LEVEL+:PATTERN' - Levels are one of: - trace debug info notice warning error critical - For example: - '--log-enable warning+' logs all warning, error - and critical messages. - '--log-enable debug:framing' logs debug messages - from the framing namespace. This option can be - used multiple times - --log-time yes|no (1) Include time in log messages - --log-level yes|no (1) Include severity level in log messages - --log-source yes|no (0) Include source file:line in log messages - --log-thread yes|no (0) Include thread ID in log messages - --log-function yes|no (0) Include function signature in log messages - -
-
- Loading extra modules - - - By default the broker will load all the modules in the module - directory, however it will NOT display options for modules that - are not loaded. So to see the options for extra modules loaded - you need to load the module and then add the help command like - this: - - -./qpidd --load-module libbdbstore.so --help -Usage: qpidd OPTIONS -Options: - -h [ --help ] Displays the help message - -v [ --version ] Displays version information - --config FILE (/etc/qpidd.conf) Reads configuration from FILE - - - / .... non module options would be here ... / - - -Store Options: - --store-directory DIR Store directory location for persistence (overrides - --data-dir) - --store-async yes|no (1) Use async persistence storage - if store supports - it, enables AIO O_DIRECT. - --store-force yes|no (0) Force changing modes of store, will delete all - existing data if mode is changed. Be SURE you want - to do this! - --num-jfiles N (8) Number of files in persistence journal - --jfile-size-pgs N (24) Size of each journal file in multiples of read - pages (1 read page = 64kiB) - -
- diff --git a/doc/book/src/Running-CPP-Broker.xml b/doc/book/src/Running-CPP-Broker.xml new file mode 100644 index 0000000000..5ab7de02f2 --- /dev/null +++ b/doc/book/src/Running-CPP-Broker.xml @@ -0,0 +1,328 @@ + + + +
+ + Running a Qpid C++ Broker + + +
+ Building the + C++ Broker and Client Libraries + + + The root directory for the C++ distribution is named + qpidc-0.4. The README file in that directory gives + instructions for building the broker and client libraries. In + most cases you will do the following: + + +[qpidc-0.4]$ ./configure +[qpidc-0.4]$ make + +
+
+ Running the C++ Broker + + + Once you have built the broker and client libraries, you can + start the broker from the command line: + + +[qpidc-0.4]$ src/qpidd + + + Use the --daemon option to run the broker as a daemon + process: + + +[qpidc-0.4]$ src/qpidd --daemon + + + You can stop a running daemon with the --quit option: + + +[qpidc-0.4]$ src/qpidd --quit + + + You can see all available options with the --help option + + +[qpidc-0.4]$ src/qpidd --help + +
+
+ Most + common questions getting qpidd running + +
+ Error + when starting broker: "no data directory" + + + The qpidd broker requires you to set a data directory or specify + --no-data-dir (see help for more details). The data + directory is used for the journal, so it is important when + reliability counts. Make sure your process has write permission + to the data directory. + + The default location is + + +/lib/var/qpidd + + + An alternate location can be set with --data-dir + +
+
+ Error + when starting broker: "that process is locked" + + + Note that when qpidd starts it creates a lock file is data + directory are being used. If you have a un-controlled exit, + please mail + the trace from the core to the dev@qpid.apache.org mailing list. + To clear the lock run + + +./qpidd -q + + + It should also be noted that multiple brokers can be run on the + same host. To do so set alternate data directories for each qpidd + instance. + +
+
+ Using a configuration + file + + + Each option that can be specified on the command line can also be + specified in a configuration file. To see available options, use + --help on the command line: + + +./qpidd --help + + + A configuration file uses name/value pairs, one on each line. To + convert a command line option to a configuration file entry: + + a.) remove the '--' from the beginning of the option. + b.) place a '=' between the option and the value (use + yes or true to enable options that take no + value when specified on the command line). + c.) place one option per line. + + For instance, the --daemon option takes no value, the + --log-to-syslog option takes the values yes or + no. The following configuration file sets these two + options: + + +daemon=yes +log-to-syslog=yes + +
+
+ Can I use + any Language client with the C++ Broker? + + + Yes, all the clients work with the C++ broker; it is written in + C+, but uses the AMQP wire protocol. Any broker can be used + with any client that uses the same AMQP version. When running the + C+ broker, it is highly recommended to run AMQP 0-10. + + Note that JMS also works with the C++ broker. For more details on + using the Java client refer to these pages: + + + + + + + + + + + +
+
+
+ Authentication + +
+ Linux + + + The PLAIN authentication is done on a username+password, which is + stored in the sasldb_path file. Usernames and passwords can be + added to the file using the command: + + +saslpasswd2 -f /var/lib/qpidd/qpidd.sasldb -u <REALM> <USER> + + + The REALM is important and should be the same as the + --auth-realm + option to the broker. This lets the broker properly find the user + in + the sasldb file. + + Existing user accounts may be listed with: + + +sasldblistusers2 -f /var/lib/qpidd/qpidd.sasldb + + + NOTE: The sasldb file must be readable by the user running the + qpidd daemon, and should be readable only by that user. + +
+
+ Windows + + + On Windows, the users are authenticated against the local + machine. You should add the appropriate users using the standard + Windows tools (Control Panel->User Accounts). To run many of + the examples, you will need to create a user "guest" with + password "guest". + + If you cannot or do not want to create new users, you can run + without authentication by specifying the no-auth option to the + broker. + +
+
+ +
+ Slightly more + complex configuration + + + The easiest way to get a full listing of the broker's options are + to use the --help command, run it locally for the latest set of + options. These options can then be set in the conf file for + convenience (see above) + + +./qpidd --help + +Usage: qpidd OPTIONS +Options: + -h [ --help ] Displays the help message + -v [ --version ] Displays version information + --config FILE (/etc/qpidd.conf) Reads configuration from FILE + +Module options: + --module-dir DIR (/usr/lib/qpidd) Load all .so modules in this directory + --load-module FILE Specifies additional module(s) to be loaded + --no-module-dir Don't load modules from module directory + +Broker Options: + --data-dir DIR (/var/lib/qpidd) Directory to contain persistent data generated by the broker + --no-data-dir Don't use a data directory. No persistent + configuration will be loaded or stored + -p [ --port ] PORT (5672) Tells the broker to listen on PORT + --worker-threads N (3) Sets the broker thread pool size + --max-connections N (500) Sets the maximum allowed connections + --connection-backlog N (10) Sets the connection backlog limit for the + server socket + --staging-threshold N (5000000) Stages messages over N bytes to disk + -m [ --mgmt-enable ] yes|no (1) Enable Management + --mgmt-pub-interval SECONDS (10) Management Publish Interval + --ack N (0) Send session.ack/solicit-ack at least every + N frames. 0 disables voluntary ack/solitict + -ack + +Daemon options: + -d [ --daemon ] Run as a daemon. + -w [ --wait ] SECONDS (10) Sets the maximum wait time to initialize the + daemon. If the daemon fails to initialize, prints + an error and returns 1 + -c [ --check ] Prints the daemon's process ID to stdout and + returns 0 if the daemon is running, otherwise + returns 1 + -q [ --quit ] Tells the daemon to shut down +Logging options: + --log-output FILE (stderr) Send log output to FILE. FILE can be a file name + or one of the special values: + stderr, stdout, syslog + -t [ --trace ] Enables all logging + --log-enable RULE (error+) Enables logging for selected levels and component + s. RULE is in the form 'LEVEL+:PATTERN' + Levels are one of: + trace debug info notice warning error critical + For example: + '--log-enable warning+' logs all warning, error + and critical messages. + '--log-enable debug:framing' logs debug messages + from the framing namespace. This option can be + used multiple times + --log-time yes|no (1) Include time in log messages + --log-level yes|no (1) Include severity level in log messages + --log-source yes|no (0) Include source file:line in log messages + --log-thread yes|no (0) Include thread ID in log messages + --log-function yes|no (0) Include function signature in log messages + +
+
+ Loading extra modules + + + By default the broker will load all the modules in the module + directory, however it will NOT display options for modules that + are not loaded. So to see the options for extra modules loaded + you need to load the module and then add the help command like + this: + + +./qpidd --load-module libbdbstore.so --help +Usage: qpidd OPTIONS +Options: + -h [ --help ] Displays the help message + -v [ --version ] Displays version information + --config FILE (/etc/qpidd.conf) Reads configuration from FILE + + + / .... non module options would be here ... / + + +Store Options: + --store-directory DIR Store directory location for persistence (overrides + --data-dir) + --store-async yes|no (1) Use async persistence storage - if store supports + it, enables AIO O_DIRECT. + --store-force yes|no (0) Force changing modes of store, will delete all + existing data if mode is changed. Be SURE you want + to do this! + --num-jfiles N (8) Number of files in persistence journal + --jfile-size-pgs N (24) Size of each journal file in multiples of read + pages (1 read page = 64kiB) + +
+
diff --git a/doc/book/src/SSL.xml b/doc/book/src/SSL.xml index 36d0586c80..a90ff03ccc 100644 --- a/doc/book/src/SSL.xml +++ b/doc/book/src/SSL.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : SSL @@ -177,4 +177,4 @@ public void connectSSL(String host, int port, String virtualHost, String usernam
- + diff --git a/doc/book/src/Starting-a-cluster.xml b/doc/book/src/Starting-a-cluster.xml index c5e77bcac5..7d402d2a6e 100644 --- a/doc/book/src/Starting-a-cluster.xml +++ b/doc/book/src/Starting-a-cluster.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : Starting a cluster
Running a @@ -222,4 +222,4 @@ qpidd -p5674 --cluster-name=MY_CLUSTER --log-output=cluster0.log -d --no-data-di </para> <!--h2--></section> <!--h1--></section> -</chapter> +</section> diff --git a/doc/book/src/System-Properties.xml b/doc/book/src/System-Properties.xml index 62c4c5e5a6..22682b12e1 100644 --- a/doc/book/src/System-Properties.xml +++ b/doc/book/src/System-Properties.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"> +<section> <title> Apache Qpid : System Properties @@ -79,7 +79,7 @@ - <varlistentry> + <varlistentry id="SystemProperties-STRICTAMQPFATAL"> <term>STRICT_AMQP_FATAL</term> <listitem> <variablelist> @@ -414,4 +414,4 @@ </variablelist> </section> </section> -</chapter> +</section> diff --git a/doc/book/src/Use-Priority-Queues.xml b/doc/book/src/Use-Priority-Queues.xml index b9900129cb..80151fbced 100644 --- a/doc/book/src/Use-Priority-Queues.xml +++ b/doc/book/src/Use-Priority-Queues.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"><title> +<section><title> Apache Qpid : Use Priority Queues @@ -111,7 +111,7 @@ The prefetch can be also be adjusted on a per connection basis by - adding a 'maxprefetch' value to the + adding a 'maxprefetch' value to the amqp://guest:guest@client1/development?maxprefetch='1'&brokerlist='tcp://localhost:5672' @@ -135,4 +135,4 @@ amqp://guest:guest@client1/development?maxprefetch='1'&brokerlist='tcp://loc
- + diff --git a/doc/book/src/Using-Broker-Federation.xml b/doc/book/src/Using-Broker-Federation.xml index 61f33c4979..c6ebd061e8 100644 --- a/doc/book/src/Using-Broker-Federation.xml +++ b/doc/book/src/Using-Broker-Federation.xml @@ -20,7 +20,7 @@ --> - +<section><title> Apache Qpid : Using Broker Federation
Introduction @@ -29,10 +29,12 @@ Please note: Whereas broker federation was introduced in the M3 milestone release, the discussion in this document is based on the richer capabilities of federation in the M4 release. - </para><para> - This document presents broker federation for the administrative - user. For design and developer information, please see <xref linkend="qpid_Federation-20Design-20Note"/>. </para> +<!-- + <para> + This document presents broker federation for the administrative + user. For design and developer information, please see <xref linkend="qpid_Federation-Design-Note"/>. + </para> --> <!--h1--></section> <section role="h1" id="UsingBrokerFederation-WhatIsBrokerFederation-3F"><title> @@ -699,4 +701,4 @@ qpid-route dynamic add $broker8 $broker6 fed.topic </section> -</chapter> +</section> diff --git a/doc/book/src/Using-Qpid-with-other-JNDI-Providers.xml b/doc/book/src/Using-Qpid-with-other-JNDI-Providers.xml index ed12f37e94..069841b4c8 100644 --- a/doc/book/src/Using-Qpid-with-other-JNDI-Providers.xml +++ b/doc/book/src/Using-Qpid-with-other-JNDI-Providers.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"> +<chapter> <title> Apache Qpid : Using Qpid with other JNDI Providers diff --git a/doc/book/src/WCF.xml b/doc/book/src/WCF.xml index 5040ed0177..03ce273cb1 100644 --- a/doc/book/src/WCF.xml +++ b/doc/book/src/WCF.xml @@ -20,7 +20,7 @@ --> -<chapter xmlns:html="http://www.w3.org/1999/xhtml"> +<section> <title> Apache Qpid : WCF @@ -134,4 +134,4 @@ service.Open();
- + diff --git a/doc/book/src/queue-state-replication.xml b/doc/book/src/queue-state-replication.xml index dedcc5ec34..42bbb11f56 100644 --- a/doc/book/src/queue-state-replication.xml +++ b/doc/book/src/queue-state-replication.xml @@ -20,7 +20,7 @@ --> - +
Apache Qpid : queue state replication @@ -330,4 +330,4 @@ Queue Replication Options:
- + diff --git a/doc/book/src/schemas.xml b/doc/book/src/schemas.xml index 0ab56a8bdb..b78cdd5d3c 100644 --- a/doc/book/src/schemas.xml +++ b/doc/book/src/schemas.xml @@ -21,6 +21,12 @@ --> + + + + + + -- cgit v1.2.1