Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Document-Scope-And-Intended-Audience.xml (from r1722019, 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/jms-client-0-8/src/docbkx/JMS-Client-Document-Scope-And-Intended-Audience.xml?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Document-Scope-And-Intended-Audience.xml&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Document-Scope-And-Intended-Audience.xml&r1=1722019&r2=1722020&rev=1722020&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/jms-client-0-8/src/docbkx/JMS-Client-Document-Scope-And-Intended-Audience.xml Mon Dec 28 22:49:09 2015 @@ -28,7 +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 <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&amqpSrc;">AMQP web site</link>. </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
Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Examples.xml (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Examples.xml) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Examples.xml?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Examples.xml&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Examples.xml&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Examples.xml (original) +++ qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Examples.xml Mon Dec 28 22:49:09 2015 @@ -30,7 +30,7 @@ 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 <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJmsTutorial;">Oracle's JMS + 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> Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Getting-And-Dependencies.xml (from r1722019, 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/jms-client-0-8/src/docbkx/JMS-Client-Getting-And-Dependencies.xml?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Getting-And-Dependencies.xml&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Getting-And-Dependencies.xml&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Getting-And-Dependencies.xml (original) +++ qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Getting-And-Dependencies.xml Mon Dec 28 22:49:09 2015 @@ -24,18 +24,18 @@ <title>Getting the Client And Dependencies</title> <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 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 <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 + 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> <dependency> - <groupId>&qpidClientGroupId;</groupId> - <artifactId>&qpidClientArtefactId;</artifactId> - <version>&qpidVersion;</version> + <groupId>${qpidClientGroupId}</groupId> + <artifactId>${qpidClientArtefactId}</artifactId> + <version>${project.version}</version> </dependency> </screen> <para><xref linkend="JMS-Client-0-8-Appendix-Maven"/> illustrates a minimal Maven POM required to use the Qpid Client.</para> Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Introduction.xml (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Introduction.xml) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Introduction.xml?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Introduction.xml&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Introduction.xml&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Introduction.xml (original) +++ qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Introduction.xml Mon Dec 28 22:49:09 2015 @@ -22,8 +22,8 @@ <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 <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. + <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> @@ -35,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 <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidProgrammingBook;">Programming in Apache Qpid</link>.</para> + with AMQP 0-10 protocol, please refer to <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${qpidJmsBook}">Programming in Apache Qpid</link>.</para> </important> </chapter> Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-JMS-Extensions.xml (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-JMS-Extensions.xml) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-JMS-Extensions.xml?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-JMS-Extensions.xml&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-JMS-Extensions.xml&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== (empty) Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-JNDI-Properties-Format.xml (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-JNDI-Properties-Format.xml) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-JNDI-Properties-Format.xml?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-JNDI-Properties-Format.xml&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-JNDI-Properties-Format.xml&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-JNDI-Properties-Format.xml (original) +++ qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-JNDI-Properties-Format.xml Mon Dec 28 22:49:09 2015 @@ -42,21 +42,21 @@ destination.<jndi name>=<bindin <section xml:id="JMS-Client-0-8-JNDI-Properties-Format-ConnectionFactory"> <title>ConnectionFactory</title> - <para><literal>connectionfactory.</literal><emphasis>name</emphasis> declares a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/ConnectionFactory.html">ConnectionFactory</link> with the + <para><literal>connectionfactory.</literal><emphasis>name</emphasis> declares a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/ConnectionFactory.html">ConnectionFactory</link> with the given JNDI name. The value must be a legal Connection URL.</para> <para>See <xref linkend="JMS-Client-0-8-Connection-URL"/> for format of the URL and its permitted options.</para> </section> <section xml:id="JMS-Client-0-8-JNDI-Properties-Format-Queue"> <title>Queue</title> - <para><literal>queue.</literal><emphasis>name</emphasis> declares a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Queue.html">Queue</link> with the given JNDI name. The + <para><literal>queue.</literal><emphasis>name</emphasis> declares a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Queue.html">Queue</link> with the given JNDI name. The value is simple queue name. This is the name of the queue as known by the Broker.</para> <para>The <literal>queue.</literal> form is a short hand for declaring a destination:</para> <screen>destination.name=direct://amq.direct//<queue name>?routingkey=â<queue name>â&durable=âtrueâ</screen> </section> <section xml:id="JMS-Client-0-8-JNDI-Properties-Format-Topic"> <title>Topic</title> - <para><literal>topic.</literal><emphasis>name</emphasis> declares a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Topic.html">Topic</link> with the given JNDI name. The + <para><literal>topic.</literal><emphasis>name</emphasis> declares a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Topic.html">Topic</link> with the given JNDI name. The value is topic name. This topic name is used on the Broker as a binding key between the <literal>amq.topic</literal> exchange and the queue corresponding to the topic subscriber.</para> @@ -65,7 +65,7 @@ destination.<jndi name>=<bindin </section> <section xml:id="JMS-Client-0-8-JNDI-Properties-Format-Destination"> <title>Destination</title> - <para><literal>destination.</literal><emphasis>name</emphasis> declares either a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Queue.html">Queue</link> or <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Topic.html">Topic</link> (depending on the class) with the + <para><literal>destination.</literal><emphasis>name</emphasis> declares either a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Queue.html">Queue</link> or <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Topic.html">Topic</link> (depending on the class) with the given JNDI name. The value must be a Binding URL.</para> <para>See <xref linkend="JMS-Client-0-8-Binding-URL"/> for format of the URL and its permitted options.</para> Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Logging.xml (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Logging.xml) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Logging.xml?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Logging.xml&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Logging.xml&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Logging.xml (original) +++ qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Logging.xml Mon Dec 28 22:49:09 2015 @@ -27,7 +27,7 @@ is a is a façade for other common logging frameworks. This makes it easy for application authors to use their prefered logging framework in their application stack, and have the Qpid JMS Client use it too. </para> - <para>SLF4J suppplies bindings for many common logging frameworks (<link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;java/util/logging/package-summary.html">JUL</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="http://logging.apache.org/log4j/1.2/";>Apache Log4J</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="http://logback.qos.ch";>Logback</link>.</para> + <para>SLF4J suppplies bindings for many common logging frameworks (<link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJdkDocUrl}java/util/logging/package-summary.html">JUL</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="http://logging.apache.org/log4j/1.2/";>Apache Log4J</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="http://logback.qos.ch";>Logback</link>.</para> <para>Include the SLF4J binding corresponding to the logging framework of your choosen logging framework on classpath. For full details, see the SLF4J <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="http://www.slf4j.org";>documentation</link>.</para> Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-System-Properties.xml (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-System-Properties.xml) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-System-Properties.xml?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-System-Properties.xml&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-System-Properties.xml&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-System-Properties.xml (original) +++ qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-System-Properties.xml Mon Dec 28 22:49:09 2015 @@ -195,7 +195,7 @@ <entry>true</entry> <entry><para>If true, creating a consumer will also bind the queue to the to the exchange using the routing key as a binding key. The - exchange name, queue name and routing key are taken from + exchange name, queue name and routing key are taken from the Binding URL associated with the Destination.</para></entry> </row> <row xml:id="JMS-Client-0-8-System-Properties-RejectBehaviour"> @@ -205,7 +205,7 @@ <entry><para>Used with the maximum delivery count feature. See <xref linkend="JMS-Client-0-8-Client-Understanding-MessageConsumer-MaximumDeliveryCount"/> for details.</para></entry> </row> - <!-- 0-10 + <!-- 0-10 <row> <entry>qpid.session.max_ack_delay</entry> <entry>long</entry> @@ -301,10 +301,10 @@ <entry>"" (disabled)</entry> <entry> <para>If 'all' is set then messages will be sent synchronously.</para> - <para>This can also be set per connection using the + <para>This can also be set per connection using the <link linkend="JMS-Client-0-8-Connection-URL-ConnectionOptions-SyncPublish"> Connection URL - </link> + </link> options. </para> </entry> Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Understanding.xml (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Understanding.xml) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Understanding.xml?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Understanding.xml&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Understanding.xml&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== --- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Understanding.xml (original) +++ qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Understanding.xml Mon Dec 28 22:49:09 2015 @@ -25,8 +25,8 @@ <section xml:id="JMS-Client-0-8-Client-Understanding-Overview"> <title>Overview</title> <para>The Qpid JMS client provides a JMS 1.1 compliant implementation. As such, the primary - source of documentation is the <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJmsSpec;">JMS specification</link> and the - <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;/javax/jms/package-summary.html">JMS javadocs</link>. This + source of documentation is the <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJmsSpec}">JMS specification</link> and the + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}/javax/jms/package-summary.html">JMS javadocs</link>. This documentation assumes the reader has familiarity with these resources.</para> <para>The remainder of this section describes how the Qpid JMS client behaves and the effect(s) making JMS method calls will have on the Broker. </para> @@ -45,17 +45,17 @@ </section> <section xml:id="JMS-Client-0-8-Client-Understanding-ConnectionFactory"> <title>ConnectionFactory</title> - <para>A <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/ConnectionFactory.html">ConnectionFactory</link> - allows an application to create a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Connection.html">Connection</link>.</para> - <para>The application obtains the ConnectionFactory from an <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;javax/naming/InitialContext.html">InitialContext</link>. The + <para>A <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/ConnectionFactory.html">ConnectionFactory</link> + allows an application to create a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Connection.html">Connection</link>.</para> + <para>The application obtains the ConnectionFactory from an <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/naming/InitialContext.html">InitialContext</link>. The InitialContext is itself obtained from an InitialContextFactory. </para> <para>The Qpid JMS client provides a single implementation of the InitialContextFactory in class <literal>org.apache.qpid.jndi.PropertiesFileInitialContextFactory</literal>. This - implementation is backed by a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJdkDocUrl;java/util/Properties.html">Properties</link> object which can of course be loaded from an external properties file, + implementation is backed by a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}java/util/Properties.html">Properties</link> object which can of course be loaded from an external properties file, or created programatically.</para> <para>The examples in the previous chapter illustrated the Java code required to <link linkend="JMS-Client-0-8-Examples-PTP">create the InitialContext</link> and an <link linkend="JMS-Client-0-8-Examples-PTP-PropertiesFile">example properties file</link>.</para> <para>The Qpid JMS client also provides an alternate connection factory implementation providing a - connection pool. This can be useful when utilsing frameworks such as Spring. + connection pool. This can be useful when utilsing frameworks such as Spring. <xref linkend="JMS-Client-0-8-Appendix-PooledConnecytionFactory"/>.</para> <figure> <title>JNDI overview</title> @@ -79,7 +79,7 @@ expensive operation. It is recommended that the same connection is used for a series of message interactions. Patterns utilising a connection per message should not be used. </para> <para>The underlying TCP/IP connection remains open for the lifetime of the JMS connection. It - is closed when the application calls <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Connection.html#close()">Connection#close()</link>, but it + is closed when the application calls <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Connection.html#close()">Connection#close()</link>, but it can also be closed if the connection is closed from the Broker side (via a Management operation or broker shutdown or running into conditions which AMQP specifications treats as errors and mandates closing the connection). The JMS connection will also be closed if the @@ -95,13 +95,13 @@ After a successful failover, any existing Connection, Session, MessageConsumer and MessageProducer objects held by the application remain valid.</para> <para>If a failover occurs during the scope of a JMS Transaction, any work performed by that - transaction is lost. The application is made aware of this loss by way of the <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/TransactionRolledBackException.html">TransactionRolledBackException</link> from the <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Session.html#commit">Session#commit()</link> call. + transaction is lost. The application is made aware of this loss by way of the <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/TransactionRolledBackException.html">TransactionRolledBackException</link> from the <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Session.html#commit">Session#commit()</link> call. Applications utilising failover must be prepared to catch this exception and respond by either repeating the work of the transaction, or by propagating a rollback to the originating system.</para> <para>If, after all retries are exhausted, failover has failed to reconnect the application, - the Connection's <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/ExceptionListener.html">ExceptionListener</link> will receive a JMSException with a linked exception of <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="JMS-Client-0-8-Appendix-Exceptions-AMQDisconnectedException">AMQDisconnectedException</link>. Any further use of the JMS objects (Connection, Session - etc), will results in a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/IllegalStateException.html">IllegalStateException</link>.</para> + the Connection's <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/ExceptionListener.html">ExceptionListener</link> will receive a JMSException with a linked exception of <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="JMS-Client-0-8-Appendix-Exceptions-AMQDisconnectedException">AMQDisconnectedException</link>. Any further use of the JMS objects (Connection, Session + etc), will results in a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/IllegalStateException.html">IllegalStateException</link>.</para> <para>Configure failover using the Connection URL. Here's an example Connection URL utilising failover between two brokers. Note the use of the broker options <link linkend="JMS-Client-0-8-Connection-URL-BrokerOptions-Retries"><literal>retries</literal></link> and <link linkend="JMS-Client-0-8-Connection-URL-BrokerOptions-ConnectDelay"><literal>connectdelay</literal></link> to control the number of connection attempts to each individual broker, and the delay between each connection attempt. Also note the use of @@ -143,9 +143,9 @@ amqp://username:password@clientid/test health of the higher level tiers of application, for this reason, applications may implement an application level heartbeat either in addition to, or instead of the heartbeat.</para> <para>If the client ever fails to receive two consecutive heartbeats, the Connection will be - automatically closed and the Connection's <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/ExceptionListener.html">ExceptionListener</link> will + automatically closed and the Connection's <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/ExceptionListener.html">ExceptionListener</link> will receive a JMSException with a linked exception of AMQDisconnectedException. Any further use - of the JMS objects (Connection, Session etc), will results in a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/IllegalStateException.html">IllegalStateException</link>.</para> + of the JMS objects (Connection, Session etc), will results in a <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/IllegalStateException.html">IllegalStateException</link>.</para> <para>To enable heartbeating either use a Connection URL including the broker option <link linkend="JMS-Client-0-8-Connection-URL-BrokerOptions-Heartbeat"><literal>heartbeat</literal></link>, or use the system property <link linkend="JMS-Client-0-8-System-Properties-Heartbeat"><literal>qpid.heartbeat</literal></link>. </para> <example> <title>Connection URL configured for heartbeating</title> @@ -268,7 +268,7 @@ amqp://guest:guest@clientid/?brokerlist= patterns to result in consumer starvation and an application level deadlock. For example, if prefetch is 100, and 100 hundred messages arrive suitable for consumer A, those messages will be prefetched by the session, entirely filling the prefetch buffer. Now if the - application performs a blocking <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/MessageConsumer.html#receive()">MessageConsumer#receive()</link> for Consumer B on the same Session, the application + application performs a blocking <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/MessageConsumer.html#receive()">MessageConsumer#receive()</link> for Consumer B on the same Session, the application will hang indefinitely as even if messages suitable for B arrive at the Broker. Those messages can never be sent to the Session as no space is available in prefetch. </para> <note> @@ -323,13 +323,13 @@ amqp://guest:guest@clientid/?brokerlist= <para>Temporary queues are exposed to Management in the same way as normal queues. Temporary queue names take the form string <literal>TempQueue</literal> followed by a random UUID.</para> - <para>Note that <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/TemporaryQueue.html#delete()">TemporaryQueue#delete()</link> merely marks the queue as deleted on within the JMS + <para>Note that <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/TemporaryQueue.html#delete()">TemporaryQueue#delete()</link> merely marks the queue as deleted on within the JMS client (and prevents further use of the queue from the application), however, the Queue will remain on the Broker until the Consumer (or Connection) is closed.</para> </section> <section xml:id="JMS-Client-0-8-Client-Understanding-Session-CreateQueue"> <title>CreateQueue</title> - <para>In the Qpid JMS client, <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Session.html#createQueue(java.lang.String)">Session#createQueue()</link> accepts either a queue name, or a Binding URL. If only name + <para>In the Qpid JMS client, <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Session.html#createQueue(java.lang.String)">Session#createQueue()</link> accepts either a queue name, or a Binding URL. If only name is specified the destination will be resolved into binding URL: direct://amq.direct//<queue name>?routingkey='<queue name>'&durable='true'. </para> <para>Calling Session#createQueue() has no effect on the Broker.</para> @@ -338,7 +338,7 @@ amqp://guest:guest@clientid/?brokerlist= </section> <section xml:id="JMS-Client-0-8-Client-Understanding-Session-CreateTopic"> <title>CreateTopic</title> - <para>In the Qpid JMS client, <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Session.html#createTopic(java.lang.String)">Session#createTopic()</link> accepts either a topic name, or a Binding URL. If only name + <para>In the Qpid JMS client, <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Session.html#createTopic(java.lang.String)">Session#createTopic()</link> accepts either a topic name, or a Binding URL. If only name is specified the destination will be resolved into binding URL: topic://amq.topic//<topic name>?routingkey='<topic name>'.</para> <para>Calling Session#createTopic() has no effect on the Broker.</para> @@ -353,19 +353,19 @@ amqp://guest:guest@clientid/?brokerlist= according to rules expressed as <emphasis>bindings</emphasis> between the exchange and queues and a <emphasis>routing key</emphasis> included with each message.</para> <para>To understand how this mechanism is used to deliver messages to queues and topics, see - <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidJavaBrokerBook;Java-Broker-Concepts-Exchanges.html">Exchanges</link> + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${qpidJavaBrokerBook}Java-Broker-Concepts-Exchanges.html">Exchanges</link> within the Java Broker book.</para> - <para>It is important to understand that when synchronous publish is not exlicitly enabled, - <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/MessageProducer.html#send(javax.jms.Message)">MessageProducer#send()</link> is <emphasis>asynchronous</emphasis> in nature. When #send() + <para>It is important to understand that when synchronous publish is not exlicitly enabled, + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/MessageProducer.html#send(javax.jms.Message)">MessageProducer#send()</link> is <emphasis>asynchronous</emphasis> in nature. When #send() returns to the application, the application cannot be certain if the Broker has received the message. The Qpid JMS client may not have yet started to send the message, the message could residing in a TCP/IP buffer, or the messages could be in some intermediate buffer within the Broker. If the application requires certainty the message has been received by the Broker, a - <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Session.html#SESSION_TRANSACTED">transactional + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Session.html#SESSION_TRANSACTED">transactional session</link> - <emphasis>must</emphasis> be used, or synchronous publishing must be enabled using either the - <link linkend="JMS-Client-0-8-System-Properties-SyncPublish">system property</link> or the - <link linkend="JMS-Client-0-8-Connection-URL-ConnectionOptions-SyncPublish">connection URL + <emphasis>must</emphasis> be used, or synchronous publishing must be enabled using either the + <link linkend="JMS-Client-0-8-System-Properties-SyncPublish">system property</link> or the + <link linkend="JMS-Client-0-8-Connection-URL-ConnectionOptions-SyncPublish">connection URL option</link>.</para> <para>Qpid JMS MessageProducers have a number of features above that required by JMS. These are described in the sub-sections that follow.</para> @@ -375,20 +375,20 @@ amqp://guest:guest@clientid/?brokerlist= on the exchange will result in the message being returned to the publisher's connection.</para> <para>The Message is returned to the application in an asynchronous fashion via the - Connection's <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/ExceptionListener.html">ExceptionListener</link>. When a message is returned, it will be invoked with a + Connection's <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/ExceptionListener.html">ExceptionListener</link>. When a message is returned, it will be invoked with a JMSException whose linked exception is an <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="JMS-Client-0-8-Appendix-Exceptions-AMQNoRouteException">AMQNoRouteException</link>. The returned message is available to the application by calling AMQNoRouteException#getUndeliveredMessage(). The ExceptionListener will be invoked exactly once for each returned message.</para> - <para>If synchronous publishing has been enabled, and a mandatory message is returned, the - <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/MessageProducer.html#send(javax.jms.Message)">MessageProducer#send()</link> method will throw a JMSException. + <para>If synchronous publishing has been enabled, and a mandatory message is returned, the + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/MessageProducer.html#send(javax.jms.Message)">MessageProducer#send()</link> method will throw a JMSException. </para> <para>The mandatory message feature is turned <emphasis>on</emphasis> by default for Queue destinations and <emphasis>off</emphasis> for Topic destinations. This can be overridden using system properties <link linkend="JMS-Client-0-8-System-Properties-DefaultMandatory"><literal>qpid.default_mandatory</literal></link> and <link linkend="JMS-Client-0-8-System-Properties-DefaultMandatoryTopic"><literal>qpid.default_mandatory_topic</literal></link> for Queues and Topics respectively.</para> <note> - <para>If this the mandatory flag is not set, the Broker will treat <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidJavaBrokerBook;Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-UnroutableMessage">the messages as unroutable</link>.</para> + <para>If this the mandatory flag is not set, the Broker will treat <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${qpidJavaBrokerBook}Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-UnroutableMessage">the messages as unroutable</link>.</para> </note> </section> <section xml:id="JMS-Client-0-8-Client-Understanding-MessageProducer-CloseWhenNoRoute"> @@ -397,23 +397,23 @@ amqp://guest:guest@clientid/?brokerlist= binding exists on the exchange the Broker will close the connection. This client feature requires support for the corresponding feature by the Broker.</para> <para>To enable or disable from the client, use the Connection URL option <link linkend="JMS-Client-0-8-Connection-URL-ConnectionOptions-CloseWhenNoRoute"><literal>closeWhenNoRoute</literal></link>.</para> - <para>See <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidJavaBrokerBook;Java-Broker-Runtime-Close-Connection-When-No-Route.html"> + <para>See <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${qpidJavaBrokerBook}Java-Broker-Runtime-Close-Connection-When-No-Route.html"> Closing client connections on unroutable mandatory messages</link> within the Java Broker book for full details of the functioning of this feature.</para> </section> <section xml:id="JMS-Client-0-8-Client-Understanding-MessageProducer-ImmediateMessage"> <title>Immediate Messages</title> - <para>This feature is defined in <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&amqpSrc;">AMQP specifications</link>.</para> + <para>This feature is defined in <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${amqpSrc}">AMQP specifications</link>.</para> <para>When this feature is enabled, when publishing a message the Broker ensures that a Consumer is attached to queue. If there is no Consumer attached to the queue, the message is returned to the publisher's connection. The Message is returned to the application in an - asynchronous fashion using the Connection's <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/ExceptionListener.html">ExceptionListener</link>.</para> + asynchronous fashion using the Connection's <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/ExceptionListener.html">ExceptionListener</link>.</para> <para>The ExceptionListener will be invoked with a JMSException whose linked exception is an <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="JMS-Client-0-8-Appendix-Exceptions-AMQNoConsumersException">AMQNoConsumersException</link>. The returned message is available to the application by calling AMQNoConsumersException#getUndeliveredMessage(). The ExceptionListener will be invoked exactly once for each returned message.</para> - <para>If synchronous publishing has been enabled, and an immediate message is returned, the - <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/MessageProducer.html#send(javax.jms.Message)">MessageProducer#send()</link> method will throw a JMSException. + <para>If synchronous publishing has been enabled, and an immediate message is returned, the + <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/MessageProducer.html#send(javax.jms.Message)">MessageProducer#send()</link> method will throw a JMSException. </para> <para>The immediate message feature is turned <emphasis>off</emphasis> by default. It can be enabled with system property <link linkend="JMS-Client-0-8-System-Properties-DefaultImmediate"><literal>qpid.default_immediate</literal></link>.</para> @@ -425,7 +425,7 @@ amqp://guest:guest@clientid/?brokerlist= feature requires support for the corresponding feature by the Broker.</para> <para>To control the timeout use System property <link linkend="JMS-Client-0-8-System-Properties-FlowControlWaitFailure"><literal>qpid.flow_control_wait_failure</literal></link>. To control the frequency with which warnings are logged whilst a Session is blocked, use System property <link linkend="JMS-Client-0-8-System-Properties-FlowControlWaitNotifyPeriod"><literal>qpid.flow_control_wait_notify_period</literal></link></para> - <para>See <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidJavaBrokerBook;Java-Broker-Runtime-Disk-Space-Management.html#Qpid-Producer-Flow-Control"> Producer Flow Control</link> within the Java Broker book for full details of the + <para>See <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${qpidJavaBrokerBook}Java-Broker-Runtime-Disk-Space-Management.html#Qpid-Producer-Flow-Control"> Producer Flow Control</link> within the Java Broker book for full details of the functioning of this feature.</para> </section> </section> @@ -437,7 +437,7 @@ amqp://guest:guest@clientid/?brokerlist= described in the sub-sections that follow.</para> <section xml:id="JMS-Client-0-8-Client-Understanding-MessageConsumer-ConsumerSideEffect"> <title>Consumers have Exchange/Queue Declaration and Binding Side Effect</title> - <para>By default, calling <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Session.html#createConsumer(javax.jms.Destination)">Session#createConsumer()</link> will cause:</para> + <para>By default, calling <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Session.html#createConsumer(javax.jms.Destination)">Session#createConsumer()</link> will cause:</para> <orderedlist> <listitem> <para>If the exchange does not exist on the Broker, it will be created. The exchange is @@ -467,8 +467,8 @@ amqp://guest:guest@clientid/?brokerlist= <programlisting> clientid: + subscriptionId </programlisting> - <para>where <literal>subscriptionId</literal> is that passed to the <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Session.html#createDurableSubscriber(javax.jms.Topic,%20java.lang.String)">Session#createDurableSubscriber(javax.jms.Topic,java.lang.String)</link></para> - <para>Calling <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&oracleJeeDocUrl;javax/jms/Session.html#unsubscribe(java.lang.String)">Session#unsubscribe(java.lang.String)</link> deletes the underlying queue.</para> + <para>where <literal>subscriptionId</literal> is that passed to the <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Session.html#createDurableSubscriber(javax.jms.Topic,%20java.lang.String)">Session#createDurableSubscriber(javax.jms.Topic,java.lang.String)</link></para> + <para>Calling <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${oracleJeeDocUrl}javax/jms/Session.html#unsubscribe(java.lang.String)">Session#unsubscribe(java.lang.String)</link> deletes the underlying queue.</para> <para>Non-durable topic subscriptions use a <emphasis>non-durable</emphasis>, <emphasis>exclusive</emphasis> and <emphasis>auto-delete</emphasis> queue named as follows:</para> @@ -491,7 +491,7 @@ amqp://guest:guest@clientid/?brokerlist= <para>When using this feature, the application must either set system property <link linkend="JMS-Client-0-8-System-Properties-RejectBehaviour">qpid.reject.behaviour</link> or the Binding URL option <link linkend="JMS-Client-0-8-Binding-URL-Options-RejectBehaviour"><literal>rejectbehaviour</literal></link> to the value <literal>server</literal>.</para> - <para>See <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="&qpidJavaBrokerBook;Java-Broker-Runtime-Handling-Undeliverable-Messages.html#Java-Broker-Runtime-Handling-Undeliverable-Messages-Maximum-Delivery-Count"> Handling Undeliverable Messages</link> within the Java Broker book for full details of + <para>See <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="${qpidJavaBrokerBook}Java-Broker-Runtime-Handling-Undeliverable-Messages.html#Java-Broker-Runtime-Handling-Undeliverable-Messages-Maximum-Delivery-Count"> Handling Undeliverable Messages</link> within the Java Broker book for full details of the functioning of this feature.</para> <note> <para>The optional JMS message header <literal>JMSXDeliveryCount</literal> is Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/JndiOverview.png (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/images/JndiOverview.png) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/JndiOverview.png?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/JndiOverview.png&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/images/JndiOverview.png&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== (empty) Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/JndiOverview.svg (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/images/JndiOverview.svg) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/JndiOverview.svg?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/JndiOverview.svg&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/images/JndiOverview.svg&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== (empty) Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/QpidJmsOverview.png (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/images/QpidJmsOverview.png) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/QpidJmsOverview.png?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/QpidJmsOverview.png&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/images/QpidJmsOverview.png&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== (empty) Copied: qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/QpidJmsOverview.svg (from r1722019, qpid/java/trunk/doc/book/src/jms-client-0-8/images/QpidJmsOverview.svg) URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/QpidJmsOverview.svg?p2=qpid/java/trunk/doc/jms-client-0-8/src/docbkx/images/QpidJmsOverview.svg&p1=qpid/java/trunk/doc/book/src/jms-client-0-8/images/QpidJmsOverview.svg&r1=1722019&r2=1722020&rev=1722020&view=diff ============================================================================== (empty) Added: qpid/java/trunk/doc/pom.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/pom.xml?rev=1722020&view=auto ============================================================================== --- qpid/java/trunk/doc/pom.xml (added) +++ qpid/java/trunk/doc/pom.xml Mon Dec 28 22:49:09 2015 @@ -0,0 +1,158 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + ~ + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + ~ + --> +<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/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.qpid</groupId> + <artifactId>qpid-java-build</artifactId> + <version>6.1.0-SNAPSHOT</version> + </parent> + + <artifactId>qpid-java-doc</artifactId> + <name>Qpid Java Docbook</name> + <description>Java Qpid Docbook</description> + <packaging>pom</packaging> + + <properties> + <jar.skipIfEmpty>true</jar.skipIfEmpty> + <maven.install.skip>true</maven.install.skip> + + <docbook.src>${project.basedir}/src/docbkx</docbook.src> + <docbook.target.filtered>${basedir}/target/filtered-docbkx</docbook.target.filtered> + <docbook.target>${basedir}/target/docbkx</docbook.target> + + <qpidDownloadUrlDesc>the Apache Qpid project web site</qpidDownloadUrlDesc> + <qpidDownloadUrl>http://qpid.apache.org/download.html</qpidDownloadUrl> + + <qpidCppBook>../../AMQP-Messaging-Broker-CPP-Book/html/</qpidCppBook> + <qpidJavaBrokerBook>../../AMQP-Messaging-Broker-Java-Book/html/</qpidJavaBrokerBook> + <qpidJmsBook>../../Programming-In-Apache-Qpid/html/</qpidJmsBook> + <qpidJmsBookClientConectionUrl>../../Programming-In-Apache-Qpid/html/QpidJNDI.html#section-jms-connection-url</qpidJmsBookClientConectionUrl> + + <oracleJdkDocUrl>http://docs.oracle.com/javase/7/docs/api/</oracleJdkDocUrl> + <oracleJeeDocUrl>http://docs.oracle.com/javaee/6/api/</oracleJeeDocUrl> + <oracleKeytool>http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/keytool.html</oracleKeytool> + <oracleJmsSpec>http://download.oracle.com/otndocs/jcp/7195-jms-1.1-fr-spec-oth-JSpec/</oracleJmsSpec> + <oracleJmsTutorial>http://docs.oracle.com/javaee/6/tutorial/doc/bncdq.html</oracleJmsTutorial> + + <oracleJeDownloadUrl>http://www.oracle.com/technetwork/products/berkeleydb/downloads/index.html?ssSourceSiteId=ocomen</oracleJeDownloadUrl> + <oracleBdbRepGuideUrl>http://oracle.com/cd/E17277_02/html/ReplicationGuide/</oracleBdbRepGuideUrl> + <oracleBdbJavaDocUrl>http://docs.oracle.com/cd/E17277_02/html/java/</oracleBdbJavaDocUrl> + + <qpidSrc>http://svn.apache.org/viewvc/qpid/java/trunk/</qpidSrc> + <qpidSrcSuffix>.java?view=co/</qpidSrcSuffix> + + <qpidMavenRepoDesc>Maven repositories</qpidMavenRepoDesc> + <qpidClientGroupId>org.apache.qpid</qpidClientGroupId> + <qpidClientArtefactId>qpid-client</qpidClientArtefactId> + + <amqpSrc>http://www.amqp.org</amqpSrc> + </properties> + + <modules> + <module>java-broker</module> + <module>jms-client-0-8</module> + <module>java-perftests</module> + </modules> + + <build> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-resources-plugin</artifactId> + <executions> + <execution> + <id>filter-docbook-sources</id> + <phase>process-sources</phase> + <goals> + <goal>copy-resources</goal> + </goals> + </execution> + </executions> + <configuration> + <outputDirectory>${docbook.target.filtered}</outputDirectory> + <resources> + <resource> + <directory>${docbook.src}</directory> + <includes> + <include>**/*.xml</include> + </includes> + <filtering>true</filtering> + </resource> + </resources> + <escapeString>\</escapeString> + </configuration> + </plugin> + <plugin> + <groupId>com.agilejava.docbkx</groupId> + <artifactId>docbkx-maven-plugin</artifactId> + <executions> + <execution> + <id>docbook-html</id> + <phase>compile</phase> + <goals> + <goal>generate-html</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>net.sf.docbook</groupId> + <artifactId>docbook-xml</artifactId> + <version>${maven-docbook-xml-plugin-version}</version> + <classifier>resources</classifier> + <type>zip</type> + <scope>runtime</scope> + </dependency> + </dependencies> + <configuration> + <sourceDirectory>${docbook.target.filtered}</sourceDirectory> + <targetDirectory>${docbook.target}</targetDirectory> + <xincludeSupported>true</xincludeSupported> + <chunkedOutput>true</chunkedOutput> + <customizationParameters> + <parameter> + <name>use.id.as.filename</name> + <value>1</value> + </parameter> + </customizationParameters> + <preProcess> + <copy todir="${docbook.target}/images" failOnError="false"> + <fileset dir="${docbook.src}/images" /> + </copy> + </preProcess> + </configuration> + </plugin> + <plugin> + <artifactId>maven-deploy-plugin</artifactId> + <configuration> + <skip>true</skip> + </configuration> + </plugin> + </plugins> + </pluginManagement> + </build> + +</project> Modified: qpid/java/trunk/pom.xml URL: http://svn.apache.org/viewvc/qpid/java/trunk/pom.xml?rev=1722020&r1=1722019&r2=1722020&view=diff ============================================================================== --- qpid/java/trunk/pom.xml (original) +++ qpid/java/trunk/pom.xml Mon Dec 28 22:49:09 2015 @@ -157,6 +157,8 @@ <findbugs-maven-plugin-version>2.5.2</findbugs-maven-plugin-version> <jacoco-plugin-version>0.7.5.201505241946</jacoco-plugin-version> <apache-rat-plugin-version>0.11</apache-rat-plugin-version> + <maven-docbx-plugin-version>2.0.15</maven-docbx-plugin-version> + <maven-docbook-xml-plugin-version>5.0-all</maven-docbook-xml-plugin-version> <!-- These versions needs to be kept in sync with versions in parent pom--> <maven-project-info-reports-plugin-version>2.8</maven-project-info-reports-plugin-version> @@ -200,6 +202,8 @@ <module>bdbstore/systests</module> <module>joramtests</module> + + <module>doc</module> </modules> <dependencies> @@ -274,7 +278,11 @@ <artifactId>findbugs-maven-plugin</artifactId> <version>${findbugs-maven-plugin-version}</version> </plugin> - + <plugin> + <groupId>com.agilejava.docbkx</groupId> + <artifactId>docbkx-maven-plugin</artifactId> + <version>${maven-docbx-plugin-version}</version> + </plugin> <!-- REMOVE 2 PLUGINS BELOW AFTER CHANGING APACHE PARENT TO V 17 --> <plugin> <groupId>org.apache.maven.plugins</groupId> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
