Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Exceptions.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Exceptions.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Exceptions.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Exceptions.xml Mon Dec 28 22:41:23 2015 @@ -1,10 +1,4 @@ <?xml version="1.0"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; -[ -<!ENTITY % entities SYSTEM "commonEntities.xml"> -%entities; -]> <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -26,11 +20,10 @@ --> -<appendix id="JMS-Client-0-8-Appendix-Exceptions"> +<appendix xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="JMS-Client-0-8-Appendix-Exceptions"> <title>Exceptions</title> - <para>The methods of Qpid JMS Client throw <ulink - url="&oracleJeeDocUrl;javax/jms/JMSException.html">JMSExceptions</ulink> in response to error + <para>The methods of Qpid JMS Client throw <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/JMSException.html">JMSExceptions</link> in response to error conditions. Typically the exception's message (#getMessage()) summarises the error condition, with contextual information being provided by the messages of linked exception(s). To understand the problem, it is important to read the messages associated with <emphasis>all</emphasis> the @@ -53,28 +46,20 @@ <row> <entry>AMQUnresolvedAddressException</entry> <entry><emphasis>message varies</emphasis></entry> - <entry><para>Indicates that the hostname included in the Connection URL's <link - linkend="JMS-Client-0-8-Connection-URL-ConnectionOptions-Brokerlist" - >brokerlist</link>, could not be resolved, . This could mean that the hostname is + <entry><para>Indicates that the hostname included in the Connection URL's <link linkend="JMS-Client-0-8-Connection-URL-ConnectionOptions-Brokerlist">brokerlist</link>, could not be resolved, . This could mean that the hostname is mispelt, or there is name resolution problem.</para></entry> </row> <row> <entry>AMQConnectionFailure</entry> <entry>Connection refused</entry> - <entry><para>Indicates that the host included in the Connection URL's <link - linkend="JMS-Client-0-8-Connection-URL-ConnectionOptions-Brokerlist" - >brokerlist</link>, actively refused the connection. This could mean that the + <entry><para>Indicates that the host included in the Connection URL's <link linkend="JMS-Client-0-8-Connection-URL-ConnectionOptions-Brokerlist">brokerlist</link>, actively refused the connection. This could mean that the hostname and/or port number is incorrect, or the Broker may not be running.</para></entry> </row> <row> <entry>AMQConnectionFailure</entry> <entry>connect timed out</entry> - <entry><para>Indicates that the host included in the Connection URL's <link - linkend="JMS-Client-0-8-Connection-URL-ConnectionOptions-Brokerlist" - >brokerlist</link>, could not be contacted within the <link - linkend="JMS-Client-0-8-Connection-URL-BrokerOptions-ConnectTimeout" - >connecttimeout</link>. This could mean that the host is shutdown, or a networking + <entry><para>Indicates that the host included in the Connection URL's <link linkend="JMS-Client-0-8-Connection-URL-ConnectionOptions-Brokerlist">brokerlist</link>, could not be contacted within the <link linkend="JMS-Client-0-8-Connection-URL-BrokerOptions-ConnectTimeout">connecttimeout</link>. This could mean that the host is shutdown, or a networking routing problem means the host is unreachable.</para></entry> </row> <row> @@ -90,8 +75,7 @@ <entry>AMQConnectionFailure / AMQAuthenticationException</entry> <entry>not allowed</entry> <entry><para>Indicates that the user cannot be authenticated by the Broker. Check the - username and/or password elements within the <link - linkend="JMS-Client-0-8-Connection-URL">Connection URL</link>.</para></entry> + username and/or password elements within the <link linkend="JMS-Client-0-8-Connection-URL">Connection URL</link>.</para></entry> </row> <row> <entry>AMQConnectionFailure / AMQSecurityException</entry> @@ -99,17 +83,14 @@ <entry><para>Indicates that the user is not authorised to connect to the given virtualhost. The user is recognised by the Broker and is using the correct password but does not have permission. This exception normally indicates that the user (or - group) has not been permissioned within the Broker's <ulink - url="&qpidJavaBrokerBook;Java-Broker-Security-ACLs.html">Access Control List - (ACL)</ulink>.</para></entry> + group) has not been permissioned within the Broker's <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidJavaBrokerBook;Java-Broker-Security-ACLs.html">Access Control List + (ACL)</link>.</para></entry> </row> <row> <entry>AMQTimeoutException</entry> <entry>Server did not respond in a timely fashion; Request Timeout</entry> <entry><para>Indicates that the broker did not respond to a request sent by the client in - a reasonable length of time. The timeout is governed by <link - linkend="JMS-Client-0-8-System-Properties-SyncOpTimeout" - ><literal>qpid.sync_op_timeout</literal></link>.</para><para>This can be a symptom + a reasonable length of time. The timeout is governed by <link linkend="JMS-Client-0-8-System-Properties-SyncOpTimeout"><literal>qpid.sync_op_timeout</literal></link>.</para><para>This can be a symptom of a heavily loaded broker that cannot respond or the Broker may have failed in unexpected manner. Check the broker and the host on which it runs and performance of its storage.</para></entry> @@ -119,16 +100,15 @@ <entry>Permission denied: <emphasis>message varies</emphasis></entry> <entry><para>Indicates that the user is not authorised to use the given resource or perform the given operation. This exception normally indicates that the user (or - group) has not been permissioned within the Broker's <ulink - url="&qpidJavaBrokerBook;Java-Broker-Security-ACLs.html">Access Control List - (ACL)</ulink>.</para></entry> + group) has not been permissioned within the Broker's <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidJavaBrokerBook;Java-Broker-Security-ACLs.html">Access Control List + (ACL)</link>.</para></entry> </row> </tbody> </tgroup> </table> <para>The following table describes some of the more common exceptions linked to JMSException sent - to <ulink url="&oracleJeeDocUrl;javax/jms/ExceptionListener.html">ExceptionListener</ulink> + to <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/ExceptionListener.html">ExceptionListener</link> instances.</para> <table pgwide="1"> @@ -142,50 +122,41 @@ </row> </thead> <tbody> - <row id="JMS-Client-0-8-Appendix-Exceptions-AMQNoRouteException"> + <row xml:id="JMS-Client-0-8-Appendix-Exceptions-AMQNoRouteException"> <entry>AMQNoRouteException</entry> <entry>No Route for message [Exchange: <emphasis>exchange name</emphasis>, Routing key: <emphasis>routing key</emphasis>] [error code 312: no route]</entry> <entry><para>Indicate that the named exchange is unable to route a message to at least one queue.</para> <para>This will occur if a queue has been improperly bound to an exchange. Use the - Broker's management interface to check the bindings. See <xref - linkend="JMS-Client-0-8-Client-Understanding-MessageProducer-MandatoryMessage" - /></para></entry> + Broker's management interface to check the bindings. See <xref linkend="JMS-Client-0-8-Client-Understanding-MessageProducer-MandatoryMessage"/></para></entry> </row> - <row id="JMS-Client-0-8-Appendix-Exceptions-AMQNoConsumersException"> + <row xml:id="JMS-Client-0-8-Appendix-Exceptions-AMQNoConsumersException"> <entry>AMQNoConsumersException</entry> <entry>Immediate delivery is not possible. [error code 313: no consumers]</entry> <entry><para>Immediate delivery was requested by the MessageProducer, but as there are no consumers on any target queue, the message has been returned to the publisher. See - <xref linkend="JMS-Client-0-8-Client-Understanding-MessageProducer-ImmediateMessage" - /> + <xref linkend="JMS-Client-0-8-Client-Understanding-MessageProducer-ImmediateMessage"/> </para></entry> </row> <row> <entry>AMQDisconnectedException</entry> <entry>Server closed connection and reconnection not permitted</entry> - <entry><para>Indicates that the connection was closed by the Broker, and as <link - linkend="JMS-Client-0-8-Client-Understanding-Connection-Failover">failover + <entry><para>Indicates that the connection was closed by the Broker, and as <link linkend="JMS-Client-0-8-Client-Understanding-Connection-Failover">failover options</link> are not included in the Connection URL, the client has been unable to reestablish connection.</para> <para>The Connection is now closed and any attempt to use either Connection object, or - any objects created from the Connection will receive an <ulink - url="&oracleJeeDocUrl;javax/jms/IllegalStateException.html" - >IllegalStateException</ulink>.</para></entry> + any objects created from the Connection will receive an <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/IllegalStateException.html">IllegalStateException</link>.</para></entry> </row> - <row id="JMS-Client-0-8-Appendix-Exceptions-AMQDisconnectedException"> + <row xml:id="JMS-Client-0-8-Appendix-Exceptions-AMQDisconnectedException"> <entry>AMQDisconnectedException</entry> <entry>Server closed connection and no failover was successful</entry> <entry><para>Indicates that the connection was closed by the Broker. The client has tried - failover according to the rules of the <link - linkend="JMS-Client-0-8-Client-Understanding-Connection-Failover">failover + failover according to the rules of the <link linkend="JMS-Client-0-8-Client-Understanding-Connection-Failover">failover options</link>within the Connection URL, but these attempts were all unsuccessful.</para> <para>The Connection is now closed and any attempt to use either Connection object, or - any objects created from the Connection will receive an <ulink - url="&oracleJeeDocUrl;javax/jms/IllegalStateException.html" - >IllegalStateException</ulink>.</para></entry> + any objects created from the Connection will receive an <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/IllegalStateException.html">IllegalStateException</link>.</para></entry> </row> </tbody>
Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Maven.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Maven.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Maven.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Maven.xml Mon Dec 28 22:41:23 2015 @@ -1,10 +1,4 @@ <?xml version="1.0"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; -[ -<!ENTITY % entities SYSTEM "commonEntities.xml"> -%entities; -]> <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -26,7 +20,7 @@ --> -<appendix id="JMS-Client-0-8-Appendix-Maven"> +<appendix xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="JMS-Client-0-8-Appendix-Maven"> <title>Minimal Maven POM</title> <para> The following is a minimal Maven POM required to use the Qpid Client. It is suitable for use with the <link linkend="JMS-Client-0-8-Examples">examples</link> included in this @@ -35,32 +29,32 @@ <example> <title>Minimal Maven POM </title> <programlisting> - <![CDATA[ -<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> - <modelVersion>4.0.0</modelVersion> - <groupId>test</groupId> - <artifactId>test</artifactId> - <version>0.0.1-SNAPSHOT</version> - <dependencies> - <dependency> - <groupId>]]>&qpidClientGroupId;<![CDATA[</groupId> - <artifactId>]]>&qpidClientArtefactId;<![CDATA[</artifactId> - <version>]]>&qpidVersion;<![CDATA[</version> - </dependency> - <dependency> - <groupId>org.slf4j</groupId> - <artifactId>slf4j-log4j12</artifactId> - <version>1.6.4</version> - </dependency> - <dependency> - <groupId>org.apache.geronimo.specs</groupId> - <artifactId>geronimo-jms_1.1_spec</artifactId> - <version>1.1.1</version> - </dependency> - </dependencies> -</project> - ]]> + +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + <groupId>test</groupId> + <artifactId>test</artifactId> + <version>0.0.1-SNAPSHOT</version> + <dependencies> + <dependency> + <groupId>&qpidClientGroupId;</groupId> + <artifactId>&qpidClientArtefactId;</artifactId> + <version>&qpidVersion;</version> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + <version>1.6.4</version> + </dependency> + <dependency> + <groupId>org.apache.geronimo.specs</groupId> + <artifactId>geronimo-jms_1.1_spec</artifactId> + <version>1.1.1</version> + </dependency> + </dependencies> +</project> + </programlisting> </example> <para>Note: We use the SLF4J Binding for Log4J12 here, but any SLF4J Binding could be used Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-PooledConnectionFactory.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-PooledConnectionFactory.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-PooledConnectionFactory.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-PooledConnectionFactory.xml Mon Dec 28 22:41:23 2015 @@ -1,10 +1,4 @@ <?xml version="1.0"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; -[ -<!ENTITY % entities SYSTEM "commonEntities.xml"> -%entities; -]> <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -26,12 +20,10 @@ --> -<appendix id="JMS-Client-0-8-Appendix-PooledConnecytionFactory"> +<appendix xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="JMS-Client-0-8-Appendix-PooledConnecytionFactory"> <title>PooledConnectionFactory</title> <para>Qpid client provides <literal>PooledConnectionFactory</literal> which is a special - implementation of <ulink url="&oracleJeeDocUrl;javax/jms/ConnectionFactory.html" - >ConnectionFactory</ulink> supporting <ulink url="&oracleJeeDocUrl;javax/jms/Connection.html" - >Connection</ulink> pooling. </para> + implementation of <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/ConnectionFactory.html">ConnectionFactory</link> supporting <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Connection.html">Connection</link> pooling. </para> <para> The <literal>PooledConnectionFactory</literal> caches a predefined number of connections thus saving an application which connects frequently time. The <literal>Connection</literal> instance is taken from the pool whenever method @@ -40,8 +32,7 @@ <para>A user can configure a maximum allowed number of connections to remain in pool (10 by default) by calling <literal>PooledConnectionFactory#setMaxPoolSize(int)</literal>. When number of connections exceeds the value set for maximum pool size, - <literal>PooledConnectionFactory</literal> starts to work as a normal <ulink - url="&oracleJeeDocUrl;javax/jms/ConnectionFactory.html">ConnectionFactory</ulink> and creates + <literal>PooledConnectionFactory</literal> starts to work as a normal <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/ConnectionFactory.html">ConnectionFactory</link> and creates a new connection every time method <literal>PooledConnectionFactory#createConnection()</literal> is invoked.</para> <para>The <link linkend="JMS-Client-0-8-Connection-URL">Connection URL</link> is set by invoking @@ -55,15 +46,15 @@ Spring xml configuration. <example> <title>Example of configuring <emphasis>PooledConnectionFactory</emphasis> in spring xml configuration.</title> - <programlisting language="xml"><![CDATA[ -<bean id="pooledConnectionFactory" class="org.apache.qpid.client.PooledConnectionFactory"> - <!-- set maximum number of pool connections to 20--> - <property name="maxPoolSize" value="20"></property> - <!-- set the timeout for connection to remain open in pool without being used --> - <property name="connectionTimeout" value="60000"></property> - <!-- set connection URL as String --> - <property name="connectionURLString" value="amqp://guest:guest@clientid/default?brokerlist='tcp://localhost:5672?retries='300'&failover='nofailover''&maxprefetch='0'"></property> -</bean>]]></programlisting> + <programlisting language="xml"> +<bean id="pooledConnectionFactory" class="org.apache.qpid.client.PooledConnectionFactory"> + <!-- set maximum number of pool connections to 20--> + <property name="maxPoolSize" value="20"></property> + <!-- set the timeout for connection to remain open in pool without being used --> + <property name="connectionTimeout" value="60000"></property> + <!-- set connection URL as String --> + <property name="connectionURLString" value="amqp://guest:guest@clientid/default?brokerlist='tcp://localhost:5672?retries='300'&failover='nofailover''&maxprefetch='0'"></property> +</bean></programlisting> </example> </para> <para> @@ -74,19 +65,19 @@ <title>Examples of configuring <emphasis>PooledConnectionFactory</emphasis> with <emphasis>DefaultMessageListenerContainer</emphasis> and <emphasis>JmsTemplate</emphasis>.</title> - <programlisting language="xml"><![CDATA[ -<bean id="jmsProducerTemplate" class="org.springframework.jms.core.JmsTemplate"> - <!-- set reference to pooledConnectionFactory bean --> - <property name="connectionFactory" ref="pooledConnectionFactory"></property> - <property name="defaultDestination" ref="destination" /> -</bean> - -<bean id="jmsContainer" class="org.springframework.jms.listener.DefaultMessageListenerContainer"> - <!-- set reference to pooledConnectionFactory bean --> - <property name="connectionFactory" ref="pooledConnectionFactory"/> - <property name="destination" ref="destination"/> - <property name="messageListener" ref="messageListener" /> -</bean>]]></programlisting> + <programlisting language="xml"> +<bean id="jmsProducerTemplate" class="org.springframework.jms.core.JmsTemplate"> + <!-- set reference to pooledConnectionFactory bean --> + <property name="connectionFactory" ref="pooledConnectionFactory"></property> + <property name="defaultDestination" ref="destination" /> +</bean> + +<bean id="jmsContainer" class="org.springframework.jms.listener.DefaultMessageListenerContainer"> + <!-- set reference to pooledConnectionFactory bean --> + <property name="connectionFactory" ref="pooledConnectionFactory"/> + <property name="destination" ref="destination"/> + <property name="messageListener" ref="messageListener" /> +</bean></programlisting> </example> </para> <note> Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Tomcat-JNDI-Integration.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Tomcat-JNDI-Integration.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Tomcat-JNDI-Integration.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Appendix-Tomcat-JNDI-Integration.xml Mon Dec 28 22:41:23 2015 @@ -1,10 +1,4 @@ <?xml version="1.0"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; -[ -<!ENTITY % entities SYSTEM "commonEntities.xml"> -%entities; -]> <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -26,23 +20,23 @@ --> -<appendix id="JMS-Client-0-8-Appendix-Tomcat-JNDI-Integration"> +<appendix xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="JMS-Client-0-8-Appendix-Tomcat-JNDI-Integration"> <title>How to bind Qpid destinations and connection factories into Tomcat JNDI</title> <para> Qpid client destinations and connection factories can be registered in external JNDI containers, for example, Tomcat JNDI implementation. </para> <para> <literal>org.apache.qpid.jndi.ObjectFactory</literal> implements - <ulink url="&oracleJdkDocUrl;javax/naming/spi/ObjectFactory.html">javax.naming.spi.ObjectFactory</ulink> + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/spi/ObjectFactory.html">javax.naming.spi.ObjectFactory</link> allowing it to create instances of <literal>AMQConnectionFactory</literal>, <literal>PooledConnectionFactory</literal>, <literal>AMQConnection</literal>, <literal>AMQQueue</literal> and <literal>AMQTopic</literal> in external JNDI container from - <ulink url="&oracleJdkDocUrl;javax/naming/Reference.html">javax.naming.Reference</ulink>s. + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/Reference.html">javax.naming.Reference</link>s. </para> <para>Additionally, <literal>AMQConnectionFactory</literal>, <literal>PooledConnectionFactory</literal> and <literal>AMQDestination</literal> (parent of <literal>AMQQueue</literal> and <literal>AMQTopic</literal>) implement - <ulink url="&oracleJdkDocUrl;javax/naming/Referenceable.html">javax.naming.Referenceable</ulink> - allowing creation of <ulink url="&oracleJdkDocUrl;javax/naming/Reference.html">javax.naming.Reference</ulink> objects + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/Referenceable.html">javax.naming.Referenceable</link> + allowing creation of <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/Reference.html">javax.naming.Reference</link> objects for binding in external JNDI implementations. </para> <para> @@ -51,7 +45,7 @@ <listitem> <para> an instance of <literal>ConnectionFactory</literal> from a <literal>Reference</literal> containing reference - address (<ulink url="&oracleJdkDocUrl;javax/naming/RefAddr.html">javax.naming.RefAddr</ulink>) + address (<link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/RefAddr.html">javax.naming.RefAddr</link>) <literal>connectionURL</literal> with content set to a <link linkend="JMS-Client-0-8-Connection-URL">Connection URL</link>. </para> @@ -59,7 +53,7 @@ <listitem> <para> an instance of <literal>PooledConnectionFactory</literal> from a <literal>Reference</literal> containing reference - address (<ulink url="&oracleJdkDocUrl;javax/naming/RefAddr.html">javax.naming.RefAddr</ulink>) + address (<link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/RefAddr.html">javax.naming.RefAddr</link>) <literal>connectionURL</literal> with content set to a <link linkend="JMS-Client-0-8-Connection-URL">Connection URL</link>. </para> @@ -67,7 +61,7 @@ <listitem> <para> an instance of <literal>AMQConnection</literal> from a <literal>Reference</literal> containing reference - address (<ulink url="&oracleJdkDocUrl;javax/naming/RefAddr.html">javax.naming.RefAddr</ulink>) + address (<link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/RefAddr.html">javax.naming.RefAddr</link>) <literal>connectionURL</literal> with content set to a <link linkend="JMS-Client-0-8-Connection-URL">Connection URL</link>. </para> @@ -75,16 +69,16 @@ <listitem> <para> an instance of <literal>AMQQueue</literal> from a <literal>Reference</literal> containing reference - address (<ulink url="&oracleJdkDocUrl;javax/naming/RefAddr.html">javax.naming.RefAddr</ulink>) - <literal>address</literal> with content set to either <ulink url="&qpidProgrammingBook;">Address</ulink> or + address (<link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/RefAddr.html">javax.naming.RefAddr</link>) + <literal>address</literal> with content set to either <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidProgrammingBook;">Address</link> or <link linkend="JMS-Client-0-8-Binding-URL">Binding URL</link>. </para> </listitem> <listitem> <para> an instance of <literal>AMQTopic</literal> from a <literal>Reference</literal> containing reference - address (<ulink url="&oracleJdkDocUrl;javax/naming/RefAddr.html">javax.naming.RefAddr</ulink>) - <literal>address</literal> with content set to either <ulink url="&qpidProgrammingBook;">Address</ulink> or + address (<link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/RefAddr.html">javax.naming.RefAddr</link>) + <literal>address</literal> with content set to either <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidProgrammingBook;">Address</link> or <link linkend="JMS-Client-0-8-Binding-URL">Binding URL</link>. </para> </listitem> @@ -93,7 +87,7 @@ <para> For <literal>AMQQueue</literal> and <literal>AMQTopic</literal> prefix <literal>BURL:</literal> need to be specified for <link linkend="JMS-Client-0-8-Binding-URL">Binding URL</link>. Otherwise, client will try - to parse content using <ulink url="&qpidProgrammingBook;">Address</ulink> format. + to parse content using <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidProgrammingBook;">Address</link> format. </para> </note> </para> @@ -102,33 +96,33 @@ </para> <example> <title>An example of Tomcat context.xml declaring Qpid JNDI resources</title> - <programlisting language="xml"><![CDATA[ -<?xml version='1.0' encoding='utf-8'?> -<!DOCTYPE xml> -<Context> + <programlisting language="xml"> +<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE xml> +<Context> - <Resource name="jms/connectionFactory" auth="Container" + <Resource name="jms/connectionFactory" auth="Container" type="org.apache.qpid.client.AMQConnectionFactory" factory="org.apache.qpid.jndi.ObjectFactory" - connectionURL="amqp://guest:guest@clientid/?brokerlist='localhost:5672'"/> + connectionURL="amqp://guest:guest@clientid/?brokerlist='localhost:5672'"/> - <Resource name="jms/pooledConnectionFactory" auth="Container" + <Resource name="jms/pooledConnectionFactory" auth="Container" type="org.apache.qpid.client.PooledConnectionFactory" factory="org.apache.qpid.jndi.ObjectFactory" connectionURL="amqp://guest:guest@clientid/?brokerlist='localhost:5672'" - maxPoolSize="20" connectionTimeout="60000"/> + maxPoolSize="20" connectionTimeout="60000"/> - <Resource name="jms/queue" auth="Container" + <Resource name="jms/queue" auth="Container" type="org.apache.qpid.client.AMQQueue" factory="org.apache.qpid.jndi.ObjectFactory" - address="BURL:direct://amq.direct//myQueue?durable='true'"/> + address="BURL:direct://amq.direct//myQueue?durable='true'"/> - <Resource name="jms/topic" auth="Container" + <Resource name="jms/topic" auth="Container" type="org.apache.qpid.client.AMQTopic" factory="org.apache.qpid.client.AMQConnectionFactory" - address="BURL:topic://amq.topic//myTopic?routingkey='myTopic'"/> + address="BURL:topic://amq.topic//myTopic?routingkey='myTopic'"/> -</Context>]]></programlisting> +</Context></programlisting> </example> <para>In the example above <literal>AMQConnectionFactory</literal> would be registered under JNDI name "jms/connectionFactory", <literal>PooledConnectionFactory</literal> would be registered under JNDI name "jms/pooledConnectionFactory", @@ -142,7 +136,7 @@ </para> <example> <title>An example of JNDI lookup for Qpid resources registered in Tomcat JNDI</title> - <programlisting language="java"><![CDATA[ + <programlisting language="java"> Context context = new InitialContext(); Context environmentContext = (Context)context.lookup("java:comp/env"); ... @@ -151,41 +145,41 @@ Queue queue = (Queue)environmentContext.lookup("jms/queue"); ... Topic topic = (Topic)environmentContext.lookup("jms/topic"); - ...]]></programlisting> + ...</programlisting> </example> <note> <para> In order to support backward compatibility <literal>AMQConnectionFactory</literal> continues to implement - <ulink url="&oracleJdkDocUrl;javax/naming/spi/ObjectFactory.html">javax.naming.spi.ObjectFactory</ulink> + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/spi/ObjectFactory.html">javax.naming.spi.ObjectFactory</link> and can be used to instantiate JNDI resources from - <ulink url="&oracleJdkDocUrl;javax/naming/Reference.html">javax.naming.Reference</ulink>s. + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/Reference.html">javax.naming.Reference</link>s. However, its method <literal>getObjectInstance</literal> is marked as <literal>Deprecated</literal> and will be removed in future version of client. For backward compatibility, Qpid JNDI resources can be declared using fully qualified class names as addresses. That will became unsupported in future version as well. An example of Tomcat context.xml with declarations of JNDI resources using deprecated factory and addresses is provided below. <example> <title>An example of Tomcat context.xml declaring Qpid JNDI resources using deprecated <literal>ObjectFactory</literal> and deprecated addresses</title> - <programlisting language="xml"><![CDATA[ -<?xml version='1.0' encoding='utf-8'?> -<!DOCTYPE xml> -<Context> + <programlisting language="xml"> +<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE xml> +<Context> - <Resource name="jms/queue" auth="Container" + <Resource name="jms/queue" auth="Container" type="org.apache.qpid.client.AMQQueue" factory="org.apache.qpid.client.AMQConnectionFactory" - org.apache.qpid.client.AMQQueue="direct://amq.direct//myDurableQueue?durable='true'"/> + org.apache.qpid.client.AMQQueue="direct://amq.direct//myDurableQueue?durable='true'"/> - <Resource name="jms/topic" auth="Container" + <Resource name="jms/topic" auth="Container" type="org.apache.qpid.client.AMQTopic" factory="org.apache.qpid.client.AMQConnectionFactory" - org.apache.qpid.client.AMQTopic="topic://amq.topic//myTopic?routingkey='myTopic'"/> + org.apache.qpid.client.AMQTopic="topic://amq.topic//myTopic?routingkey='myTopic'"/> - <Resource name="jms/connectionFactory" auth="Container" + <Resource name="jms/connectionFactory" auth="Container" type="org.apache.qpid.client.AMQConnectionFactory" factory="org.apache.qpid.client.AMQConnectionFactory" - org.apache.qpid.client.AMQConnectionFactory="amqp://guest:guest@clientid/?brokerlist='localhost:5672'"/> + org.apache.qpid.client.AMQConnectionFactory="amqp://guest:guest@clientid/?brokerlist='localhost:5672'"/> -</Context>]]></programlisting> +</Context></programlisting> </example> </para> </note> Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Binding-URL.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Binding-URL.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Binding-URL.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Binding-URL.xml Mon Dec 28 22:41:23 2015 @@ -1,10 +1,4 @@ <?xml version="1.0"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; -[ -<!ENTITY % entities SYSTEM "commonEntities.xml"> -%entities; -]> <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -26,18 +20,17 @@ --> -<chapter id="JMS-Client-0-8-Binding-URL"> +<chapter xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="JMS-Client-0-8-Binding-URL"> <title>Binding URL</title> <para> The <emphasis>Binding URL</emphasis> syntax for addressing<footnote> - <para>The client also supports the ADDR format. This is documented in <ulink - url="&qpidProgrammingBook;">Programming in Apache Qpid</ulink>.</para> + <para>The client also supports the ADDR format. This is documented in <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidProgrammingBook;">Programming in Apache Qpid</link>.</para> </footnote>. It allows the specification of the bindings between a queue and an exchange, queue and exchange creation arguments and some ancillary options.</para> - <para> The format for a <emphasis>Binding URL</emphasis> is provided below <screen><![CDATA[ -<Exchange Class>://<Exchange Name>/[<Destination>]/[<Queue>][?<option>='<value>'[&<option>='<value>']] - ]]></screen> where <itemizedlist> + <para> The format for a <emphasis>Binding URL</emphasis> is provided below <screen> +<Exchange Class>://<Exchange Name>/[<Destination>]/[<Queue>][?<option>='<value>'[&<option>='<value>']] + </screen> where <itemizedlist> <listitem> <para><emphasis>Exchange Class</emphasis>, specifies the type of the exchange, for example, <emphasis>direct</emphasis>,<emphasis>topic</emphasis>,<emphasis>fanout</emphasis>, etc. @@ -72,8 +65,7 @@ <emphasis>must</emphasis> be surrounded with single quotes ('). </para> </important> - <para> The following <emphasis>Binding URL</emphasis> options are currently defined: <table - pgwide="1"> + <para> The following <emphasis>Binding URL</emphasis> options are currently defined: <table pgwide="1"> <title>Binding URL options </title> <tgroup cols="3"> <thead> @@ -138,7 +130,7 @@ consumer, such consumer can only read messages on the queue but cannot consume them. The consumer behaves like a queue browser in this case.</para></entry> </row> - <row id="JMS-Client-0-8-Binding-URL-Options-RejectBehaviour"> + <row xml:id="JMS-Client-0-8-Binding-URL-Options-RejectBehaviour"> <entry><para>rejectbehaviour</para></entry> <entry><para>string </para></entry> <entry><para>Defines the reject behaviour for the re-delivered messages. If set to @@ -151,52 +143,52 @@ </table> </para> - <section id="JMS-Client-0-8-Binding-URL-Examples"> + <section xml:id="JMS-Client-0-8-Binding-URL-Examples"> <title>Binding URL Examples</title> - <section id="JMS-Client-0-8-Binding-URL-JMS-Queues" role="h4"> + <section xml:id="JMS-Client-0-8-Binding-URL-JMS-Queues" role="h4"> <title>Binding URLs for declaring of JMS Queues</title> <para>The Qpid client Binding URLs for JMS queue destinations can be declared using direct exchange (Mostly it is a pre-defined exchange with a name "amq.direct". Also, custom direct - exchanges can be used.): <screen><![CDATA[ -direct://amq.direct//<Queue Name> - ]]></screen> + exchanges can be used.): <screen> +direct://amq.direct//<Queue Name> + </screen> </para> <para>The Binding URLs for destinations created with calls to - <emphasis>Session.createQueue(String)</emphasis> can be expressed as <screen><![CDATA[ -direct://amq.direct//<Queue Name>?durable='true' - ]]></screen> The durability flag is set to <emphasis>true</emphasis> in such destinations. </para> + <emphasis>Session.createQueue(String)</emphasis> can be expressed as <screen> +direct://amq.direct//<Queue Name>?durable='true' + </screen> The durability flag is set to <emphasis>true</emphasis> in such destinations. </para> <example> <title>Binding URL examples for JMS queues</title> - <screen><![CDATA[ + <screen> direct://amq.direct//myNonDurableQueue direct://amq.direct//myDurableQueue?durable='true' -direct://amq.direct//myAnotherQueue?durable='true'&routingkey='myqueue' -direct://amq.direct//myQueue?durable='true'&routingkey='myqueue'&rejectbehaviour='server' +direct://amq.direct//myAnotherQueue?durable='true'&routingkey='myqueue' +direct://amq.direct//myQueue?durable='true'&routingkey='myqueue'&rejectbehaviour='server' direct://custom.direct//yetAnotherQueue - ]]></screen> + </screen> </example> </section> - <section id="JMS-Client-0-8-Binding-URL-JMS-Topics" role="h4"> + <section xml:id="JMS-Client-0-8-Binding-URL-JMS-Topics" role="h4"> <title>Binding URLs for declaring of JMS Topics</title> <para>The Binding URLs for JMS queue destinations can be declared using topic exchange (A pre-defined exchange having name "amq.topic" is used mainly. However, custom topic exchanges - can be used as well): <screen><![CDATA[ -topic://amq.topic//<Queue name>?routingkey='<Topic Name>'&exclusive='true'&autodelete='true' - ]]></screen> + can be used as well): <screen> +topic://amq.topic//<Queue name>?routingkey='<Topic Name>'&exclusive='true'&autodelete='true' + </screen> </para> <para>The Binding URLs for a topic destination created with calls to <emphasis>Session.createTopic("hello")</emphasis> is provided below: <example> <title>Binding URL examples for JMS topics</title> - <screen><![CDATA[ -topic://amq.topic/hello/tmp_127_0_0_1_36973_1?routingkey='hello'&exclusive='true'&autodelete='true' - ]]></screen> + <screen> +topic://amq.topic/hello/tmp_127_0_0_1_36973_1?routingkey='hello'&exclusive='true'&autodelete='true' + </screen> </example> </para> </section> - <section id="JMS-Client-0-8-Binding-URL-Topics-Wildcards" role="h4"> + <section xml:id="JMS-Client-0-8-Binding-URL-Topics-Wildcards" role="h4"> <title>Wildcard characters in routing keys for topic destinations</title> <para> AMQP exchanges of class <emphasis>topic</emphasis> can route messages to the queues using special matches containing wildcard characters (a "#" matches one or more words, a "*" @@ -205,15 +197,15 @@ topic://amq.topic/hello/tmp_127_0_0_1_36 the destination like "usa.#", it should receive all the messages matching to that routing key. For example, "usa.boston", "usa.new-york", etc. </para> <para> The examples of the <emphasis>Binding URLs</emphasis> having routing keys with - wildcards characters are provided below: <screen><![CDATA[ + wildcards characters are provided below: <screen> topic://amq.topic?routingkey='stocks.#' topic://amq.topic?routingkey='stocks.*.ibm' topic://amq.topic?routingkey='stocks.nyse.ibm' - ]]></screen> + </screen> </para> </section> - <section id="JMS-Client-0-8-Binding-URL-Extra-Examples" role="h4"> + <section xml:id="JMS-Client-0-8-Binding-URL-Extra-Examples" role="h4"> <title>More Examples</title> <table> <title>Binding URL examples</title> Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Book.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Book.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Book.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Book.xml Mon Dec 28 22:41:23 2015 @@ -20,7 +20,7 @@ --> -<book xmlns:xi="http://www.w3.org/2001/XInclude";> +<book xmlns="http://docbook.org/ns/docbook"; version="5.0"> <title>Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</title> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="JMS-Client-Introduction.xml"/> Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Connection-URL.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Connection-URL.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Connection-URL.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Connection-URL.xml Mon Dec 28 22:41:23 2015 @@ -1,10 +1,4 @@ <?xml version="1.0"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; -[ -<!ENTITY % entities SYSTEM "commonEntities.xml"> -%entities; -]> <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -26,17 +20,17 @@ --> -<chapter id="JMS-Client-0-8-Connection-URL"> +<chapter xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="JMS-Client-0-8-Connection-URL"> <title>Connection URLs</title> <para> In JNDI properties, a Connection URL specifies options for a connection. The format for a Connection URL is: </para> - <programlisting><![CDATA[amqp://[<user>:<pass>@][<clientid>]/[<virtualhost>][?<option>='<value>'[&<option>='<value>']*]]]></programlisting> + <programlisting>amqp://[<user>:<pass>@][<clientid>]/[<virtualhost>][?<option>='<value>'[&<option>='<value>']*]</programlisting> <para> For instance, the following Connection URL specifies a user name, a password, a client ID, a virtual host ("test"), a broker list with a single broker: a TCP host with the host name <quote>localhost</quote> using port 5672: </para> - <programlisting><![CDATA[amqp://username:password@clientid/test?brokerlist='tcp://localhost:5672']]></programlisting> + <programlisting>amqp://username:password@clientid/test?brokerlist='tcp://localhost:5672'</programlisting> <important> <title>Connection option quoting</title> @@ -45,7 +39,7 @@ </important> <para>The Connection URL supports the following options:</para> - <table pgwide="1" id="JMS-Client-0-8-Connection-URL-Options"> + <table pgwide="1" xml:id="JMS-Client-0-8-Connection-URL-Options"> <title>Connection URL Options</title> <tgroup cols="3"> <thead> @@ -56,25 +50,24 @@ </row> </thead> <tbody> - <row id="JMS-Client-0-8-Connection-URL-ConnectionOptions-Brokerlist"> + <row xml:id="JMS-Client-0-8-Connection-URL-ConnectionOptions-Brokerlist"> <entry> brokerlist </entry> <entry> see below </entry> <entry> List of one or more broker addresses. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-ConnectionOptions-Maxprefetch"> + <row xml:id="JMS-Client-0-8-Connection-URL-ConnectionOptions-Maxprefetch"> <entry> maxprefetch </entry> <entry> integer </entry> <entry> <para> The maximum number of pre-fetched messages per Session. If not specified, default value of 500 is used. </para> <para> Note: You can also set the default per-session prefetch value on a - client-wide basis by configuring the client using <link - linkend="JMS-Client-0-8-System-Properties">Java system + client-wide basis by configuring the client using <link linkend="JMS-Client-0-8-System-Properties">Java system properties.</link> </para> </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-ConnectionOptions-SyncPublish"> + <row xml:id="JMS-Client-0-8-Connection-URL-ConnectionOptions-SyncPublish"> <entry> sync_publish </entry> <entry> String </entry> <entry> @@ -93,14 +86,14 @@ <entry> A sync command is sent after every acknowledgement to guarantee that it has been received. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-ConnectionOptions-UseLegacyMap"> + <row xml:id="JMS-Client-0-8-Connection-URL-ConnectionOptions-UseLegacyMap"> <entry> use_legacy_map_msg_format </entry> <entry> Boolean </entry> <entry> If you are using JMS Map messages and deploying a new client with any JMS client older than 0.8 release, you must set this to true to ensure the older clients can understand the map message encoding. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-ConnectionOptions-Failover"> + <row xml:id="JMS-Client-0-8-Connection-URL-ConnectionOptions-Failover"> <entry> failover </entry> <entry> {'singlebroker' | 'roundrobin' ,<!-- Cpp/0-10 only | 'failover_exchange' --> | 'nofailover' | @@ -128,13 +121,11 @@ multiple brokers, or <literal>singlebroker</literal> otherwise. </para> </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-ConnectionOptions-CloseWhenNoRoute"> + <row xml:id="JMS-Client-0-8-Connection-URL-ConnectionOptions-CloseWhenNoRoute"> <entry> closeWhenNoRoute </entry> <entry> boolean </entry> <entry> - <para>See <xref - linkend="JMS-Client-0-8-Client-Understanding-MessageProducer-CloseWhenNoRoute" - />.</para> + <para>See <xref linkend="JMS-Client-0-8-Client-Understanding-MessageProducer-CloseWhenNoRoute"/>.</para> </entry> </row> <row> @@ -148,12 +139,12 @@ <para> Introduced in version 0.22. </para> </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-ConnectionOptions-CompressMessages"> + <row xml:id="JMS-Client-0-8-Connection-URL-ConnectionOptions-CompressMessages"> <entry>compressMessages</entry> <entry>Boolean</entry> <entry><para>Controls whether the client will compress messages before they they are sent.</para></entry> </row> - <row id="JMS-Client-0-8-Connection-URL-ConnectionOptions-MessageCompressionThresholdSize"> + <row xml:id="JMS-Client-0-8-Connection-URL-ConnectionOptions-MessageCompressionThresholdSize"> <entry>messageCompressionThresholdSize</entry> <entry>Integer</entry> <entry><para>The payload size beyond which the client will start to compress message payloads.</para></entry> @@ -163,10 +154,10 @@ </table> <para> Broker lists are specified using a URL in this format: </para> - <programlisting><![CDATA[brokerlist='<transport>://<host>[:<port>][?<param>='<value>'[&<param>='<value>']*]']]></programlisting> + <programlisting>brokerlist='<transport>://<host>[:<port>][?<param>='<value>'[&<param>='<value>']*]'</programlisting> <para> For instance, this is a typical broker list: </para> - <programlisting><![CDATA[brokerlist='tcp://localhost:5672']]></programlisting> + <programlisting>brokerlist='tcp://localhost:5672'</programlisting> <para> A broker list can contain more than one broker address separated by semicolons (;). If so, the connection is made to the first broker in the list that is available. @@ -178,18 +169,18 @@ <title>Broker Lists</title> <para>A broker list can specify properties to be used when connecting to the broker. This broker list specifies options for configuring heartbeating</para> - <programlisting><![CDATA[amqp://guest:guest@test/test?brokerlist='tcp://ip1:5672?heartbeat='5'']]></programlisting> + <programlisting>amqp://guest:guest@test/test?brokerlist='tcp://ip1:5672?heartbeat='5''</programlisting> <para>This broker list specifies some SSL options</para> - <programlisting><![CDATA[amqp://guest:guest@test/test?brokerlist='tcp://ip1:5672?ssl='true'&ssl_cert_alias='cert1'']]></programlisting> + <programlisting>amqp://guest:guest@test/test?brokerlist='tcp://ip1:5672?ssl='true'&ssl_cert_alias='cert1''</programlisting> <para> This broker list specifies two brokers using the connectdelay and retries broker options. It also illustrates the failover connection URL property. </para> - <programlisting><![CDATA[amqp://guest:guest@/test?failover='roundrobin?cyclecount='2'' - &brokerlist='tcp://ip1:5672?retries='5'&connectdelay='2000';tcp://ip2:5672?retries='5'&connectdelay='2000'' - ]]></programlisting> + <programlisting>amqp://guest:guest@/test?failover='roundrobin?cyclecount='2'' + &brokerlist='tcp://ip1:5672?retries='5'&connectdelay='2000';tcp://ip2:5672?retries='5'&connectdelay='2000'' + </programlisting> </example> <important> @@ -212,7 +203,7 @@ </row> </thead> <tbody> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-Heartbeat"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-Heartbeat"> <entry> heartbeat </entry> <entry> Long </entry> <entry> Frequency of heartbeat messages (in seconds). A value of 0 disables @@ -266,25 +257,25 @@ URL option <literal>ssl</literal>.</para> </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-TrustStore"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-TrustStore"> <entry> trust_store </entry> <entry> String </entry> <entry> Path to trust store. Used when using SSL and the Broker's certificate is signed by a private-CA (or a self-signed certificate),</entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-TrustStorePassword"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-TrustStorePassword"> <entry> trust_store_password </entry> <entry> String </entry> <entry> Trust store password. Password used to open the trust store. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-TrustedCertsPath"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-TrustedCertsPath"> <entry> trusted_certs_path </entry> <entry> String </entry> <entry> Path to a file containing trusted peer certificates(in PEM or DER format). Used when supplying the trust information for TLS client auth using PEM/DER files rather than a Java KeyStore. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-KeyStore"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-KeyStore"> <entry> key_store </entry> <entry> String </entry> <entry> Path to key store . Used when using SSL and the client must authenticate @@ -292,13 +283,13 @@ <literal>ssl_cert_alias</literal> must be used to identify the certificate that the client must present to the Broker.</entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-KeyStorePassword"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-KeyStorePassword"> <entry> key_store_password </entry> <entry> String </entry> <entry> Key store password. Password used to open the key store. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-ClientCertPath"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-ClientCertPath"> <entry> client_cert_path </entry> <entry> String </entry> <entry> Path to the client certificate file (in PEM or DER format). Used as an @@ -306,14 +297,14 @@ for TLS client auth. When used, the <literal>client_cert_priv_key_path</literal> must also be supplied. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-ClientCertPrivKeyPath"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-ClientCertPrivKeyPath"> <entry> client_cert_priv_key_path </entry> <entry> String </entry> <entry> Path to the client certificate private key file (in PEM or DER format). Used when supplying the key information for TLS client auth using PEM/DER files rather than a Java KeyStore. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-ClientCertsIntermediaryCertPath"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-ClientCertsIntermediaryCertPath"> <entry> client_cert_intermediary_cert_path </entry> <entry> String </entry> <entry> Path to a file containing any intermediary certificates (in PEM or DER format). @@ -322,7 +313,7 @@ are required in the certificate chain. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-SslCertAlias"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-SslCertAlias"> <entry> ssl_cert_alias </entry> <entry> String </entry> <entry> If multiple certificates are present in the keystore, the alias will be @@ -336,19 +327,19 @@ <literal>ssl_verify_hostname='false'</literal>. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-Retries"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-Retries"> <entry> retries </entry> <entry> Integer </entry> <entry> The number of times to retry connection to each broker in the broker list. Defaults to 1. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-ConnectDelay"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-ConnectDelay"> <entry> connectdelay </entry> <entry> integer </entry> <entry> Length of time (in milliseconds) to wait before attempting to reconnect. Defaults to 0. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-ConnectTimeout"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-ConnectTimeout"> <entry> connecttimeout </entry> <entry> integer </entry> <entry> Length of time (in milliseconds) to wait for the socket connection to @@ -356,7 +347,7 @@ attempt will block until established or an error occurs. Defaults to 30000. </entry> </row> - <row id="JMS-Client-0-8-Connection-URL-BrokerOptions-TcpNoDelay"> + <row xml:id="JMS-Client-0-8-Connection-URL-BrokerOptions-TcpNoDelay"> <entry> tcp_nodelay </entry> <entry> Boolean </entry> <entry> If <literal>tcp_nodelay='true'</literal>, TCP packet batching is Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Document-Scope-And-Intended-Audience.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Document-Scope-And-Intended-Audience.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Document-Scope-And-Intended-Audience.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Document-Scope-And-Intended-Audience.xml Mon Dec 28 22:41:23 2015 @@ -1,10 +1,4 @@ <?xml version="1.0"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; -[ -<!ENTITY % entities SYSTEM "commonEntities.xml"> -%entities; -]> <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -26,7 +20,7 @@ --> -<chapter id="JMS-Client-0-8-Document-Scope-And-Intended-Audience"> +<chapter xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="JMS-Client-0-8-Document-Scope-And-Intended-Audience"> <title>Document Scope And Intended Audience</title> <para> The intended audience of this document is Java developers who are familiar with the JMS @@ -34,8 +28,7 @@ knowledge of AMQP basic concepts would be advantageous for reading of this document. </para> <para> This document only covers the usage of 0-8, 0-9 and 0-9-1 AMQP protocols with Qpid JMS - client. The specifications for these protocols are available from the <ulink - url="&amqpSrc;">AMQP web site</ulink>. </para> + client. The specifications for these protocols are available from the <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&amqpSrc;">AMQP web site</link>. </para> <para> The document covers some specific implementation details of JMS connections, sessions, consumers and producers in <xref linkend="JMS-Client-0-8-Client-Understanding"/>. It also @@ -46,8 +39,7 @@ properties, connection URLs and JNDI configuration file. The setting of system properties is described in <xref linkend="JMS-Client-0-8-System-Properties"/>. The details of supported options within the connection URLs are given in <xref linkend="JMS-Client-0-8-Connection-URL"/>. - The details of Qpid JMS client JNDI properties format is provided in <xref - linkend="JMS-Client-0-8-JNDI-Properties-Format"/>. The Qpid destination URL format is covered + The details of Qpid JMS client JNDI properties format is provided in <xref linkend="JMS-Client-0-8-JNDI-Properties-Format"/>. The Qpid destination URL format is covered in <xref linkend="JMS-Client-0-8-Binding-URL"/>. </para> <para>The Qpid JMS Client can be used for writing of JMS vendor neutral messaging applications. @@ -58,7 +50,6 @@ <xref linkend="JMS-Client-0-8-Logging"/> provides the details about turning on client logging which can help in debugging of various issues while developing the messaging applications. </para> - <para>The details about Qpid JMS Client Exceptions are provided in <xref - linkend="JMS-Client-0-8-Appendix-Exceptions"/></para> + <para>The details about Qpid JMS Client Exceptions are provided in <xref linkend="JMS-Client-0-8-Appendix-Exceptions"/></para> </chapter> Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Examples.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Examples.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Examples.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Examples.xml Mon Dec 28 22:41:23 2015 @@ -1,10 +1,4 @@ <?xml version="1.0"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; -[ -<!ENTITY % entities SYSTEM "commonEntities.xml"> -%entities; -]> <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -26,7 +20,7 @@ --> -<chapter id="JMS-Client-0-8-Examples"> +<chapter xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="JMS-Client-0-8-Examples"> <title>Examples</title> <para>The following programs shows how to send and receive messages using the Qpid JMS client. @@ -36,9 +30,9 @@ the application needs. In this way the configuration is kept separate from the application code itself.</para> <para>The example code will be straightforward for anyone familiar with Java JMS. Readers in - need of an introduction are directed towards <ulink url="&oracleJmsTutorial;">Oracle's JMS - tutorial</ulink>.</para> - <section id="JMS-Client-0-8-Examples-PTP"> + need of an introduction are directed towards <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJmsTutorial;">Oracle's JMS + tutorial</link>.</para> + <section xml:id="JMS-Client-0-8-Examples-PTP"> <title>Point to point example</title> <para>In this example, we illustrate point to point messaging. We create a JNDI context using a properties file, use the context to lookup a connection factory, create and @@ -46,7 +40,7 @@ context. Then we create a producer and a consumer, send a message with the producer and receive it with the consumer.</para> - <example id="JMS-Client-0-8-Examples-PTP-Java"> + <example xml:id="JMS-Client-0-8-Examples-PTP-Java"> <title>JMS Example - Point to Point Messaging</title> <programlisting language="java"> import javax.jms.*; @@ -66,61 +60,61 @@ public class Hello { private void runTest() throws Exception { Properties properties = new Properties(); - properties.load(this.getClass().getResourceAsStream("helloworld.properties")); <co id="ptp-java-properties" linkends="callout-ptp-properties"/> - Context context = new InitialContext(properties); <co id="ptp-java-context" linkends="callout-ptp-context"/> + properties.load(this.getClass().getResourceAsStream("helloworld.properties")); <co xml:id="ptp-java-properties" linkends="callout-ptp-properties"/> + Context context = new InitialContext(properties); <co xml:id="ptp-java-context" linkends="callout-ptp-context"/> ConnectionFactory connectionFactory - = (ConnectionFactory) context.lookup("qpidConnectionFactory"); <co id="ptp-java-connection-factory" linkends="callout-ptp-connection-factory"/> - Connection connection = connectionFactory.createConnection(); <co id="ptp-java-connection" linkends="callout-ptp-connection"/> - connection.start(); <co id="ptp-java-start" linkends="callout-ptp-start"/> + = (ConnectionFactory) context.lookup("qpidConnectionFactory"); <co xml:id="ptp-java-connection-factory" linkends="callout-ptp-connection-factory"/> + Connection connection = connectionFactory.createConnection(); <co xml:id="ptp-java-connection" linkends="callout-ptp-connection"/> + connection.start(); <co xml:id="ptp-java-start" linkends="callout-ptp-start"/> - Session session = connection.createSession(true, Session.SESSION_TRANSACTED); <co id="ptp-java-session" linkends="callout-ptp-session"/> - Queue queue = (Queue) context.lookup("myqueue"); <co id="ptp-java-destination" linkends="callout-ptp-destination"/> + Session session = connection.createSession(true, Session.SESSION_TRANSACTED); <co xml:id="ptp-java-session" linkends="callout-ptp-session"/> + Queue queue = (Queue) context.lookup("myqueue"); <co xml:id="ptp-java-destination" linkends="callout-ptp-destination"/> - MessageConsumer messageConsumer = session.createConsumer(queue); <co id="ptp-java-consumer" linkends="callout-ptp-consumer"/> - MessageProducer messageProducer = session.createProducer(queue); <co id="ptp-java-producer" linkends="callout-ptp-producer"/> + MessageConsumer messageConsumer = session.createConsumer(queue); <co xml:id="ptp-java-consumer" linkends="callout-ptp-consumer"/> + MessageProducer messageProducer = session.createProducer(queue); <co xml:id="ptp-java-producer" linkends="callout-ptp-producer"/> - TextMessage message = session.createTextMessage("Hello world!"); <co id="ptp-java-send" linkends="callout-ptp-send"/> + TextMessage message = session.createTextMessage("Hello world!"); <co xml:id="ptp-java-send" linkends="callout-ptp-send"/> messageProducer.send(message); session.commit(); - message = (TextMessage)messageConsumer.receive(); <co id="ptp-java-receive" linkends="callout-ptp-receive"/> + message = (TextMessage)messageConsumer.receive(); <co xml:id="ptp-java-receive" linkends="callout-ptp-receive"/> session.commit(); System.out.println(message.getText()); - connection.close(); <co id="ptp-java-close" linkends="callout-ptp-close"/> - context.close(); <co id="ptp-java-jndi-close" linkends="callout-ptp-jndi-close"/> + connection.close(); <co xml:id="ptp-java-close" linkends="callout-ptp-close"/> + context.close(); <co xml:id="ptp-java-jndi-close" linkends="callout-ptp-jndi-close"/> } } </programlisting> </example> <calloutlist> - <callout id="callout-ptp-properties" arearefs="ptp-java-properties"> + <callout xml:id="callout-ptp-properties" arearefs="ptp-java-properties"> <para>Loads the JNDI properties file, which specifies the connection factory, queues and topics. See <xref linkend="JMS-Client-0-8-JNDI-Properties-Format"/> for details.</para> </callout> - <callout id="callout-ptp-context" arearefs="ptp-java-context"> + <callout xml:id="callout-ptp-context" arearefs="ptp-java-context"> <para>Creates the JNDI initial context.</para> </callout> - <callout id="callout-ptp-connection-factory" arearefs="ptp-java-connection-factory"> + <callout xml:id="callout-ptp-connection-factory" arearefs="ptp-java-connection-factory"> <para>Looks up a JMS connection factory for Qpid.</para> </callout> - <callout id="callout-ptp-connection" arearefs="ptp-java-connection"> + <callout xml:id="callout-ptp-connection" arearefs="ptp-java-connection"> <para>Creates a JMS connection. Creating the JMS connections establishes the connection to the Broker.</para> </callout> - <callout id="callout-ptp-start" arearefs="ptp-java-start"> + <callout xml:id="callout-ptp-start" arearefs="ptp-java-start"> <para>Starts the connection, required for the consumption of messages.</para> </callout> - <callout id="callout-ptp-session" arearefs="ptp-java-session"> + <callout xml:id="callout-ptp-session" arearefs="ptp-java-session"> <para>Creates a transactional session.</para> </callout> - <callout id="callout-ptp-destination" arearefs="ptp-java-destination"> + <callout xml:id="callout-ptp-destination" arearefs="ptp-java-destination"> <para>Looks up a destination for the queue with JNDI name <emphasis>myqueue</emphasis>.</para> </callout> - <callout id="callout-ptp-consumer" arearefs="ptp-java-consumer"> + <callout xml:id="callout-ptp-consumer" arearefs="ptp-java-consumer"> <para>Creates a consumer that reads messages from the queue<footnote> <para>Creating consumer will automatically create the queue on the Broker and bind it to an exchange. Specifically, in this case as the @@ -128,28 +122,26 @@ public class Hello { effect will be to create a queue called <literal>queue1</literal> on the Broker, and create a binding between the <literal>amq.direct</literal> exchange and this queue using the queue's name. This process is - described in detail in <xref - linkend="JMS-Client-0-8-Client-Understanding-MessageConsumer-ConsumerSideEffect" - /></para> + described in detail in <xref linkend="JMS-Client-0-8-Client-Understanding-MessageConsumer-ConsumerSideEffect"/></para> </footnote>.</para> </callout> - <callout id="callout-ptp-producer" arearefs="ptp-java-producer"> + <callout xml:id="callout-ptp-producer" arearefs="ptp-java-producer"> <para>Creates a producer that sends messages to the queue.</para> </callout> - <callout id="callout-ptp-send" arearefs="ptp-java-send"> + <callout xml:id="callout-ptp-send" arearefs="ptp-java-send"> <para>Creates a new message of type <emphasis>javax.jms.TextMessage</emphasis>, publishes the message and commits the session.</para> </callout> - <callout id="callout-ptp-receive" arearefs="ptp-java-receive"> + <callout xml:id="callout-ptp-receive" arearefs="ptp-java-receive"> <para>Reads the next available message (awaiting indefinitely if necessary) and commits the session.</para> </callout> - <callout id="callout-ptp-close" arearefs="ptp-java-close"> + <callout xml:id="callout-ptp-close" arearefs="ptp-java-close"> <para>Closes the Connection. All sessions owned by the Connection along with their MessageConsumers and MessageProducers are automatically closed. The connection to the Broker is closed as this point.</para> </callout> - <callout id="callout-ptp-jndi-close" arearefs="ptp-java-jndi-close"> + <callout xml:id="callout-ptp-jndi-close" arearefs="ptp-java-jndi-close"> <para>Closes the JNDI context.</para> </callout> </calloutlist> @@ -157,30 +149,27 @@ public class Hello { <para>The contents of the <literal>helloworld.properties</literal> file are shown below.</para> - <example id="JMS-Client-0-8-Examples-PTP-PropertiesFile"> + <example xml:id="JMS-Client-0-8-Examples-PTP-PropertiesFile"> <title>JMS Example - Point to Point Messaging - JNDI Properties</title> <programlisting language="properties"> java.naming.factory.initial = org.apache.qpid.jndi.PropertiesFileInitialContextFactory -connectionfactory.qpidConnectionFactory = amqp://guest:guest@clientid/?brokerlist='tcp://localhost:5672' <co id="ptp-properties-connectionfactory" linkends="callout-ptp-properties-connectionfactory"/> -queue.myqueue = queue1 <co id="ptp-properties-destination" linkends="callout-ptp-properties-destination"/> +connectionfactory.qpidConnectionFactory = amqp://guest:guest@clientid/?brokerlist='tcp://localhost:5672' <co xml:id="ptp-properties-connectionfactory" linkends="callout-ptp-properties-connectionfactory"/> +queue.myqueue = queue1 <co xml:id="ptp-properties-destination" linkends="callout-ptp-properties-destination"/> </programlisting> </example> <calloutlist> - <callout id="callout-ptp-properties-connectionfactory" - arearefs="ptp-properties-connectionfactory"> + <callout xml:id="callout-ptp-properties-connectionfactory" arearefs="ptp-properties-connectionfactory"> <para>Defines a connection factory from which Connections can be created. The syntax - of a ConnectionURL is given in <xref - linkend="JMS-Client-0-8-Connection-URL"/>.</para> + of a ConnectionURL is given in <xref linkend="JMS-Client-0-8-Connection-URL"/>.</para> </callout> - <callout id="callout-ptp-properties-destination" arearefs="ptp-properties-destination"> + <callout xml:id="callout-ptp-properties-destination" arearefs="ptp-properties-destination"> <para>Defines a queue for which MessageProducers and/or MessageConsumers send and - receive messages. The format of these entries is described in <xref - linkend="JMS-Client-0-8-JNDI-Properties-Format-Queue"/>.</para> + receive messages. The format of these entries is described in <xref linkend="JMS-Client-0-8-JNDI-Properties-Format-Queue"/>.</para> </callout> </calloutlist> </section> - <section id="JMS-Client-0-8-Examples-PubSub"> + <section xml:id="JMS-Client-0-8-Examples-PubSub"> <title>Publish/subscribe example</title> <para>In this second example, we illustrate publish/subscribe messaging. Again, we create a JNDI context using a properties file, use the context to lookup a connection factory, @@ -188,7 +177,7 @@ queue.myqueue = queue1 the JNDI context. Then we create a producer and two durable subscribers , send a message with the producer. Both subscribers receive the same message.</para> - <example id="JMS-Client-0-8-Examples-PubSub-Java"> + <example xml:id="JMS-Client-0-8-Examples-PubSub-Java"> <title>JMS Example - Publish/subscribe Messaging</title> <programlisting language="java"> import javax.jms.*; @@ -218,10 +207,10 @@ public class StocksExample { connection.start(); Session session = connection.createSession(true, Session.SESSION_TRANSACTED); - Topic priceTopic = (Topic) context.lookup("myprices"); <co id="pubsub-java-destination" linkends="callout-pubsub-destination"/> + Topic priceTopic = (Topic) context.lookup("myprices"); <co xml:id="pubsub-java-destination" linkends="callout-pubsub-destination"/> - MessageConsumer subscriber1 = session.createDurableSubscriber(priceTopic, "sub1"); <co id="pubsub-java-subscribers" linkends="callout-pubsub-subscribers"/> - MessageConsumer subscriber2 = session.createDurableSubscriber(priceTopic, "sub2" /*, "price > 150", false*/ ); + MessageConsumer subscriber1 = session.createDurableSubscriber(priceTopic, "sub1"); <co xml:id="pubsub-java-subscribers" linkends="callout-pubsub-subscribers"/> + MessageConsumer subscriber2 = session.createDurableSubscriber(priceTopic, "sub2" /*, "price > 150", false*/ ); MessageProducer messageProducer = session.createProducer(priceTopic); Message message = session.createMessage(); @@ -238,7 +227,7 @@ public class StocksExample { session.commit(); System.out.println("Subscriber 2 received : " + message); - session.unsubscribe("sub1"); <co id="pubsub-java-unsubscribe" linkends="callout-pubsub-unsubscribe"/> + session.unsubscribe("sub1"); <co xml:id="pubsub-java-unsubscribe" linkends="callout-pubsub-unsubscribe"/> session.unsubscribe("sub2"); connection.close(); context.close(); @@ -248,22 +237,20 @@ public class StocksExample { </example> <calloutlist> - <callout id="callout-pubsub-destination" arearefs="pubsub-java-destination"> + <callout xml:id="callout-pubsub-destination" arearefs="pubsub-java-destination"> <para>Looks up a destination for the topic with JNDI name myprices.</para> </callout> - <callout id="callout-pubsub-subscribers" arearefs="pubsub-java-subscribers"> + <callout xml:id="callout-pubsub-subscribers" arearefs="pubsub-java-subscribers"> <para>Creates two durable subscribers, <literal>sub1</literal> and <literal>sub2</literal>. Durable subscriptions retain messages for the client even when the client is disconnected, until the subscription is unsubscribed. Subscription 2 has a (commented out) message selector argument so you can conveniently experiement with the effect of those. <footnote> <para>Each durable subscription is implemented as a queue on the Broker. See - <xref - linkend="JMS-Client-0-8-Client-Understanding-MessageConsumer-TopicSubscriptions" - /> for details.</para> + <xref linkend="JMS-Client-0-8-Client-Understanding-MessageConsumer-TopicSubscriptions"/> for details.</para> </footnote></para> </callout> - <callout id="callout-pubsub-unsubscribe" arearefs="pubsub-java-unsubscribe"> + <callout xml:id="callout-pubsub-unsubscribe" arearefs="pubsub-java-unsubscribe"> <para>Unsubscribes the two durable subscribers, permanently removing the knowledge of the subscriptions from the system. An application would normally <emphasis>NOT</emphasis> do this. The typical use-case for durable @@ -274,21 +261,19 @@ public class StocksExample { <para>The contents of the <literal>stocks.properties</literal> file are shown below.</para> - <example id="JMS-Client-0-8-Examples-PubSub-PropertiesFile"> + <example xml:id="JMS-Client-0-8-Examples-PubSub-PropertiesFile"> <title>JMS Example - Publish/subscribe Messaging - JNDI Properties</title> <programlisting> java.naming.factory.initial = org.apache.qpid.jndi.PropertiesFileInitialContextFactory connectionfactory.qpidConnectionFactory = amqp://guest:guest@clientid/?brokerlist='tcp://localhost:5672' -topic.myprices = prices <co id="pubsub-properties-destination" linkends="callout-pubsub-properties-destination"/> +topic.myprices = prices <co xml:id="pubsub-properties-destination" linkends="callout-pubsub-properties-destination"/> </programlisting> </example> <calloutlist> - <callout id="callout-pubsub-properties-destination" - arearefs="pubsub-properties-destination"> + <callout xml:id="callout-pubsub-properties-destination" arearefs="pubsub-properties-destination"> <para>Defines a topic for which MessageProducers and/or MessageConsumers send and - receive messages. The format of this entry is described in <xref - linkend="JMS-Client-0-8-JNDI-Properties-Format-Topic"/>.</para> + receive messages. The format of this entry is described in <xref linkend="JMS-Client-0-8-JNDI-Properties-Format-Topic"/>.</para> </callout> </calloutlist> </section> Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Getting-And-Dependencies.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Getting-And-Dependencies.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Getting-And-Dependencies.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Getting-And-Dependencies.xml Mon Dec 28 22:41:23 2015 @@ -1,10 +1,4 @@ <?xml version="1.0"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; -[ -<!ENTITY % entities SYSTEM "commonEntities.xml"> -%entities; -]> <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -26,28 +20,27 @@ --> -<chapter id="JMS-Client-0-8-JMS-Getting-And-Dependencies"> +<chapter xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="JMS-Client-0-8-JMS-Getting-And-Dependencies"> <title>Getting the Client And Dependencies</title> - <section id="JMS-Client-0-8-JMS-Getting-And-Dependencies-Getting"> + <section xml:id="JMS-Client-0-8-JMS-Getting-And-Dependencies-Getting"> <title>Getting the Client</title> <para>The Qpid JMS client is available as a bundle or from &qpidMavenRepoDesc;.</para> <para>The bundle (a .tar.gz) includes the Qpid JMS client itself (formed by two JAR: qpid-client and qpid-common) together with slf4j-api, and geronimo-jms_1.1_spec. There is also a qpid-all JAR artifact that, for convenience, includes a manifest classpath that references the other - JARs. The bundle is available from <ulink url="&qpidDownloadUrl;" - >&qpidDownloadUrlDesc;</ulink>.</para> + JARs. The bundle is available from <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidDownloadUrl;">&qpidDownloadUrlDesc;</link>.</para> <para>The Qpid JMS client is also available from &qpidMavenRepoDesc;. Add the following dependency:</para> - <screen><![CDATA[ - <dependency> - <groupId>]]>&qpidClientGroupId;<![CDATA[</groupId> - <artifactId>]]>&qpidClientArtefactId;<![CDATA[</artifactId> - <version>]]>&qpidVersion;<![CDATA[</version> - </dependency> - ]]></screen> + <screen> + <dependency> + <groupId>&qpidClientGroupId;</groupId> + <artifactId>&qpidClientArtefactId;</artifactId> + <version>&qpidVersion;</version> + </dependency> + </screen> <para><xref linkend="JMS-Client-0-8-Appendix-Maven"/> illustrates a minimal Maven POM required to use the Qpid Client.</para> </section> - <section id="JMS-Client-0-8-JMS-Getting-And-Dependencies-Dependencies"> + <section xml:id="JMS-Client-0-8-JMS-Getting-And-Dependencies-Dependencies"> <title>Dependencies</title> <para>The Qpid JMS client has minimal set of external dependencies. </para> <para> It requires: <itemizedlist> @@ -58,7 +51,7 @@ <para>JMS 1.1 specification (such as geronimo-jms_1.1_spec JAR)</para> </listitem> <listitem> - <para><ulink url="http://www.slf4j.org";>Apache SLF4J</ulink> (slf4j-api-x.y.z JAR)</para> + <para><link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="http://www.slf4j.org";>Apache SLF4J</link> (slf4j-api-x.y.z JAR)</para> </listitem> </itemizedlist> </para> Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Introduction.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Introduction.xml?rev=1722019&r1=1722018&r2=1722019&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Introduction.xml (original) +++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Introduction.xml Mon Dec 28 22:41:23 2015 @@ -1,10 +1,4 @@ <?xml version="1.0"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; -[ -<!ENTITY % entities SYSTEM "commonEntities.xml"> -%entities; -]> <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -26,12 +20,10 @@ --> -<!-- TODO add dependencies + getting the client --> - -<chapter id="JMS-Client-0-8-Introduction"> +<chapter xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:id="JMS-Client-0-8-Introduction"> <title>Introduction</title> - <para>Qpid JMS client is an implementation of <ulink url="&oracleJmsSpec;">JMS specification - 1.1</ulink>. It utilises an <ulink url="&amqpSrc;">AMQP</ulink> transport layer for the performing of messaging operations. + <para>Qpid JMS client is an implementation of <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJmsSpec;">JMS specification + 1.1</link>. It utilises an <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&amqpSrc;">AMQP</link> transport layer for the performing of messaging operations. The client is intended to be used for the writing of JMS compatible messaging applications. Such applications can send and receive messages via any AMQP-compatible brokers like RabbitMQ, Qpid Java Broker which support the AMQP protocols 0-8, 0-9, or 0-9-1.</para> @@ -43,7 +35,7 @@ <title>Using the Qpid JMS client with 0-10</title> <para>This book documents the behaviour of the Qpid JMS client when used with the AMQP protocols <emphasis>0-8, 0-9, and 0-9-1</emphasis> only. For behaviour when using the client - with AMQP 0-10 protocol, please refer to <ulink url="&qpidProgrammingBook;">Programming in Apache Qpid</ulink>.</para> + with AMQP 0-10 protocol, please refer to <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidProgrammingBook;">Programming in Apache Qpid</link>.</para> </important> </chapter> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
