jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From thom...@apache.org
Subject svn commit: r598232 - /jackrabbit/trunk/jackrabbit-site/src/site/xdoc/doc/config.xml
Date Mon, 26 Nov 2007 11:35:11 GMT
Author: thomasm
Date: Mon Nov 26 03:35:08 2007
New Revision: 598232

URL: http://svn.apache.org/viewvc?rev=598232&view=rev
Log:
JCR-73 Move the remaining Persistence Manager documentation to the Wiki, and link there

Modified:
    jackrabbit/trunk/jackrabbit-site/src/site/xdoc/doc/config.xml

Modified: jackrabbit/trunk/jackrabbit-site/src/site/xdoc/doc/config.xml
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-site/src/site/xdoc/doc/config.xml?rev=598232&r1=598231&r2=598232&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-site/src/site/xdoc/doc/config.xml (original)
+++ jackrabbit/trunk/jackrabbit-site/src/site/xdoc/doc/config.xml Mon Nov 26 03:35:08 2007
@@ -227,195 +227,10 @@
     </section>
     <section name="Persistence managers" id="PersistenceManager">
       <p>
-        Persistence managers are Jackrabbit components that manage the
-        persistent storage of content nodes and properties. 
-        The <code>org.apache.jackrabbit.core.state.PersistenceManger</code>
+        For more information about persistence managers, see the 
+        <a href="http://wiki.apache.org/jackrabbit/PersistenceManagerFAQ">Persistence
Manager FAQ</a>
+        in the Wiki section.
       </p>
-      <p>
-        A separate persistence manager is assigned to each workspace and the
-        global versioning store. The persistence manager implementations to
-        use are configured using the <code>PersistenceManager</code>
-        configuration element within the <code>Workspace</code> configuration
-        template (and the instantiated workspace configuration files) and the
-        <code>Versioning</code> configuration element. The layout of a
-        <code>PersistenceManager</code> configuration element is shown below.
-      </p>
-<source><![CDATA[<PersistenceManager class="...">
-    <param name="...">...</param>
-    ...
-</PersistenceManager>
-]]></source>
-      <p>
-        The <code>class</code> attribute of the <code>PersistenceManager</code>
-        element contains the fully qualified class name of the persistence
-        manager implementation class. The class must implement the
-        <code>org.apache.jackrabbit.core.persistence.PersistenceManager</code>
-        interface and have an empty default constructor. String properties
-        can be assigned using the <code>param</code> elements according to
-        the JavaBean conventions.
-      </p>
-      <p>
-        See the <a href="../api-1/org/apache/jackrabbit/core/state/PersistenceManager.html">PersistenceManager
javadocs</a>
-        for more details.
-      </p>
-      <subsection name="InMemPersistenceManager" id="InMemPersistenceManager">
-        <p>
-          The <code>
-            org.apache.jackrabbit.core.persistence.mem.InMemPersistenceManager
-        </code>
-          class implements a simple persistence manager that keeps all content
-          in memory. A custom binary serializer is optionally used to load
-          and store the persistent state during initialization and shutdown
-          of the persistence manager.
-        </p>
-        <p>
-          This persistence manager is best suited for testing and for small
-          workspaces that need extra performance at the cost of reliable
-          persistence. The configuration parameters for the
-          <code>InMemPersistenceManager</code> class are:
-        </p>
-        <dl>
-          <dt><code>persistent</code></dt>
-          <dd>
-            Set to <code>true</code> to enable the use of the binary
-            serializer to persistently load and store the managed content
-            during startup and shutdown.
-          </dd>
-          <dt><code>initialCapacity</code></dt>
-          <dd>
-            The initial capacity of the hash maps used to store the
-            content items. The default value should be fine for almost
-            all uses of this persistence manager.
-          </dd>
-          <dt><code>loadFactory</code></dt>
-          <dd>
-            The load factor of the hash maps. The default value should be
-            fine for almost all uses of this persistence manager.
-          </dd>
-        </dl>
-        <p>
-          See the <a href="../api-1/org/apache/jackrabbit/core/state/db/InMemPersistenceManager.html">InMemPersistenceManager
javadocs</a>
-          for more details.
-        </p>
-      </subsection>
-      <subsection name="ObjectPersistenceManager" id="ObjectPersistenceManager">
-        <p>
-          The <code>
-            org.apache.jackrabbit.core.persistence.obj.ObjectPersistenceManager
-        </code>
-          class implements a persistence manager that uses a custom binary
-          serialization format to store the managed content directly in
-          the underlying virtual file system. The virtual file system is
-          expected to perform well with a large number of small files.
-        </p>
-        <p>
-          There are no configuration parameters for the
-          <code>ObjectPersistenceManager</code> class.
-        </p>
-        <p>
-          See the <a href="../api-1/org/apache/jackrabbit/core/state/obj/ObjectPersistenceManager.html">ObjectPersistenceManager
javadocs</a>
-          for more details.
-        </p>
-      </subsection>
-      <subsection name="XMLPersistenceManager" id="XMLPersistenceManager">
-        <p>
-          The <code>
-            org.apache.jackrabbit.core.persistence.xml.XMLPersistenceManager
-        </code>
-          class implements a persistence manager that uses XML files stored
-          in the underlying virtual file system. The difference between this
-          persistence manager and the ObjectPersistenceManager is the storage
-          format used. The XMLPersistenceManager is best suited for testing
-          and debugging where readability of the content files is more
-          important than repository performance.
-        </p>
-        <p>
-          There are no configuration parameters for the
-          <code>XMLPersistenceManager</code> class.
-        </p>
-        <p>
-          See the <a href="../api-1/org/apache/jackrabbit/core/state/xml/XMLPersistenceManager.html">XMLPersistenceManager
javadocs</a>
-          for more details.
-        </p>
-      </subsection>
-      <subsection name="SimpleDbPersistenceManager" id="SimpleDbPersistenceManager">
-        <p>
-          The <code>
-            org.apache.jackrabbit.core.persistence.db.SimpleDbPersistenceManager
-        </code>
-          class implements a generic Java Database Connectivity (JDBC) -based
-          persistence manager. Content is stored in a set of simple
-          non-normalized tables that are created automatically unless they
-          already exist. The configuration parameters for the
-          <code>SimpleDbPersistenceManager</code> class are:
-        </p>
-        <dl>
-          <dt><code>driver</code></dt>
-          <dd>
-            The fully qualified name of the JDBC driver class.
-          </dd>
-          <dt><code>url</code></dt>
-          <dd>
-            The JDBC database URL.
-          </dd>
-          <dt><code>user</code></dt>
-          <dd>
-            The database user. The user should have full access to the
-            content tables and administrative access to create the tables
-            if the tables have not already been created.
-          </dd>
-          <dt><code>password</code></dt>
-          <dd>
-            The password of the database user.
-          </dd>
-          <dt><code>schema</code></dt>
-          <dd>
-            The type of database schema to use for creating the content tables
-            if needed. (<code>mysql</code>, <code>mssql</code>, etc.)
-          </dd>
-          <dt><code>schemaObjectPrefix</code></dt>
-          <dd>
-            The prefix to use for the names of the content tables.
-          </dd>
-          <dt><code>externalBLOBs</code></dt>
-          <dd>
-            Set to <code>true</code> (the default) to store binary properties
-            in the underlying virtual file system. Set to <code>false</code>
-            to store binary properties in the database.
-          </dd>
-        </dl>
-        <p>
-          See the <a href="../api-1/org/apache/jackrabbit/core/state/db/SimpleDbPersistenceManager.html">SimpleDbPersistenceManager
javadocs</a>
-          for more details.
-        </p>
-      </subsection>
-      <subsection name="DerbyPersistenceManager" id="DerbyPersistenceManager">
-        <p>
-          The <code>
-            org.apache.jackrabbit.core.persistence.db.DerbyPersistenceManager
-        </code>
-          is a subclass of the <code>SimpleDbPersistenceManager</code>. It
-          implements a persistence manager that uses an embedded
-          <a href="http://db.apache.org/derby/">Apache Derby</a> database
-          to manage content.
-        </p>
-        <p>
-          The <code>DerbyPersistenceManager</code> class has the same
-          configuration parameters as the
-          <code>SimpleDbPersistenceManager</code>, but provides Derby-specific
-          defaults for the <code>driver</code> and <code>schema</code>
-          parameters. The <code>url</code> parameter should normally be
-          something like <code>jdbc:derby:${wsp.home}/db;create=true</code>
-          and the <code>user</code> and <code>password</code> parameters
can
-          be ignored. As Derby has reasonable support for binary content,
-          it often makes sense to set the <code>externalBLOBs</code> parameter
-          to <code>false</code>.
-        </p>
-        <p>
-          See the <a href="../api-1/org/apache/jackrabbit/core/state/db/DerbyPersistenceManager.html">DerbyPersistenceManager
javadocs</a>
-          for more details.
-        </p>
-      </subsection>
     </section>
     <section name="Query handlers" id="QueryHandler">
       <p>TODO</p>



Mime
View raw message