You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jo...@apache.org on 2010/06/20 00:15:13 UTC
svn commit: r956304 [28/33] - in /qpid/site/docs/books/0.7: ./
AMQP-Messaging-Broker-CPP-Book/ AMQP-Messaging-Broker-CPP-Book/html-single/
AMQP-Messaging-Broker-CPP-Book/html-single/images/
AMQP-Messaging-Broker-CPP-Book/html-single/images/jmx_console/...
Added: qpid/site/docs/books/0.7/Qpid-Book/html/ch10s02.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/books/0.7/Qpid-Book/html/ch10s02.html?rev=956304&view=auto
==============================================================================
--- qpid/site/docs/books/0.7/Qpid-Book/html/ch10s02.html (added)
+++ qpid/site/docs/books/0.7/Qpid-Book/html/ch10s02.html Sat Jun 19 22:15:03 2010
@@ -0,0 +1,68 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>2. Qpid Java Broker Management CLI</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="Apache Qpid"><link rel="up" href="ch10.html" title="Chapter 10. Management Tools"><link rel="prev" href="ch10.html" title="Chapter 10. Management Tools"><link rel="next" href="pt04.html" title="Part IV. AMQP Messaging Clients Clients"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.
+ Qpid Java Broker Management CLI
+ </th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch10.html">Prev</a> </td><th width="60%" align="center">Chapter 10. Management Tools</th><td width="20%" align="right"> <a accesskey="n" href="pt04.html">Next</a></td></tr></table><hr></div><div class="section" title="2. Qpid Java Broker Management CLI"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2980508"></a>2.
+ Qpid Java Broker Management CLI
+ </h2></div></div></div><div class="section" title="2.1. How to build Apache Qpid CLI"><div class="titlepage"><div><div><h3 class="title"><a name="QpidJavaBrokerManagementCLI-HowtobuildApacheQpidCLI"></a>2.1.
+ How to
+ build Apache Qpid CLI
+ </h3></div></div></div><div class="section" title="2.1.1. Build Instructions - General"><div class="titlepage"><div><div><h4 class="title"><a name="QpidJavaBrokerManagementCLI-BuildInstructionsGeneral"></a>2.1.1.
+ Build
+ Instructions - General
+ </h4></div></div></div><p>
+ At the very beginning please build Apache Qpid by refering this
+ installation guide from here <a class="xref" href="">???</a>.
+ </p><p>
+ After successfully build Apache Qpid you'll be able to start
+ Apache Qpid Java broker,then only you are in a position to use
+ Qpid CLI.
+ </p></div><div class="section" title="2.1.2. Check out the Source"><div class="titlepage"><div><div><h4 class="title"><a name="QpidJavaBrokerManagementCLI-CheckouttheSource"></a>2.1.2.
+ Check
+ out the Source
+ </h4></div></div></div><p>
+ First check out the source from subversion repository. Please
+ visit the following link for more information about different
+ versions of Qpid CLI.
+ </p><p>
+ <a class="xref" href="">???</a>
+ </p></div><div class="section" title="2.1.3. Prerequisites"><div class="titlepage"><div><div><h4 class="title"><a name="QpidJavaBrokerManagementCLI-Prerequisites"></a>2.1.3.
+ Prerequisites
+ </h4></div></div></div><p>
+ For the broker code you need JDK 1.5.0_15 or later. You should
+ set JAVA_HOME and include the bin directory in your PATH.
+ </p><p>
+ Check it's ok by executing java -v !
+ </p></div><div class="section" title="2.1.4. Building Apache Qpid CLI"><div class="titlepage"><div><div><h4 class="title"><a name="QpidJavaBrokerManagementCLI-BuildingApacheQpidCLI"></a>2.1.4.
+ Building
+ Apache Qpid CLI
+ </h4></div></div></div><p>
+ This project is currently having only an ant build system.Please
+ install ant build system before trying to install Qpid CLI.
+ </p></div><div class="section" title="2.1.5. Compiling"><div class="titlepage"><div><div><h4 class="title"><a name="QpidJavaBrokerManagementCLI-Compiling"></a>2.1.5.
+ Compiling
+ </h4></div></div></div><p>
+ To compile the source please run following command
+ </p><pre class="programlisting">
+ant compile
+</pre><p>
+ To compile the test source run the following command
+ </p><pre class="programlisting">
+ant compile-tests
+</pre></div><div class="section" title="2.1.6. Running CLI"><div class="titlepage"><div><div><h4 class="title"><a name="QpidJavaBrokerManagementCLI-RunningCLI"></a>2.1.6.
+ Running CLI
+ </h4></div></div></div><p>
+ After successful compilation set QPID_CLI environment variable to
+ the main source directory.(set the environment variable to the
+ directory where ant build script stored in the SVN
+ checkout).Please check whether the Qpid Java broker is up an
+ running in the appropriate location and run the following command
+ to start the Qpid CLI by running the qpid-cli script in the bin
+ directory.
+ </p><p>
+ $QPID_CLI/bin/qpid-cli -h <hostname of the broker> -p
+ <broker running port>
+ For more details please have a look in to README file which ships
+ with source package of Qpid CLI.
+ </p></div><div class="section" title="2.1.7. Other ant targets"><div class="titlepage"><div><div><h4 class="title"><a name="QpidJavaBrokerManagementCLI-Otheranttargets"></a>2.1.7.
+ Other
+ ant targets
+ </h4></div></div></div><p>For now we are supporting those ant targets.</p><div class="variablelist"><dl><dt><span class="term">ant clean</span></dt><dd><p>Clean the complete build including CLI build and test build.</p></dd><dt><span class="term">ant jar</span></dt><dd><p>Create the jar file for the project without test cases.</p></dd><dt><span class="term">ant init</span></dt><dd><p>Create the directory structure for build.</p></dd><dt><span class="term">ant compile-tests </span></dt><dd><p>This compiles all the test source.</p></dd><dt><span class="term">ant test </span></dt><dd><p>Run all the test cases.</p></dd></dl></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch10.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch10.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="pt04.html">Next</a></td></tr><tr><td wi
dth="40%" align="left" valign="top">Chapter 10. Management Tools </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Part IV. AMQP Messaging Clients Clients</td></tr></table></div></body></html>
Added: qpid/site/docs/books/0.7/Qpid-Book/html/ch11.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/books/0.7/Qpid-Book/html/ch11.html?rev=956304&view=auto
==============================================================================
--- qpid/site/docs/books/0.7/Qpid-Book/html/ch11.html (added)
+++ qpid/site/docs/books/0.7/Qpid-Book/html/ch11.html Sat Jun 19 22:15:03 2010
@@ -0,0 +1,433 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 11. AMQP Java JMS Messaging Client</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="Apache Qpid"><link rel="up" href="pt04.html" title="Part IV. AMQP Messaging Clients Clients"><link rel="prev" href="pt04.html" title="Part IV. AMQP Messaging Clients Clients"><link rel="next" href="ch11s02.html" title="2. AMQP Java JMS Examples"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 11.
+ AMQP Java JMS Messaging Client
+ </th></tr><tr><td width="20%" align="left"><a accesskey="p" href="pt04.html">Prev</a> </td><th width="60%" align="center">Part IV. AMQP Messaging Clients Clients</th><td width="20%" align="right"> <a accesskey="n" href="ch11s02.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 11. AMQP Java JMS Messaging Client"><div class="titlepage"><div><div><h2 class="title"><a name="id2940677"></a>Chapter 11.
+ AMQP Java JMS Messaging Client
+ </h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch11.html#AMQPJavaJMSMessagingClient-GeneralUserGuides">1. General User Guides</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#id2937387">1.1.
+ System Properties
+ </a></span></dt><dt><span class="section"><a href="ch11.html#Connection-URL-Format">1.2.
+ Connection URL Format
+ </a></span></dt><dt><span class="section"><a href="ch11.html#BindingURLFormat">1.3.
+ Binding URL Format
+ </a></span></dt><dt><span class="section"><a href="ch11.html#id2973783">1.4. Java JMS Selector Syntax</a></span></dt></dl></dd><dt><span class="section"><a href="ch11s02.html">2. AMQP Java JMS Examples </a></span></dt></dl></div><p>The Java Client supported by Qpid implements the <a class="ulink" href="http://java.sun.com/products/jms/docs.html" target="_top">Java JMS 1.1
+ Specification</a>. </p><div class="section" title="1. General User Guides"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="AMQPJavaJMSMessagingClient-GeneralUserGuides"></a>1. General User Guides</h2></div></div></div><div class="section" title="1.1. System Properties"><div class="titlepage"><div><div><h3 class="title"><a name="id2937387"></a>1.1.
+ System Properties
+ </h3></div></div></div><div class="section" title="1.1.1. Explanation of System properties used in Qpid"><div class="titlepage"><div><div><h4 class="title"><a name="SystemProperties-ExplanationofSystempropertiesusedinQpid"></a>1.1.1. Explanation of System properties used in Qpid </h4></div></div></div><p>
+ This page documents the various System Properties that are
+ currently used in the Qpid Java code base.
+ </p><div class="section" title="1.1.1.1. Client Properties"><div class="titlepage"><div><div><h5 class="title"><a name="SystemProperties-ClientProperties"></a>1.1.1.1. Client Properties </h5></div></div></div><div class="variablelist"><dl><dt><span class="term">STRICT_AMQP</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Type</span></dt><dd><p>Boolean</p></dd><dt><span class="term">Default</span></dt><dd><p>FALSE</p></dd></dl></div><p> This forces the client to only send AMQP compliant
+ frames. This will disable a number of JMS features.</p><div class="itemizedlist" title="Features disabled by STRICT_AMQP"><p class="title"><b> Features disabled by STRICT_AMQP</b></p><ul class="itemizedlist" type="disc"><li class="listitem"><p>Queue Browser
+ </p></li><li class="listitem"><p>Message Selectors
+ </p></li><li class="listitem"><p>Durable Subscriptions
+ </p></li><li class="listitem"><p>Session Recover may result in duplicate message delivery
+ </p></li><li class="listitem"><p>Destination validation, so no InvalidDestinationException
+ will be thrown
+ </p></li></ul></div><p>
+ This is associated with property <a class="xref" href="ch11.html#SystemProperties-STRICTAMQPFATAL">STRICT_AMQP_FATAL</a>
+ </p></dd><dt><a name="SystemProperties-STRICTAMQPFATAL"></a><span class="term">STRICT_AMQP_FATAL</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Type</span></dt><dd><p>Boolean</p></dd><dt><span class="term">Default</span></dt><dd><p>FALSE</p></dd></dl></div><p>
+ This will cause any attempt to utilise an enhanced feature to
+ throw and UnsupportedOperationException. When set to false then
+ the exception will not occur but the feature will be disabled.
+ </p><p>
+ e.g.
+ The Queue Browser will always show no messages.
+ Any message selector will be removed.
+ </p></dd><dt><span class="term">IMMEDIATE_PREFETCH</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Type</span></dt><dd><p>Boolean</p></dd><dt><span class="term">Default</span></dt><dd><p>FALSE</p></dd></dl></div><p>
+ The default with AMQP is to start prefetching messages. However,
+ with certain 3rd party Java tools, such as Mule this can cause a
+ problem. Mule will create a consumer but never consume from it so
+ any any prefetched messages will be stuck until that session is
+ closed. This property is used to re-instate the default AMQP
+ behaviour. The default Qpid behaviour is to prevent prefetch
+ occurring, by starting the connection Flow Controlled, until a
+ request for a message is made on the consumer either via a
+ receive() or setting a message listener.</p></dd><dt><span class="term">amqj.default_syncwrite_timeout</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Type</span></dt><dd><p>long</p></dd><dt><span class="term">Default</span></dt><dd><p>30000</p></dd></dl></div><p> The number length of time in millisecond to wait
+ for a synchronous write to complete.
+ </p></dd><dt><span class="term">amq.dynamicsaslregistrar.properties</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Type</span></dt><dd><p>String</p></dd><dt><span class="term">Default</span></dt><dd><p>org/apache/qpid/client/security/DynamicSaslRegistrar.properties</p></dd></dl></div><p>The name of the SASL configuration properties file.
+ </p></dd><dt><span class="term">amqj.heartbeat.timeoutFactor</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Type</span></dt><dd><p>float</p></dd><dt><span class="term">Default</span></dt><dd><p>2.0</p></dd></dl></div><p>
+ The factor used to get the timeout from the delay between
+ heartbeats
+ </p></dd><dt><span class="term">amqj.tcpNoDelay</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Type</span></dt><dd><p>Boolean</p></dd><dt><span class="term">Default</span></dt><dd><p>TRUE</p></dd></dl></div><p> Disable Nagle's algorithm on the TCP connection.
+ </p></dd><dt><span class="term">amqj.sendBufferSize</span></dt><dd><div class="variablelist"><dl><dt><span class="term">integer</span></dt><dd><p>Boolean</p></dd><dt><span class="term">Default</span></dt><dd><p>32768</p></dd></dl></div><p>This is the default buffer sized created by Mina.
+ </p></dd><dt><span class="term">amqj.receiveBufferSize</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Type</span></dt><dd><p>integer</p></dd><dt><span class="term">Default</span></dt><dd><p>32768</p></dd></dl></div><p>This is the default buffer sized created by Mina.
+ </p></dd><dt><span class="term">amqj.protocolprovider.class</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Type</span></dt><dd><p>String</p></dd><dt><span class="term">Default</span></dt><dd><p>org.apache.qpid.server.protocol.AMQPFastProtocolHandler</p></dd></dl></div><p> This specifies the default IoHandlerAdapter that
+ represents the InVM broker. The IoHandlerAdapter must have
+ a constructor that takes a single Integer that represents
+ the InVM port number.
+ </p></dd><dt><span class="term">amqj.protocol.logging.level</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Type</span></dt><dd><p>Boolean</p></dd><dt><span class="term">Default</span></dt><dd><p>null</p></dd></dl></div><p>If set this will turn on protocol logging on the
+ client. </p></dd><dt><span class="term">jboss.host</span></dt><dd><p>
+ Used by the JBossConnectionFactoryInitialiser to specify the host
+ to connect to perform JNDI lookups.
+ </p></dd><dt><span class="term">jboss.port</span></dt><dd><p>
+ Used by the JBossConnectionFactoryInitialiser to specify the port
+ to connect to perform JNDI lookups.
+ </p></dd><dt><span class="term">amqj.MaximumStateWait</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Default</span></dt><dd><p>30000</p></dd></dl></div><p>
+ Used to set the maximum time the State Manager should wait before
+ timing out a frame wait.
+ </p></dd></dl></div></div><div class="section" title="1.1.1.2. Management Properties"><div class="titlepage"><div><div><h5 class="title"><a name="SystemProperties-ManagementProperties"></a>1.1.1.2.
+ Management Properties
+ </h5></div></div></div><div class="variablelist"><dl><dt><span class="term">security</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Default</span></dt><dd><p>null</p></dd></dl></div><p>
+ String representing the Security level to be used to on
+ the connection to the broker. The null default results
+ in no security or PLAIN. When used with jmxconnector
+ 'javax.management.remote.jmxmp.JMXMPConnector' a
+ security value of 'CRAM-MD5' will result in all
+ communication to the broker being encrypted.
+ </p></dd><dt><span class="term">jmxconnector</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Default</span></dt><dd><p>null</p></dd></dl></div><p>
+ String representing the JMXConnector class used to
+ perform the connection to the broker. The null default
+ results in the standard JMX connector. Utilising
+ 'javax.management.remote.jmxmp.JMXMPConnector' and
+ security 'CRAM-MD5' will result in all communication to
+ the broker being encrypted.
+ </p></dd><dt><span class="term">timeout</span></dt><dd><div class="variablelist"><dl><dt><span class="term">Default</span></dt><dd><p>5000</p></dd></dl></div><p>
+ Long value representing the milli seconds before
+ connection to the broker should timeout.
+ </p></dd></dl></div></div><div class="section" title="1.1.1.3. Properties used in Examples"><div class="titlepage"><div><div><h5 class="title"><a name="SystemProperties-PropertiesusedinExamples"></a>1.1.1.3. Properties used in Examples </h5></div></div></div><div class="variablelist"><dl><dt><span class="term">archivepath</span></dt><dd><p>
+ Used in <code class="filename">FileMessageDispatcher</code>. This
+ properties specifies the directory to move payload
+ file(s) to archive location as no error</p></dd></dl></div></div></div></div><div class="section" title="1.2. Connection URL Format"><div class="titlepage"><div><div><h3 class="title"><a name="Connection-URL-Format"></a>1.2.
+ Connection URL Format
+ </h3></div></div></div><div class="section" title="1.2.1. Format"><div class="titlepage"><div><div><h4 class="title"><a name="ConnectionURLFormat-Format"></a>1.2.1.
+ Format
+ </h4></div></div></div><pre class="programlisting">
+amqp://[<user>:<pass>@][<clientid>]<virtualhost>[?<option>='<value>'[&<option>='<value>']]
+ </pre><p>
+ The connection url defines the values that are common across
+ the cluster of brokers. The virtual host is second in the list
+ as the AMQP specification demands that it start with a '/'
+ otherwise it be more readable to be swapped with
+ clientid. There is currently only one required option and that
+ is the <span class="emphasis"><em>brokerlist</em></span> option. In addition the
+ following options are recognised. </p></div><div class="section" title="1.2.2. Worked Example"><div class="titlepage"><div><div><h4 class="title"><a name="ConnectionURLFormat-WorkedExample"></a>1.2.2. Worked Example </h4></div></div></div><p> You could use a URL which looks something like this:
+ </p><pre class="programlisting">
+amqp://guest:guest@client1/development?brokerlist='tcp://localhost:5672'
+</pre><p> Breaking this example down, here's what it all
+ means: </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p> amqp = the protocol we're using
+ </p></li><li class="listitem"><p> guest:guest@localhost = username:password@clientid
+ where the clientid is the name of your server (used under
+ the covers but don't worry about this for now). Always use
+ the guest:guest combination at the moment.</p></li><li class="listitem"><p> development = the name of the virtualhost, where the
+ virtualhost is a path which acts as a namespace. You can
+ effectively use any value here so long as you're consistent
+ throughout. The virtualhost must start with a slash "/" and
+ continue with names separated by slashes. A name consists of
+ any combination of at least one of [A-Za-z0-9] plus zero or
+ more of [.-_+!=:]. </p></li><li class="listitem"><p>brokerlist = this is the host address and port for
+ the broker you want to connect to. The connection factory
+ will assume tcp if you don't specify a transport
+ protocol. The port also defaults to 5672. Naturally you have
+ to put at least one broker in this list. </p></li></ul></div><p> This example is not using failover so only provides
+ one host for the broker. If you do wish to connect using
+ failover you can provide two (or more) brokers in the
+ format: </p><p>
+ brokerlist='tcp://host1&tcp://host2:5673' </p><p>The default failover setup will automatically retry
+ each broker once after a failed connection. If the
+ brokerlist contains more than one server then these servers
+ are tried in a round robin. Details on how to modifiy this
+ behaviour will follow soon ! </p></div><div class="section" title="1.2.3. Options"><div class="titlepage"><div><div><h4 class="title"><a name="ConnectionURLFormat-Options"></a>1.2.3. Options</h4></div></div></div><div class="table"><a name="id2988085"></a><p class="title"><b>Table 11.1. Connection URL Options</b></p><div class="table-contents"><table summary="Connection URL Options" border="1"><colgroup><col><col><col></colgroup><tbody><tr><td>
+ Option
+ </td><td>
+ Default
+ </td><td>
+ Description
+ </td></tr><tr><td>
+ brokerlist
+ </td><td>
+ see below
+ </td><td>
+ The list of brokers to use for this connection
+ </td></tr><tr><td>
+ failover
+ </td><td>
+ see below
+ </td><td>
+ The type of failover method to use with the broker list.
+ </td></tr><tr><td>
+ maxprefetch
+ </td><td>
+ 5000
+ </td><td>
+ The maximum number of messages to prefetch from the broker.
+ </td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="1.2.4. Brokerlist option"><div class="titlepage"><div><div><h4 class="title"><a name="ConnectionURLFormat-Brokerlistoption"></a>1.2.4. Brokerlist option </h4></div></div></div><pre class="programlisting">
+brokerlist='<broker url>[;<broker url>]'
+</pre><p>
+ The broker list defines the various brokers that can be used for
+ this connection. A minimum of one broker url is required
+ additional URLs are semi-colon(';') delimited.
+ </p></div><div class="section" title="1.2.5. Broker URL format"><div class="titlepage"><div><div><h4 class="title"><a name="ConnectionURLFormat-BrokerURLformat"></a>1.2.5. Broker URL format </h4></div></div></div><pre class="programlisting">
+<transport>://<host>[:<port>][?<option>='<value>'[&<option>='<value>']]
+</pre><p>
+ There are currently quite a few default values that can be
+ assumed. This was done so that the current client examples would
+ not have to be re-written. The result is if there is no
+ transport, 'tcp' is assumed and the default AMQP port of 5672 is
+ used if no port is specified.
+ </p><div class="table"><a name="id2906699"></a><p class="title"><b>Table 11.2. Broker URL- Transport</b></p><div class="table-contents"><table summary="Broker URL- Transport" border="1"><colgroup><col></colgroup><tbody><tr><td>
+ Transport
+ </td></tr><tr><td>
+ tcp
+ </td></tr><tr><td>
+ vm
+ </td></tr></tbody></table></div></div><br class="table-break"><p>
+ Currently only 'tcp' and 'vm' transports are supported. Each
+ broker can take have additional options that are specific to that
+ broker. The following are currently implemented options. To add
+ support for further transports the
+ ''client.transportTransportConnection'' class needs updating
+ along with the parsing to handle the transport.
+ </p><div class="table"><a name="id2906748"></a><p class="title"><b>Table 11.3. Broker URL - Connection Options</b></p><div class="table-contents"><table summary="Broker URL - Connection Options" border="1"><colgroup><col><col><col></colgroup><tbody><tr><td>
+ Option
+ </td><td>
+ Default
+ </td><td>
+ Description
+ </td></tr><tr><td>
+ retries
+ </td><td>
+ 1
+ </td><td>
+ The number of times to retry connection to this Broker
+ </td></tr><tr><td>
+ ssl
+ </td><td>
+ false
+ </td><td>
+ Use ssl on the connection
+ </td></tr><tr><td>
+ connecttimeout
+ </td><td>
+ 30000
+ </td><td>
+ How long in (milliseconds) to wait for the connection to
+ succeed
+ </td></tr><tr><td>
+ connectdelay
+ </td><td>
+ none
+ </td><td>
+ How long in (milliseconds) to wait before attempting to
+ reconnect
+ </td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="1.2.6. Brokerlist failover option"><div class="titlepage"><div><div><h4 class="title"><a name="ConnectionURLFormat-Brokerlistfailoveroption"></a>1.2.6. Brokerlist failover option </h4></div></div></div><pre class="programlisting">
+failover='<method>[?<options>]'
+</pre><p>
+ This option controls how failover occurs when presented with a
+ list of brokers. There are only two methods currently implemented
+ but interface qpid.jms.failover.FailoverMethod can be
+ used for defining further methods.
+ </p><p>
+ Currently implemented failover methods.
+ </p><div class="table"><a name="id2973042"></a><p class="title"><b>Table 11.4. Broker List - Failover Options</b></p><div class="table-contents"><table summary="Broker List - Failover Options" border="1"><colgroup><col><col></colgroup><tbody><tr><td>
+ Method
+ </td><td>
+ Description
+ </td></tr><tr><td>
+ singlebroker
+ </td><td>
+ This will only use the first broker in the list.
+ </td></tr><tr><td>
+ roundrobin
+ </td><td>
+ This method tries each broker in turn.
+ </td></tr><tr><td>
+ nofailover
+ </td><td>
+ [New in 0.5] This method disables all retry and failover
+ logic.
+ </td></tr></tbody></table></div></div><br class="table-break"><p>
+ The current defaults are naturally to use the 'singlebroker' when
+ only one broker is present and the 'roundrobin' method with
+ multiple brokers. The '''method''' value in the URL may also be
+ any valid class on the classpath that implements the
+ FailoverMethod interface.
+ </p><p>
+ The 'nofailover' method is useful if you are using a 3rd party
+ tool such as Mule that has its own reconnection strategy that you
+ wish to use.
+ </p><div class="table"><a name="id2973124"></a><p class="title"><b>Table 11.5. Broker List - Failover Options</b></p><div class="table-contents"><table summary="Broker List - Failover Options" border="1"><colgroup><col><col><col></colgroup><tbody><tr><td>
+ Option
+ </td><td>
+ Default
+ </td><td>
+ Description
+ </td></tr><tr><td>
+ cyclecount
+ </td><td>
+ 1
+ </td><td>
+ The number of times to loop through the list of available
+ brokers before failure.
+ </td></tr></tbody></table></div></div><br class="table-break"><p>
+ <span class="emphasis"><em>Note:</em></span> Default was changed from 0 to 1 in Release 0.5
+ </p></div><div class="section" title="1.2.7. Sample URLs"><div class="titlepage"><div><div><h4 class="title"><a name="ConnectionURLFormat-SampleURLs"></a>1.2.7.
+ Sample URLs
+ </h4></div></div></div><pre class="programlisting">
+amqp:///test?brokerlist='localhost'
+amqp:///test?brokerlist='tcp://anotherhost:5684?retries='10''
+amqp://guest:guest@/test?brokerlist='vm://:1;vm://:2'&failover='roundrobin'
+amqp://guest:guest@/test?brokerlist='vm://:1;vm://:2'&failover='roundrobin?cyclecount='20''
+amqp://guest:guest@client/test?brokerlist='tcp://localhost;tcp://redundant-server:5673?ssl='true''&failover='roundrobin'
+amqp://guest:guest@/test?brokerlist='vm://:1'&failover='nofailover'
+</pre></div></div><div class="section" title="1.3. Binding URL Format"><div class="titlepage"><div><div><h3 class="title"><a name="BindingURLFormat"></a>1.3.
+ Binding URL Format
+ </h3></div></div></div><pre class="programlisting">
+<Exchange Class>://<Exchange Name>/[<Destination>]/[<Queue>][?<option>='<value>'[&<option>='<value>']]
+</pre><p>
+ This URL format is used for two purposes in the code base. The
+ broker uses this in the XML configuration file to create and bind
+ queues at broker startup. It is also used by the client as a
+ destination.
+ </p><p>
+ This format was used because it allows an explicit description of
+ exchange and queue relationship.
+ </p><p>
+ The Exchange Class is not normally required for client connection
+ as clients only publish to a named exchange however if exchanges
+ are being dynamically instantiated it will be required. The class
+ is required for the server to instantiate an exchange.
+ </p><p>
+ There are a number of options that are currently defined:
+ </p><div class="table"><a name="id2977524"></a><p class="title"><b>Table 11.6. Binding URL Options</b></p><div class="table-contents"><table summary="Binding URL Options" border="1"><colgroup><col><col><col></colgroup><tbody><tr><td>
+ Option
+ </td><td>
+ type
+ </td><td>
+ Description
+ </td></tr><tr><td>
+ exclusive
+ </td><td>
+ boolean
+ </td><td>
+ Is this an exclusive connection
+ </td></tr><tr><td>
+ autodelete
+ </td><td>
+ boolean
+ </td><td>
+ Should this queue be deleted on client disconnection
+ </td></tr><tr><td>
+ durable
+ </td><td>
+ boolean
+ </td><td>
+ Create a durable queue
+ </td></tr><tr><td>
+ clientid
+ </td><td>
+ string
+ </td><td>
+ Use the following client id
+ </td></tr><tr><td>
+ subscription
+ </td><td>
+ boolean
+ </td><td>
+ Create a subscription to this destination
+ </td></tr><tr><td>
+ routingkey
+ </td><td>
+ string
+ </td><td>
+ Use this value as the routing key
+ </td></tr></tbody></table></div></div><br class="table-break"><p>
+ Using these options in conjunction with the Binding URL format
+ should allow future expansion as new and custom exchange types
+ are created.
+ </p><p>
+ The URL format requires <span class="emphasis"><em>that at least one</em></span> Queue or
+ routingkey option be present on the URL.
+ </p><p>
+ The routingkey would be used to encode a topic as shown in the
+ examples section below.
+ </p><div class="section" title="1.3.1. Examples"><div class="titlepage"><div><div><h4 class="title"><a name="BindingURLFormat-Examples"></a>1.3.1.
+ Examples
+ </h4></div></div></div><div class="example"><a name="id3005272"></a><p class="title"><b>Example 11.1. Queues</b></p><div class="example-contents"><p>
+ A queue can be created in QPID using the following URL format.
+ </p><p>
+ direct://amq.direct//<Queue Name>
+ </p><p>
+ For example: direct://amq.direct//simpleQueue
+ </p><p>
+ Queue names may consist of any mixture of digits, letters, and
+ underscores.
+ </p></div></div><br class="example-break"><div class="example"><a name="id2973747"></a><p class="title"><b>Example 11.2. Topics</b></p><div class="example-contents"><p>
+ A topic can be created in QPID using the following URL format.
+ </p><p>
+ topic://amq.topic/<Topic Subscription>/
+ </p><p>
+ The topic subscription may only contain the letters A-Z and a-z
+ and digits 0-9.
+ </p><pre class="programlisting">
+direct://amq.direct/SimpleQueue
+direct://amq.direct/UnusuallyBoundQueue?routingkey='/queue'
+topic://amq.topic?routingkey='stocks.#'
+topic://amq.topic?routingkey='stocks.nyse.ibm'
+</pre></div></div><br class="example-break"></div></div><div class="section" title="1.4. Java JMS Selector Syntax"><div class="titlepage"><div><div><h3 class="title"><a name="id2973783"></a>1.4. Java JMS Selector Syntax</h3></div></div></div><p>The AMQP Java JMS Messaging Client supports the following syntax for JMS selectors.</p><pre class="programlisting">
+Comments:
+
+ LINE_COMMENT: "--" (~["\n","\r"])* EOL
+ EOL: "\n"|"\r"|"\r\n"
+ BLOCK_COMMENT: "/*" (~["*"])* "*" ("*" | (~["*","/"] (~["*"])* "*"))* "/"
+
+Reserved Words (case insensitive):
+
+ NOT: "NOT"
+ AND: "AND"
+ OR: "OR"
+ BETWEEN: "BETWEEN"
+ LIKE: "LIKE"
+ ESCAPE: "ESCAPE"
+ IN: "IN"
+ IS: "IS"
+ TRUE: "TRUE"
+ FALSE: "FALSE"
+ NULL: "NULL"
+
+Literals (case insensitive):
+
+ DECIMAL_LITERAL: ["1"-"9"] (["0"-"9"])* (["l","L"])?
+ HEX_LITERAL: "0" ["x","X"] (["0"-"9","a"-"f","A"-"F"])+
+ OCTAL_LITERAL: "0" (["0"-"7"])*
+ FLOATING_POINT_LITERAL: ( (["0"-"9"])+ "." (["0"-"9"])* (<EXPONENT>)? // matches: 5.5 or 5. or 5.5E10 or 5.E10
+ | "." (["0"-"9"])+ (<EXPONENT>)? // matches: .5 or .5E10
+ | (["0"-"9"])+ <EXPONENT> ) // matches: 5E10
+ EXPONENT: "E" (["+","-"])? (["0"-"9"])+
+ STRING_LITERAL: "'" ( ("''") | ~["'"] )* "'"
+
+Identifiers (case insensitive):
+
+ ID : ["a"-"z", "_", "$"] (["a"-"z","0"-"9","_", "$"])*
+ QUOTED_ID : "\"" ( ("\"\"") | ~["\""] )* "\""
+
+Grammar:
+
+ JmsSelector := orExpression
+ orExpression := ( andExpression ( <OR> andExpression )* )
+ andExpression := ( equalityExpression ( <AND> equalityExpression )* )
+ equalityExpression := ( comparisonExpression ( "=" comparisonExpression
+ | "<>" comparisonExpression
+ | <IS> <NULL>
+ | <IS> <NOT> <NULL> )* )
+ comparisonExpression := ( addExpression ( ">" addExpression
+ | ">=" addExpression
+ | "<" addExpression
+ | "<=" addExpression
+ | <LIKE> stringLitteral ( <ESCAPE> stringLitteral )?
+ | <NOT> <LIKE> <STRING_LITERAL> ( <ESCAPE> <STRING_LITERAL> )?
+ | <BETWEEN> addExpression <AND> addExpression
+ | <NOT> <BETWEEN> addExpression <AND> addExpression
+ | <IN> "(" <STRING_LITERAL> ( "," <STRING_LITERAL> )* ")"
+ | <NOT> <IN> "(" <STRING_LITERAL> ( "," <STRING_LITERAL> )* ")" )* )
+ addExpression := multExpr ( ( "+" multExpr | "-" multExpr ) )*
+ multExpr := unaryExpr ( "*" unaryExpr | "/" unaryExpr | "%" unaryExpr )*
+ unaryExpr := ( "+" unaryExpr | "-" unaryExpr | <NOT> unaryExpr | primaryExpr )
+ primaryExpr := ( literal | variable | "(" orExpression ")" )
+ literal := ( <STRING_LITERAL>
+ | <DECIMAL_LITERAL>
+ | <HEX_LITERAL>
+ | <OCTAL_LITERAL>
+ | <FLOATING_POINT_LITERAL>
+ | <TRUE>
+ | <FALSE>
+ | <NULL> )
+ variable := ( <ID> | <QUOTED_ID> )
+</pre></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="pt04.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="pt04.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch11s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Part IV. AMQP Messaging Clients Clients </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2. AMQP Java JMS Examples </td></tr></table></div></body></html>
Added: qpid/site/docs/books/0.7/Qpid-Book/html/ch11s02.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/books/0.7/Qpid-Book/html/ch11s02.html?rev=956304&view=auto
==============================================================================
--- qpid/site/docs/books/0.7/Qpid-Book/html/ch11s02.html (added)
+++ qpid/site/docs/books/0.7/Qpid-Book/html/ch11s02.html Sat Jun 19 22:15:03 2010
@@ -0,0 +1,20 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>2. AMQP Java JMS Examples</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="Apache Qpid"><link rel="up" href="ch11.html" title="Chapter 11. AMQP Java JMS Messaging Client"><link rel="prev" href="ch11.html" title="Chapter 11. AMQP Java JMS Messaging Client"><link rel="next" href="ch12.html" title="Chapter 12. AMQP C++ Messaging Client"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2. AMQP Java JMS Examples </th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch11.html">Prev</a> </td><th width="60%" align="center">Chapter 11.
+ AMQP Java JMS Messaging Client
+ </th><td width="20%" align="right"> <a accesskey="n" href="ch12.html">Next</a></td></tr></table><hr></div><div class="section" title="2. AMQP Java JMS Examples"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="AMQPJavaJMSMessagingClient-AMQPJavaJMSExamples"></a>2. AMQP Java JMS Examples </h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
+ <a class="ulink" href="https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/" target="_top">Examples Directory</a>
+ </p></li><li class="listitem"><p>
+ <a class="ulink" href="https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/src/main/java/runSample.sh" target="_top">Script for running examples</a>
+ </p></li><li class="listitem"><p>
+ <a class="ulink" href="https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/src/main/java/org/apache/qpid/example/jmsexample/direct/" target="_top">Direct Example</a>
+ </p></li><li class="listitem"><p>
+ <a class="ulink" href="https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/src/main/java/org/apache/qpid/example/jmsexample/fanout/" target="_top">Fanout Example</a>
+ </p></li><li class="listitem"><p>
+ <a class="ulink" href="https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/src/main/java/org/apache/qpid/example/jmsexample/pubsub" target="_top">Pub-Sub Example</a>
+ </p></li><li class="listitem"><p>
+ <a class="ulink" href="https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/src/main/java/org/apache/qpid/example/jmsexample/requestResponse/" target="_top">Request/Response Example</a>
+ </p></li><li class="listitem"><p>
+ <a class="ulink" href="https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/src/main/java/org/apache/qpid/example/jmsexample/transacted/" target="_top">Transacted Example</a></p></li></ul></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch11.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch11.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch12.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 11.
+ AMQP Java JMS Messaging Client
+ </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 12.
+ AMQP C++ Messaging Client
+ </td></tr></table></div></body></html>
Added: qpid/site/docs/books/0.7/Qpid-Book/html/ch12.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/books/0.7/Qpid-Book/html/ch12.html?rev=956304&view=auto
==============================================================================
--- qpid/site/docs/books/0.7/Qpid-Book/html/ch12.html (added)
+++ qpid/site/docs/books/0.7/Qpid-Book/html/ch12.html Sat Jun 19 22:15:03 2010
@@ -0,0 +1,15 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 12. AMQP C++ Messaging Client</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="Apache Qpid"><link rel="up" href="pt04.html" title="Part IV. AMQP Messaging Clients Clients"><link rel="prev" href="ch11s02.html" title="2. AMQP Java JMS Examples"><link rel="next" href="ch12s02.html" title="2. Examples"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 12.
+ AMQP C++ Messaging Client
+ </th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch11s02.html">Prev</a> </td><th width="60%" align="center">Part IV. AMQP Messaging Clients Clients</th><td width="20%" align="right"> <a accesskey="n" href="ch12s02.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 12. AMQP C++ Messaging Client"><div class="titlepage"><div><div><h2 class="title"><a name="id2941507"></a>Chapter 12.
+ AMQP C++ Messaging Client
+ </h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch12.html#AMQPCPPMessagingClient-UserGuides">1.
+ User Guides
+ </a></span></dt><dt><span class="section"><a href="ch12s02.html">2.
+ Examples
+ </a></span></dt></dl></div><div class="section" title="1. User Guides"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="AMQPCPPMessagingClient-UserGuides"></a>1.
+ User Guides
+ </h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
+ <a class="ulink" href="http://qpid.apache.org/docs/api/cpp/html/index.html" target="_top">C++ Client API (AMQP 0-10)</a>
+ </p></li></ul></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch11s02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="pt04.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch12s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2. AMQP Java JMS Examples </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2.
+ Examples
+ </td></tr></table></div></body></html>
Added: qpid/site/docs/books/0.7/Qpid-Book/html/ch12s02.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/books/0.7/Qpid-Book/html/ch12s02.html?rev=956304&view=auto
==============================================================================
--- qpid/site/docs/books/0.7/Qpid-Book/html/ch12s02.html (added)
+++ qpid/site/docs/books/0.7/Qpid-Book/html/ch12s02.html Sat Jun 19 22:15:03 2010
@@ -0,0 +1,15 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>2. Examples</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="Apache Qpid"><link rel="up" href="ch12.html" title="Chapter 12. AMQP C++ Messaging Client"><link rel="prev" href="ch12.html" title="Chapter 12. AMQP C++ Messaging Client"><link rel="next" href="ch13.html" title="Chapter 13. AMQP .NET Messaging Client"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.
+ Examples
+ </th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch12.html">Prev</a> </td><th width="60%" align="center">Chapter 12.
+ AMQP C++ Messaging Client
+ </th><td width="20%" align="right"> <a accesskey="n" href="ch13.html">Next</a></td></tr></table><hr></div><div class="section" title="2. Examples"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="AMQPCPPMessagingClient-Examples"></a>2.
+ Examples
+ </h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
+ <a class="ulink" href="https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/" target="_top">AMQP C++ Client Examples </a>
+ </p></li><li class="listitem"><p>
+ <a class="ulink" href="https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/README.txt" target="_top">Running the AMQP C++ Client Examples </a>
+ </p></li></ul></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch12.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch12.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch13.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 12.
+ AMQP C++ Messaging Client
+ </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 13.
+ AMQP .NET Messaging Client
+ </td></tr></table></div></body></html>
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:commits-subscribe@qpid.apache.org