db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r1124896 - in /db/derby/docs/trunk/src: devguide/ ref/
Date Thu, 19 May 2011 15:05:54 GMT
Author: chaase3
Date: Thu May 19 15:05:54 2011
New Revision: 1124896

URL: http://svn.apache.org/viewvc?rev=1124896&view=rev
Log:
DERBY-484  Documentation for derby.database.classpath in developers guide is misleading

Added new topic to Reference Manual, modified files in Reference Manual and Developer's Guide

Patches: DERBY-484-2.diff

Added:
    db/derby/docs/trunk/src/ref/rrefproperclasspath.dita   (with props)
Modified:
    db/derby/docs/trunk/src/devguide/cdevdeploy15818.dita
    db/derby/docs/trunk/src/devguide/cdevdeploy21645.dita
    db/derby/docs/trunk/src/devguide/cdevdeploy857611.dita
    db/derby/docs/trunk/src/devguide/cdevdeploy857648.dita
    db/derby/docs/trunk/src/ref/crefproper22250.dita
    db/derby/docs/trunk/src/ref/crefstorejardb.dita
    db/derby/docs/trunk/src/ref/refderby.ditamap

Modified: db/derby/docs/trunk/src/devguide/cdevdeploy15818.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdeploy15818.dita?rev=1124896&r1=1124895&r2=1124896&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdeploy15818.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdeploy15818.dita Thu May 19 15:05:54 2011
@@ -26,7 +26,7 @@ the following classes:</shortdesc>
 <prolog></prolog>
 <conbody>
 <ul>
-<li>The standard Java packages (<i>java.*</i>, <codeph><i>javax.*</i></codeph>)
+<li>The standard Java packages (<i>java.*</i>, <i>javax.*</i>)
   <p><ph conref="../conrefs.dita#prod/productshortname"></ph> does not
prevent
 you from storing such a jar file in the database, but these classes <i>are
 never loaded</i> from the jar file.</p></li>

Modified: db/derby/docs/trunk/src/devguide/cdevdeploy21645.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdeploy21645.dita?rev=1124896&r1=1124895&r2=1124896&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdeploy21645.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdeploy21645.dita Thu May 19 15:05:54 2011
@@ -21,30 +21,30 @@ limitations under the License.
 <concept id="cdevdeploy21645" xml:lang="en-us">
 <title>Enable database class loading with a property</title>
 <shortdesc>Once you have added one or more jar files to a database, you must
-set the database jar "classpath" by including the jar file or files in the <i>derby.database.classpath</i>
property
+set the database jar classpath by including the jar file or files in the <i>derby.database.classpath</i>
property
 to enable <ph conref="../conrefs.dita#prod/productshortname"></ph> to load
 classes from the jar files.</shortdesc>
 <prolog></prolog>
 <conbody>
-<p>This property, which behaves like a class path, specifies the jar files
+<p>This property, which behaves like a classpath, specifies the jar files
 to be searched for classes and resources and the order in which they are searched.
 If <ph conref="../conrefs.dita#prod/productshortname"></ph> does not find
 a needed class stored in the database, it can retrieve the class from the
 user's classpath. (<ph conref="../conrefs.dita#prod/productshortname"></ph> first
 looks in the user's classpath before looking in the database.)</p>
 <ul>
-<li>Separate jar files with a colon (:).</li>
-<li>Use two-part names for the jar files (schema name and jar name). Set the
-property as a database-level property for the database. The <i>first time</i>
you
-set the property, you must reboot to load the classes.</li>
+<li>Separate jar files with a colon (<codeph>:</codeph>).</li>
+<li>Use fully qualified identifiers for the jar files (schema name and jar
+name).</li>
+<li>Set the property as a database-level property for the database.</li>
 </ul>
 <p>Example:</p>
 <codeblock><b>CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY(
     'derby.database.classpath',
     'APP.ToursLogic:APP.ACCOUNTINGLOGIC')</b></codeblock>
 <p>See "<i>derby.database.classpath</i>" in the
-<ph conref="../conrefs.dita#pub/citref"></ph> for
-more information about the property.</p>
+<ph conref="../conrefs.dita#pub/citref"></ph> for more information about the
+property.</p>
 <note><ph conref="../conrefs.dita#prod/productshortname"></ph>'s class
loader
 looks first in the user's classpath for any needed classes, and then in the
 database. To ensure class loading with the database class loader, remove classes

Modified: db/derby/docs/trunk/src/devguide/cdevdeploy857611.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdeploy857611.dita?rev=1124896&r1=1124895&r2=1124896&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdeploy857611.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdeploy857611.dita Thu May 19 15:05:54 2011
@@ -27,7 +27,7 @@ be able to load the new classes right aw
 <ul>
 <li>You <i>originally configured</i> database-level class loading for the
 database correctly. Turning on the database-level class loading property requires
-setting the <codeph><i>derby.database.classpath</i></codeph> property
with
+setting the <i>derby.database.classpath</i> property with
 valid two-part names, then rebooting.</li>
 <li>If changes to the <i>derby.database.classpath</i> property are needed
 to reflect new jar files, you change the property to a valid value.</li>

Modified: db/derby/docs/trunk/src/devguide/cdevdeploy857648.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdeploy857648.dita?rev=1124896&r1=1124895&r2=1124896&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdeploy857648.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdeploy857648.dita Thu May 19 15:05:54 2011
@@ -29,8 +29,8 @@ has not changed.</p>
 <p>Any existing prepared statements will use the previously loaded classes
 unless they require class loading, in which case they will fail with a <i>ClassNotFound</i>
error.</p>
 <p>Cached objects do not match objects created with newly loaded classes.
-For example, an in-memory <i>Customer</i> object will not match a new <codeph><i>Customer</i></codeph>
object
-if the <codeph><i>Customer</i></codeph> class has been reloaded,
and it will
-raise a <codeph><i>ClassCastException.</i></codeph> </p>
+For example, an in-memory <i>Customer</i> object will not match a new <i>Customer</i>
object
+if the <i>Customer</i> class has been reloaded, and it will
+raise a <i>ClassCastException</i>.</p>
 </conbody>
 </concept>

Modified: db/derby/docs/trunk/src/ref/crefproper22250.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefproper22250.dita?rev=1124896&r1=1124895&r2=1124896&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefproper22250.dita (original)
+++ db/derby/docs/trunk/src/ref/crefproper22250.dita Thu May 19 15:05:54 2011
@@ -130,6 +130,11 @@ conglomerates.</p>
 <entry colname="3">Static</entry>
 </row>
 <row>
+<entry colname="1"><i><xref href="rrefproperclasspath.dita#rrefproperclasspath">derby.database.classpath</xref></i></entry>
+<entry colname="2">D</entry>
+<entry colname="3">Dynamic</entry>
+</row>
+<row>
 <entry colname="1"><i><xref href="rrefproper24846.dita#rrefproper24846">derby.database.defaultConnectionMode</xref></i></entry>
 <entry colname="2">S, D</entry>
 <entry colname="3">See the main page for this property for information

Modified: db/derby/docs/trunk/src/ref/crefstorejardb.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefstorejardb.dita?rev=1124896&r1=1124895&r2=1124896&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefstorejardb.dita (original)
+++ db/derby/docs/trunk/src/ref/crefstorejardb.dita Thu May 19 15:05:54 2011
@@ -16,7 +16,7 @@ See the License for the specific languag
 limitations under the License.
 -->
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
-<concept xml:lang="en-us" id="ctoolsstorejardb">
+<concept xml:lang="en-us" id="crefstorejardb">
 <title>System procedures for storing jar files in a database</title>
 <conbody>
 <p><codeph>SQLJ.INSTALL_JAR</codeph>, <codeph>SQLJ.REMOVE_JAR</codeph>,
and

Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=1124896&r1=1124895&r2=1124896&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Thu May 19 15:05:54 2011
@@ -728,6 +728,8 @@ URL syntax"></topicref>
 </topicref>
 <topicref href="rrefproper27467.dita" navtitle="derby.connection.requireAuthentication">
 </topicref>
+<topicref href="rrefproperclasspath.dita" navtitle="derby.database.classpath">
+</topicref>
 <topicref href="rrefproper24846.dita" navtitle="derby.database.defaultConnectionMode">
 </topicref>
 <topicref href="rrefproper81405.dita" navtitle="derby.database.forceDatabaseLock">

Added: db/derby/docs/trunk/src/ref/rrefproperclasspath.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperclasspath.dita?rev=1124896&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperclasspath.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefproperclasspath.dita Thu May 19 15:05:54 2011
@@ -0,0 +1,72 @@
+<?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.
+-->
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
+<reference xml:lang="en-us" id="rrefproperclasspath">
+<title>derby.database.classpath</title>
+<prolog><metadata>
+<keywords><indexterm>derby.database.classpath</indexterm>
+<indexterm>database-wide properties<indexterm>setting classpath for jar
+files</indexterm></indexterm>
+</keywords>
+</metadata>
+</prolog><refbody>
+<section><title>Function</title>
+<p>Specifies the classpath that
+<ph conref="../conrefs.dita#prod/productshortname"></ph> should use when
+searching for jar files in a database. This property must be set to
+enable <ph conref="../conrefs.dita#prod/productshortname"></ph> to load classes
+from jar files installed with the <xref
+href="rrefstorejarinstall.dita#rrefstorejarinstall"></xref>.</p>
+<p>Make sure to do the following:</p>
+<ul>
+<li>Separate jar files with a colon (<codeph>:</codeph>).</li>
+<li>Use fully qualified identifiers for the jar files (schema name and jar
+name).</li>
+<li>Set the property as a database-level property for the database.</li>
+</ul>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> searches the
user's
+classpath before it searches the jar files specified by the
+<i>derby.database.classpath</i> property setting. To force
+<ph conref="../conrefs.dita#prod/productshortname"></ph> to search the
+database only, remove the classes from the user classpath.</p>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> searches for
classes
+and resources in the order specified by the property setting.</p>
+<p>For more information, see the section "Loading classes from a database" in
+the <ph conref="../conrefs.dita#pub/citdevelop"></ph>. For reference information
+on system procedures for storing jar files in a database, see 
+"<xref href="crefstorejardb.dita#crefstorejardb"></xref>."</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>-- database-level property
+CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY(
+    'derby.database.classpath',
+    '<b><i>colonSeparatedJarFiles</i></b>')</b></codeblock>
+</refsyn>
+<example><title>Example</title>
+<codeblock><b>-- database-level property
+CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY(
+    'derby.database.classpath',
+    'APP.ToursLogic:APP.ACCOUNTINGLOGIC')</b></codeblock>
+</example>
+<section><title>Dynamic or static</title>
+<p>Dynamic; the change takes effect immediately. For information about dynamic
+changes to properties, see
+<xref href="crefproperdynstat.dita#crefproperdynstat"/>.</p>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefproperclasspath.dita
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message