You are viewing a plain text version of this content. The canonical link for it is here.
Posted to ojb-dev@db.apache.org by ar...@apache.org on 2006/08/07 19:12:01 UTC

svn commit: r429397 - in /db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides: deployment.xml metadata.xml platforms.xml repository.xml

Author: arminw
Date: Mon Aug  7 10:12:01 2006
New Revision: 429397

URL: http://svn.apache.org/viewvc?rev=429397&view=rev
Log:
update/add 
database platform declaration
repository.xml file read in

Modified:
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/metadata.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/platforms.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/repository.xml

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml?rev=429397&r1=429396&r2=429397&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/deployment.xml Mon Aug  7 10:12:01 2006
@@ -384,7 +384,7 @@
 ...
 # set used application server TM access class
 JTATransactionManagerClass=
-org.apache.ojb.otm.transaction.factory.JBossTransactionManagerFactory]]></source>
+    org.apache.ojb.broker.transaction.tm.JBossTransactionManagerFactory]]></source>
                     <p>
                         A specific
                         <a href="site:connection">

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/metadata.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/metadata.xml?rev=429397&r1=429396&r2=429397&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/metadata.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/metadata.xml Mon Aug  7 10:12:01 2006
@@ -79,6 +79,7 @@
         </section>
 
 
+        <anchor id="when-read-in"/>
         <section>
             <title>When does OJB read metadata</title>
             <p>

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/platforms.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/platforms.xml?rev=429397&r1=429396&r2=429397&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/platforms.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/platforms.xml Mon Aug  7 10:12:01 2006
@@ -50,6 +50,25 @@
         <section>
             <title>Basic Concepts</title>
 
+            <anchor id="platform-declaration"/>
+            <section>
+                <title>Database Platform declaration</title>
+                <p>
+                    The database platform is declared in the
+                    <a href="site:repository/jdbc-connection-descriptor">jdbc-connection-descriptor</a> using
+                    the <em>platform</em> attribute. OJB supports many popular databases:
+                </p>
+                <p>
+                    Db2 | Hsqldb | Informix | MsAccess | MsSQLServer | MySQL | Oracle | PostgreSQL |
+                    Sybase | SybaseASE | SybaseASA | Sapdb | Firebird | Axion | Oracle9i (or higher) |
+                    MaxDB | Derby
+                </p>
+                <p>
+                    Additionally it's possible to specifiy custom <a href="ext:platform"><code>Platform</code></a>
+                    implementation classes.
+                </p>
+            </section>
+
             <anchor id="internal-tables"/>
             <section>
                 <title>OJB internal tables</title>
@@ -60,8 +79,8 @@
                     of these internal used tables can be found in
                     <a href="ext:repository_internal.xml">repository_internal.xml</a> file.
                     <br/>
-                    If those features are not needed/used OJB can be safely run without any internal tables
-                    and metadata mapping.
+                    If those features are not needed/used <strong>OJB can be safely run without any internal tables
+                    and metadata mapping</strong>.
                 </p>
                 <p>
                     The following table
@@ -87,8 +106,8 @@
 </table>]]></source>
                         </td>
                         <td>
-                            Table for the high/low sequence manager. The column <em>TABLENAME</em> was used
-                            to persist the sequence name (may be re-named in further versions of OJB).
+                            Table for the <a href="site:sequence-manager/high-low-sequence">high/low sequence manager</a>.
+                            The column <em>NAME</em> was used to persist the sequence name.
                             <br/>
                             If the built-in OJB sequence manager is not used, this table is not needed.
                         </td>

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/repository.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/repository.xml?rev=429397&r1=429396&r2=429397&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/repository.xml (original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/guides/repository.xml Mon Aug  7 10:12:01 2006
@@ -91,7 +91,10 @@
             <title>Repository loading settings</title>
             <p>
                 For correct loading of the repository file the <code>repository.xml</code> file (with all sub files)
-                and the <code>repository.dtd</code> have to be in the same place (directory, jar, ...).
+                and the <code>repository.dtd</code> have to be in the same place (directory, jar, ...). Class
+                <a href="ext:repository-persistor"><code>RepositoryPersistor</code></a> is used to read in the metadata
+                mapping and class <a href="ext:metadata-manager"><code>MetadataManager</code></a> is responsible
+                for metadata management at runtime - more details see <a href="site:metadata">metadata handling</a>.
             </p>
             <p>
                 By default OJB first lookup the repository file setting in system properties using keyword
@@ -127,6 +130,37 @@
                 If all else fails OJB simply use the path specified for <a href="site:ojb-properties">OJB.properties</a>
                 file (without <em>"OJB.properties"</em> ending) and add the repository file setting.
             </p>
+
+            <anchor id="specific-loading"/>
+            <section>
+                <title>Specific loading of 'repository.xml' file</title>
+                <p>
+                    If OJB isn't able to read the repository metadata, because of specific requirements
+                    it's possible to extend class
+                    <a href="ext:repository-persistor"><code>RepositoryPersistor</code></a> to implement a custom
+                    loading strategy.
+                </p>
+                <p>
+                    There are two possibilities to declare a custom implementation:
+                </p>
+                <ul>
+                    <li>
+                        Declare the custom class in <a href="site:ojb-properties">OJB.properties</a> file
+                        <source><![CDATA[
+# Allows to extend class RepositoryPersistor used to read and write (write is deprecated)
+# OJB's metadata.
+RepositoryPersistorClass=org.apache.ojb.broker.metadata.RepositoryPersistor
+]]></source>
+                    </li>
+                    <li>
+                        At runtime - Set the custom <code>RepositoryPersistor</code> class in
+                        <a href="ext:metadata-manager"><code>MetadataManager</code></a>. If OJB shall use the
+                        custom class at startup of OJB it's mandatory to set it before the first use of
+                        OJB (more details see <a href="site:metadata/when-read-in">metadata handling</a>). 
+                    </li>
+                </ul>
+            </section>
+
         </section>
 
             <anchor id="descriptor-repository"/>
@@ -294,12 +328,20 @@
                     <p>
                         The
                         <em>platform</em>
-                        attribute is used to define the specific RDBMS Platform. This attribute
-                        corresponds to a
-                        <em>org.apache.ojb.broker.platforms.PlatformXXXImpl</em> class.
-                        Supported databases
-                        <a href="#jcd.db">see here</a>.
-                        Default is <em>Hsqldb</em>.
+                        attribute is used to define the specific RDBMS Platform.
+                        <br/>
+                        OJB supports a bunch of predefined database token
+                        names which correspond to a
+                        <a href="ext:platform"><code>org.apache.ojb.broker.platforms.PlatformXXXImpl</code></a>
+                        class - supported databases <a href="#jcd.db">see here</a>. The default platform token
+                        is <em>Hsqldb</em>.
+                        <br/>
+                        If OJB doesn't support the used database the platform token <em>Default</em> can be set
+                        (for basic platform support) or the <em>full qualified class name</em> of a custom
+                        <a href="ext:platform"><code>Platform</code></a> implementation class.
+                        <br/>
+                        More details about platform related stuff can be found in the
+                        <a href="site:platform">platform guide</a>.
                     </p>
                     <p>
                         The
@@ -311,14 +353,14 @@
                         Default is
                         <em>1.0</em>.
                     </p>
-                    <p>
-                        <em>DEPRECATED!</em>. The
-                        <em>eager-release</em>
-                        attribute is used to solve a problem that occurs when using OJB within JBoss
-                        (3.0 &lt;= version &lt; 3.2.2, seems to be fixed in jboss 3.2.2 and higher).
-                        Only use within JBoss.
-                        <em>DEPRECATED</em> attribute.
-                    </p>
+                    <!--<p>-->
+                        <!--<em>DEPRECATED!</em>. The-->
+                        <!--<em>eager-release</em>-->
+                        <!--attribute is used to solve a problem that occurs when using OJB within JBoss-->
+                        <!--(3.0 &lt;= version &lt; 3.2.2, seems to be fixed in jboss 3.2.2 and higher).-->
+                        <!--Only use within JBoss.-->
+                        <!--<em>DEPRECATED</em> attribute.-->
+                    <!--</p>-->
                     <p>
                         The
                         <em>batch-mode</em>
@@ -438,10 +480,9 @@
     default-connection (true | false) "false"
     platform (  Db2 | Hsqldb | Informix | MsAccess | MsSQLServer |
                 MySQL | Oracle | PostgreSQL | Sybase | SybaseASE |
-                SybaseASA | Sapdb | Firebird | Axion | NonstopSql |
-                Oracle9i | MaxDB ) "Hsqldb"
+                SybaseASA | Sapdb | Firebird | Axion |
+                Oracle9i | MaxDB | Derby | Default) "Hsqldb"
     jdbc-level (1.0 | 2.0 | 3.0) "1.0"
-    eager-release (true | false) "false"
     batch-mode (true | false) "false"
     useAutoCommit (0 | 1 | 2) "1"
     ignoreAutoCommitExceptions (true | false) "false"



---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
For additional commands, e-mail: ojb-dev-help@db.apache.org