You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by ch...@apache.org on 2014/03/13 16:49:58 UTC

svn commit: r1577212 - in /db/derby/docs/trunk/src: adminguide/ devguide/ ref/

Author: chaase3
Date: Thu Mar 13 15:49:57 2014
New Revision: 1577212

URL: http://svn.apache.org/r1577212
Log:
DERBY-6478  Fix language about supported DataSources for Compact Profiles

Modified 4 Admin Guide topics, 3 Reference Manual topics, and 1 Developer's Guide topic.

Patch: DERBY-6478-4.diff

Modified:
    db/derby/docs/trunk/src/adminguide/cadminappsclientsecurity.dita
    db/derby/docs/trunk/src/adminguide/cadminappsclienttracing.dita
    db/derby/docs/trunk/src/adminguide/cadminappsxawthdriver.dita
    db/derby/docs/trunk/src/adminguide/cadminnsdatasources.dita
    db/derby/docs/trunk/src/devguide/rdevresman79556.dita
    db/derby/docs/trunk/src/ref/rrefapi1003363.dita
    db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita
    db/derby/docs/trunk/src/ref/rrefjdbc4_2compactprofiles.dita

Modified: db/derby/docs/trunk/src/adminguide/cadminappsclientsecurity.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminappsclientsecurity.dita?rev=1577212&r1=1577211&r2=1577212&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminappsclientsecurity.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminappsclientsecurity.dita Thu Mar 13 15:49:57 2014
@@ -85,10 +85,12 @@ the Diffie-Hellman algorithm with a publ
 </tgroup>
 </table>
 <p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides two
-ClientDataSource implementations. Use the
+ClientDataSource implementations. You can use the
 <codeph>org.apache.derby.jdbc.ClientDataSource</codeph> class on all supported
 Java SE versions except Java SE 8 Compact Profile 2. On Java SE 8 Compact
-Profile 2, use the
-<codeph>org.apache.derby.jdbc.BasicClientDataSource40</codeph> class.</p>
+Profile 2, you must use the
+<codeph>org.apache.derby.jdbc.BasicClientDataSource40</codeph> class. For more
+information, see "JDBC support for Java SE 8 Compact Profiles" in the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
 </conbody>
 </concept>

Modified: db/derby/docs/trunk/src/adminguide/cadminappsclienttracing.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminappsclienttracing.dita?rev=1577212&r1=1577211&r2=1577212&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminappsclienttracing.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminappsclienttracing.dita Thu Mar 13 15:49:57 2014
@@ -53,11 +53,13 @@ non-null value.</li>
 for programs that have multiple connections.</li>
 </ul></p>
 <p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides two
-ClientDataSource implementations. Use the
+ClientDataSource implementations. You can use the
 <codeph>org.apache.derby.jdbc.ClientDataSource</codeph> class on all supported
 Java SE versions except Java SE 8 Compact Profile 2. On Java SE 8 Compact
-Profile 2, use the
-<codeph>org.apache.derby.jdbc.BasicClientDataSource40</codeph> class.</p>
+Profile 2, you must use the
+<codeph>org.apache.derby.jdbc.BasicClientDataSource40</codeph> class. For more
+information, see "JDBC support for Java SE 8 Compact Profiles" in the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
 </section>
 <section><title>Implementing DriverManager tracing</title>
 <p>Use one of the following two options to enable and collect tracing

Modified: db/derby/docs/trunk/src/adminguide/cadminappsxawthdriver.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminappsxawthdriver.dita?rev=1577212&r1=1577211&r2=1577212&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminappsxawthdriver.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminappsxawthdriver.dita Thu Mar 13 15:49:57 2014
@@ -27,10 +27,12 @@ client driver's XA DataSource interface.
 </metadata></prolog>
 <conbody>
 <section>
-<p>Use the <codeph>org.apache.derby.jdbc.ClientXADataSource</codeph>
+<p>You can use the <codeph>org.apache.derby.jdbc.ClientXADataSource</codeph>
 class on all supported Java SE versions except Java SE 8 Compact Profile 2. On
-Java SE 8 Compact Profile 2, use the
-<codeph>org.apache.derby.jdbc.BasicClientXADataSource40</codeph> class.</p>
+Java SE 8 Compact Profile 2, you must use the
+<codeph>org.apache.derby.jdbc.BasicClientXADataSource40</codeph> class. For more
+information, see "JDBC support for Java SE 8 Compact Profiles" in the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
 </section>
 <example><p>The following example illustrates how to obtain an XA connection
 with the network client driver:</p>

Modified: db/derby/docs/trunk/src/adminguide/cadminnsdatasources.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminnsdatasources.dita?rev=1577212&r1=1577211&r2=1577212&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminnsdatasources.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminnsdatasources.dita Thu Mar 13 15:49:57 2014
@@ -27,13 +27,14 @@ Client driver <codeph>DataSource</codeph
 <indexterm>Network Server<indexterm>using DataSource objects</indexterm></indexterm>
 </keywords></metadata></prolog>
 <conbody>
-<p>Use the <codeph>org.apache.derby.jdbc.ClientDataSource</codeph> and
+<p>You can use the <codeph>org.apache.derby.jdbc.ClientDataSource</codeph> and
 <codeph>org.apache.derby.jdbc.ClientConnectionPoolDataSource</codeph> classes
 on all supported Java SE versions except Java SE 8 Compact Profile 2. On
-Java SE 8 Compact Profile 2, use the
+Java SE 8 Compact Profile 2, you must use the
 <codeph>org.apache.derby.jdbc.BasicClientDataSource40</codeph> and
 <codeph>org.apache.derby.jdbc.BasicClientConnectionPoolDataSource40</codeph>
-classes.</p>
+classes. For more information, see "JDBC support for Java SE 8 Compact Profiles"
+in the <ph conref="../conrefs.dita#pub/citref"></ph>.</p>
 <section><title>Using statement caching</title>
 <p><ph conref="../conrefs.dita#prod/productshortname"></ph> supports JDBC
 statement caching, which can improve the performance of applications that use

Modified: db/derby/docs/trunk/src/devguide/rdevresman79556.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/rdevresman79556.dita?rev=1577212&r1=1577211&r2=1577212&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/rdevresman79556.dita (original)
+++ db/derby/docs/trunk/src/devguide/rdevresman79556.dita Thu Mar 13 15:49:57 2014
@@ -35,12 +35,10 @@ API.</shortdesc>
 </metadata></prolog>
 <refbody>
 <section>
-<p>Most applications will use the first variant.</p>
-<p>However, applications that run on Java SE 8 Compact Profile 2
-must use the second variant (the ones whose class name begins with "Basic").
-Compact Profile 2 does not support the Java Naming and Directory Interface
-(JNDI) API. Applications that run on Compact Profile 3 may use either
-variant.</p>
+<p>Most applications will use the first variant. However, applications that run
+on Java SE 8 Compact Profile 2 must use the second variant (the one whose class
+name begins with "Basic"). For more information, see "JDBC support for Java SE 8
+Compact Profiles" in the <ph conref="../conrefs.dita#pub/citref"></ph>.</p>
 <p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> implementation
 classes for the <i>DataSource</i> interfaces are as follows:</p>
 <ul>
@@ -57,7 +55,7 @@ interface and provide a factory for <i>P
 and <i>org.apache.derby.jdbc.BasicEmbeddedXADataSource40</i>
 <p>These classes implement the <i>javax.sql.XADataSource</i> interface.</p></li>
 </ul>
-<p>See the API documentation for each class for more information.</p>
+<p>For more information, see the API documentation for each class.</p>
 </section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/ref/rrefapi1003363.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefapi1003363.dita?rev=1577212&r1=1577211&r2=1577212&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefapi1003363.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefapi1003363.dita Thu Mar 13 15:49:57 2014
@@ -39,38 +39,43 @@ limitations under the License.
 <section><p>These classes are all related to
 <ph conref="../conrefs.dita#prod/productshortname"></ph>'s implementation of
 <i>javax.sql.DataSource</i> and related APIs. For more information, see
-<xref href="crefjdbc12657.dita#crefjdbc12657"></xref>, "Classes that pertain to
-resource managers" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph>, and
-"Accessing the Network Server by using a DataSource object" in the
+<xref href="crefjdbc12657.dita#crefjdbc12657"></xref>,
+<xref href="rrefjdbc4_2compactprofiles.dita#rrefjdbc4_2compactprofiles"></xref>,
+"Classes that pertain to resource managers" in the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph>, and "Accessing the Network
+Server by using a DataSource object" in the
 <ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
-<p>Embedded environment:</p>
-<ul>
-<li><i>org.apache.derby.jdbc.EmbeddedDataSource</i></li>
-<li><i>org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource</i></li>
-<li><i>org.apache.derby.jdbc.EmbeddedXADataSource</i></li>
-</ul>
-<p>Embedded environment, for applications using Java SE 8 Compact Profile 2
-or 3:</p>
+<p>Embedded environment, for applications using Java SE 8 Compact Profile 2:</p>
 <ul>
 <li><i>org.apache.derby.jdbc.BasicEmbeddedDataSource40</i></li>
 <li><i>org.apache.derby.jdbc.BasicEmbeddedConnectionPoolDataSource40</i></li>
 <li><i>org.apache.derby.jdbc.BasicEmbeddedXADataSource40</i></li>
 </ul>
-<p>Client-server environment:</p>
+<p>Embedded environment, for applications using all other Java SE versions:</p>
 <ul>
-<li><i>org.apache.derby.jdbc.ClientDataSource</i></li>
-<li><i>org.apache.derby.jdbc.ClientConnectionPoolDataSource</i></li>
-<li><i>org.apache.derby.jdbc.ClientXADataSource</i></li>
+<li><i>org.apache.derby.jdbc.EmbeddedDataSource</i></li>
+<li><i>org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource</i></li>
+<li><i>org.apache.derby.jdbc.EmbeddedXADataSource</i></li>
 </ul>
 <p>Client-server environment, for applications using Java SE 8 Compact Profile
-2 or 3:</p>
+2:</p>
 <ul>
 <li><i>org.apache.derby.jdbc.BasicClientDataSource40</i></li>
 <li><i>org.apache.derby.jdbc.BasicClientConnectionPoolDataSource40</i></li>
 <li><i>org.apache.derby.jdbc.BasicClientXADataSource40</i></li>
 </ul>
-<p>Applications using Java SE 8 Compact Profile 3 can use either the ordinary
-DataSource classes or those whose names begin with "Basic".</p>
+<p>Client-server environment, for applications using all other Java SE
+versions:</p>
+<ul>
+<li><i>org.apache.derby.jdbc.ClientDataSource</i></li>
+<li><i>org.apache.derby.jdbc.ClientConnectionPoolDataSource</i></li>
+<li><i>org.apache.derby.jdbc.ClientXADataSource</i></li>
+</ul>
+<p>Applications using Java SE 8 Compact Profile 2 must use the DataSource
+classes whose names begin with "Basic". Applications using Java SE 8 Compact
+Profile 3 can use the classes whose names begin with "Basic" if the application
+does not use the JNDI API, but should normally use the ordinary DataSource
+classes.</p>
 </section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita?rev=1577212&r1=1577211&r2=1577212&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita Thu Mar 13 15:49:57 2014
@@ -104,11 +104,13 @@ for other attributes related to tracing.
 </tgroup>
 </table>
 <p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides two
-ClientDataSource implementations. Use the
+ClientDataSource implementations. You can use the
 <codeph>org.apache.derby.jdbc.ClientDataSource</codeph> class on all supported
 Java SE versions except Java SE 8 Compact Profile 2. On Java SE 8 Compact
-Profile 2, use the
-<codeph>org.apache.derby.jdbc.BasicClientDataSource40</codeph> class.</p>
+Profile 2, you must use the
+<codeph>org.apache.derby.jdbc.BasicClientDataSource40</codeph> class. See
+<xref href="rrefjdbc4_2compactprofiles.dita#rrefjdbc4_2compactprofiles"></xref>
+for more information.</p>
 <p>To specify more than one trace level, use one of the following techniques:
 </p>
 <ul>

Modified: db/derby/docs/trunk/src/ref/rrefjdbc4_2compactprofiles.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc4_2compactprofiles.dita?rev=1577212&r1=1577211&r2=1577212&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc4_2compactprofiles.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc4_2compactprofiles.dita Thu Mar 13 15:49:57 2014
@@ -24,26 +24,27 @@ limitations under the License.
 </metadata></prolog>
 <refbody>
 <section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
-support for Compact Profiles 2 and 3 on the Java SE 8 platform by means of a
-group of JDBC DataSource classes. (Compact Profile 1 does not provide any JDBC
-support.)</p>
-<p>The following DataSource classes, all within the
-<codeph>org.apache.derby.jdbc</codeph> package, support Java SE 8 Compact
-Profiles 2 and 3:</p>
+support for Compact Profiles on the Java SE 8 platform by means of a
+group of JDBC DataSource classes. These DataSource classes cannot be used in
+applications that use the Java Naming and Directory Interface (JNDI) API.
+Otherwise, they are just like the versions for the full Java SE platform.</p>
+<p>Applications using Java SE 8 Compact Profile 2 <i>must</i> use these classes.
+Applications using Java SE 8 Compact Profile 3 can use the ordinary DataSource
+classes. (Compact Profile 1 does not provide any JDBC support, so
+<ph conref="../conrefs.dita#prod/productshortname"></ph> does not support
+it.)</p>
+<p>The following DataSource classes are required for use with Java SE 8 Compact
+Profile 2:</p>
 <ul>
-<li><b>org.apache.derby.jdbc.BasicEmbeddedConnectionPoolDataSource40</b></li>
 <li><b>org.apache.derby.jdbc.BasicEmbeddedDataSource40</b></li>
+<li><b>org.apache.derby.jdbc.BasicEmbeddedConnectionPoolDataSource40</b></li>
 <li><b>org.apache.derby.jdbc.BasicEmbeddedXADataSource40</b></li>
 </ul>
 <ul>
-<li><b>org.apache.derby.jdbc.BasicClientConnectionPoolDataSource40</b></li>
 <li><b>org.apache.derby.jdbc.BasicClientDataSource40</b></li>
+<li><b>org.apache.derby.jdbc.BasicClientConnectionPoolDataSource40</b></li>
 <li><b>org.apache.derby.jdbc.BasicClientXADataSource40</b></li>
 </ul>
-<p>These DataSource classes cannot be used in applications that use the
-Java Naming and Directory Interface (JNDI) API. Otherwise, they are just like
-the versions for the full Java SE platform. Applications using Java SE 8 Compact
-Profile 3 can use either these classes or the ordinary DataSource classes.</p>
 </section>
 </refbody>
 </reference>