Merge "J-332: Create documentation for Jersey Rx Client Extension"

Author: Michal Gajdos

docs/pom.xml

@@ -74,17 +74,18 @@
                                 <copy todir="${src.dir}">
                                     <fileset dir="src/main/docbook" />
                                 </copy>
-                                <replace file="${src.dir}/jersey.ent" token="$version" value="${jersey.version}" />
-                                <replace file="${src.dir}/jersey.ent" token="$docs.version" value="${jersey.docs.version}" />
                                 <replace file="${src.dir}/jersey.ent" token="$apidocs.version" value="${jersey.apidocs.version}" />
-                                <replace file="${src.dir}/jersey.ent" token="$src.branch" value="${jersey.src.branch}" />
-                                <replace file="${src.dir}/jersey.ent" token="$repository" value="${javanet.repository.id}" />
-                                <replace file="${src.dir}/jersey.ent" token="$jax-rs-version" value="${jaxrs.version}" />
-                                <replace file="${src.dir}/jersey.ent" token="$javax-el-version" value="${javax.el.version}" />
+                                <replace file="${src.dir}/jersey.ent" token="$docs.version" value="${jersey.docs.version}" />
+                                <replace file="${src.dir}/jersey.ent" token="$guava-version" value="${guava.version}" />
+                                <replace file="${src.dir}/jersey.ent" token="$jackson-version" value="${jackson.version}" />
                                 <replace file="${src.dir}/jersey.ent" token="$javax-el-impl-version" value="${javax.el.impl.version}" />
+                                <replace file="${src.dir}/jersey.ent" token="$javax-el-version" value="${javax.el.version}" />
                                 <replace file="${src.dir}/jersey.ent" token="$jax-rs-api-jar-version" value="${jaxrs.impl.version}" />
+                                <replace file="${src.dir}/jersey.ent" token="$jax-rs-version" value="${jaxrs.version}" />
                                 <replace file="${src.dir}/jersey.ent" token="$jaxb-api-jar-version" value="${jaxb.api.version}" />
-                                <replace file="${src.dir}/jersey.ent" token="$jackson-version" value="${jackson.version}" />
+                                <replace file="${src.dir}/jersey.ent" token="$repository" value="${javanet.repository.id}" />
+                                <replace file="${src.dir}/jersey.ent" token="$src.branch" value="${jersey.src.branch}" />
+                                <replace file="${src.dir}/jersey.ent" token="$version" value="${jersey.version}" />
                             </tasks>
                         </configuration>
                         <id>process-entities</id>

docs/src/main/docbook/images/rx-client-async-approach.png

@@ -3,7 +3,7 @@
 
     DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
-    Copyright (c) 2012-2014 Oracle and/or its affiliates. All rights reserved.
+    Copyright (c) 2012-2015 Oracle and/or its affiliates. All rights reserved.
 
     The contents of this file are subject to the terms of either the GNU
     General Public License Version 2 only ("GPL") or the Common Development
@@ -962,7 +962,7 @@ final Application application = new ResourceConfig()
             <title><literal>@JSONP</literal> - JSON with Padding Support</title>
 
             <para>
-                Jersey provides out-of-the-box support for <link xlink:href='&wikipedia.uri;/JSONP'>JSONP</link>
+                Jersey provides out-of-the-box support for <link xlink:href='&wikipedia.uri;JSONP'>JSONP</link>
                 - JSON with padding. The following conditions has to be met to take advantage of this capability:
 
                 <itemizedlist>
@@ -1532,9 +1532,9 @@ final Application application = new ResourceConfig()
             <para>
                 &jersey.media.multipart.MultiPart; class (or it's subclasses) can be used as an entry point to using
                 &lit.jersey-media-multipart; module on the client side. This class represents a
-                <link xlink:href='&wikipedia.uri;/MIME#Multipart_messages'>MIME multipart message</link> and is able
+                <link xlink:href='&wikipedia.uri;MIME#Multipart_messages'>MIME multipart message</link> and is able
                 to hold an arbitrary number of &jersey.media.multipart.BodyPart;s. Default media type is
-                <link xlink:href='&wikipedia.uri;/MIME#Mixed'>multipart/mixed</link>
+                <link xlink:href='&wikipedia.uri;MIME#Mixed'>multipart/mixed</link>
                 for &lit.jersey.media.multipart.MultiPart; entity and <literal>text/plain</literal> for
                 &lit.jersey.media.multipart.BodyPart;.
 

docs/src/main/docbook/images/rx-client-problem.png

@@ -1,43 +1,45 @@
 <?xml version="1.0"?>
 <!--
-  ~ DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
-  ~
-  ~ Copyright (c) 2013-2014 Oracle and/or its affiliates. All rights reserved.
-  ~
-  ~ The contents of this file are subject to the terms of either the GNU
-  ~ General Public License Version 2 only ("GPL") or the Common Development
-  ~ and Distribution License("CDDL") (collectively, the "License").  You
-  ~ may not use this file except in compliance with the License.  You can
-  ~ obtain a copy of the License at
-  ~ http://glassfish.java.net/public/CDDL+GPL_1_1.html
-  ~ or packager/legal/LICENSE.txt.  See the License for the specific
-  ~ language governing permissions and limitations under the License.
-  ~
-  ~ When distributing the software, include this License Header Notice in each
-  ~ file and include the License file at packager/legal/LICENSE.txt.
-  ~
-  ~ GPL Classpath Exception:
-  ~ Oracle designates this particular file as subject to the "Classpath"
-  ~ exception as provided by Oracle in the GPL Version 2 section of the License
-  ~ file that accompanied this code.
-  ~
-  ~ Modifications:
-  ~ If applicable, add the following below the License Header, with the fields
-  ~ enclosed by brackets [] replaced by your own identifying information:
-  ~ "Portions Copyright [year] [name of copyright owner]"
-  ~
-  ~ Contributor(s):
-  ~ If you wish your version of this file to be governed by only the CDDL or
-  ~ only the GPL Version 2, indicate your decision by adding "[Contributor]
-  ~ elects to include this software in this distribution under the [CDDL or GPL
-  ~ Version 2] license."  If you don't indicate a single choice of license, a
-  ~ recipient has the option to distribute your version of this file under
-  ~ either the CDDL, the GPL Version 2 or to extend the choice of license to
-  ~ its licensees as provided above.  However, if you add GPL Version 2 code
-  ~ and therefore, elected the GPL Version 2 license, then the option applies
-  ~ only if the new code is made subject to such option by the copyright
-  ~ holder.
-  -->
+
+    DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+
+    Copyright (c) 2013-2015 Oracle and/or its affiliates. All rights reserved.
+
+    The contents of this file are subject to the terms of either the GNU
+    General Public License Version 2 only ("GPL") or the Common Development
+    and Distribution License("CDDL") (collectively, the "License").  You
+    may not use this file except in compliance with the License.  You can
+    obtain a copy of the License at
+    http://glassfish.java.net/public/CDDL+GPL_1_1.html
+    or packager/legal/LICENSE.txt.  See the License for the specific
+    language governing permissions and limitations under the License.
+
+    When distributing the software, include this License Header Notice in each
+    file and include the License file at packager/legal/LICENSE.txt.
+
+    GPL Classpath Exception:
+    Oracle designates this particular file as subject to the "Classpath"
+    exception as provided by Oracle in the GPL Version 2 section of the License
+    file that accompanied this code.
+
+    Modifications:
+    If applicable, add the following below the License Header, with the fields
+    enclosed by brackets [] replaced by your own identifying information:
+    "Portions Copyright [year] [name of copyright owner]"
+
+    Contributor(s):
+    If you wish your version of this file to be governed by only the CDDL or
+    only the GPL Version 2, indicate your decision by adding "[Contributor]
+    elects to include this software in this distribution under the [CDDL or GPL
+    Version 2] license."  If you don't indicate a single choice of license, a
+    recipient has the option to distribute your version of this file under
+    either the CDDL, the GPL Version 2 or to extend the choice of license to
+    its licensees as provided above.  However, if you add GPL Version 2 code
+    and therefore, elected the GPL Version 2 license, then the option applies
+    only if the new code is made subject to such option by the copyright
+    holder.
+
+-->
 <!DOCTYPE chapter [<!ENTITY % ents SYSTEM "jersey.ent" > %ents;]>
 <chapter xmlns="http://docbook.org/ns/docbook"
          version="5.0"
@@ -299,7 +301,7 @@ Application my-monitored-application destroyed.</programlisting>
                         Implement event listeners as thread safe. While individual events will be arriving serially,
                         individual listener invocations may occur from different threads. Thus make sure that your listeners
                         are processing data safely with respect to their
-                        <link xlink:href='&wikipedia.uri;/Java_Memory_Model'>Java Memory Model</link> visibility (in the example
+                        <link xlink:href='&wikipedia.uri;Java_Memory_Model'>Java Memory Model</link> visibility (in the example
                         above the fields <literal>requestNumber</literal>, <literal>startTime</literal> of
                         <literal>MyRequestEventListener</literal> are final and therefore the same value is
                         visible for all threads executing the <literal>onEvent()</literal> method).