Stardust/Knowledge Base/SystemAdministration/Migration/MigratingJCRContentRepository

Introduction

The default Stardust setup uses a Jackrabbit based content repository for document management and storage. Over a period of time the repository may grow large and a need may arise to migrate it to a different file system or even to a different storage mechanism (for e.g. from file system storage to database). The following discussion outlines the steps to be followed to achieve this.

Jackrabbit standalone server

The Jackrabbit standalone server perhaps provides the quickest and most reliable technique to achieve repository migration using the Jackrabbit RepositoryCopier API. For details on this option please refer to the documentation available http://jackrabbit.apache.org/standalone-server.html#StandaloneServer-Backupandmigration. Please ensure that the Jackrabbit version you use matches the one used by Stardust (2.6.1 as of Stardust 1.1). A sample backup command is shown below:

java -cp jackrabbit-standalone-2.6.1.jar;mysql-connector-java-5.1.18.jar org.apache.jackrabbit.standalone.Main  
--backup --repo repository --conf repository.xml --backup-repo jackrabbit-backup --backup-conf repository_mysql.xml

In the command above, the source repository location and configuration are specified by the parameters "repo" and "conf" respectively while those for the target repository are specified by the parameters "backup-repo" and "backup-conf" respectively. Here, we have chosen to migrate the repository from the file system to a MYSQL database. Note that the source repository must be shut down (i.e. no running Stardust web applications pointed to this repository) prior to running the above command. A sample MYSQL based repository configuration is shown below:

<?xml version="1.0"?>
<!--
   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 Repository
          PUBLIC "-//The Apache Software Foundation//DTD Jackrabbit 2.0//EN"
          "http://jackrabbit.apache.org/dtd/repository-2.0.dtd">
 
<!-- Example Repository Configuration File
     Used by
     - org.apache.jackrabbit.core.config.RepositoryConfigTest.java
     -
-->
<Repository>
    <!--
        virtual file system where the repository stores global state
        (e.g. registered namespaces, custom node types, etc.)
    -->
    <FileSystem class="org.apache.jackrabbit.core.fs.db.DbFileSystem">
	   <param name="driver" value="com.mysql.jdbc.Driver"/>
       <param name="url" value="jdbc:mysql://localhost:3306/jackrabbit"/>
       <param name="schema" value="mysql"/>
       <param name="schemaObjectPrefix" value="rep_"/>
	   <param name="user" value="xxx" />
       <param name="password" value="xxx" />
    </FileSystem>
 
    <!--
        data store configuration
    -->
    <DataStore class="org.apache.jackrabbit.core.data.db.DbDataStore">
    	<param name="databaseType" value="mysql"/>
		<param name="url" value="jdbc:mysql://localhost:3306/jackrabbit"/>
		<param name="driver" value="com.mysql.jdbc.Driver"/>
		<param name="schema" value="jackrabbit"/>
		<param name="user" value="xxx" />
        <param name="password" value="xxx" />
    </DataStore>	 
 
    <!--
        security configuration
    -->
    <Security appName="Jackrabbit">
        <!--
            security manager:
            class: FQN of class implementing the JackrabbitSecurityManager interface
        -->
        <!--<SecurityManager class="org.apache.jackrabbit.core.DefaultSecurityManager" workspaceName="security">-->
            <!--
            workspace access:
            class: FQN of class implementing the WorkspaceAccessManager interface
            -->
            <!-- <WorkspaceAccessManager class="..."/> -->
            <!-- <param name="config" value="${rep.home}/security.xml"/> -->
        <!--</SecurityManager>-->
 
        <!--
            access manager:
            class: FQN of class implementing the AccessManager interface
        -->
        <AccessManager class="org.apache.jackrabbit.core.security.simple.SimpleAccessManager">
            <!-- <param name="config" value="${rep.home}/access.xml"/> -->
        </AccessManager>
 
        <LoginModule class="org.apache.jackrabbit.core.security.simple.SimpleLoginModule">
           <!-- 
              anonymous user name ('anonymous' is the default value)
            -->
           <param name="anonymousId" value="anonymous"/>
           <!--
              administrator user id (default value if param is missing is 'admin')
            -->
           <param name="adminId" value="admin"/>
        </LoginModule>
    </Security>
 
    <!--
        location of workspaces root directory and name of default workspace
    -->
    <Workspaces rootPath="${rep.home}/workspaces" defaultWorkspace="default"/>
    <!--
        workspace configuration template:
        used to create the initial workspace if there's no workspace yet
    -->
    <Workspace name="${wsp.name}">
        <!--
            virtual file system of the workspace:
            class: FQN of class implementing the FileSystem interface
        -->
        <FileSystem class="org.apache.jackrabbit.core.fs.db.DbFileSystem">
			<param name="driver" value="com.mysql.jdbc.Driver"/>
			<param name="url" value="jdbc:mysql://localhost:3306/jackrabbit"/>
			<param name="schema" value="mysql"/>
			<param name="schemaObjectPrefix" value="${wsp.name}_"/>
			<param name="user" value="xxx" />
            <param name="password" value="xxx" />
        </FileSystem>
        <!--
            persistence manager of the workspace:
            class: FQN of class implementing the PersistenceManager interface
        -->
<!--
        <PersistenceManager class="org.apache.jackrabbit.core.persistence.pool.DerbyPersistenceManager">
          <param name="url" value="jdbc:derby:${wsp.home}/db;create=true"/>
          <param name="schemaObjectPrefix" value="${wsp.name}_"/>
        </PersistenceManager>
-->
 
	<PersistenceManager class="org.apache.jackrabbit.core.persistence.pool.MySqlPersistenceManager">
          <param name="url" value="jdbc:mysql://localhost:3306/jackrabbit"/>
          <param name="schema" value="mysql"/>
          <param name="schemaObjectPrefix" value="pm_ws_${wsp.name}_"/>
		  <param name="driver" value="com.mysql.jdbc.Driver"/>
		  <param name="user" value="xxx" />
          <param name="password" value="xxx" />
        </PersistenceManager>
 
        <!--
            Search index and the file system it uses.
            class: FQN of class implementing the QueryHandler interface
        -->
        <SearchIndex class="org.apache.jackrabbit.core.query.lucene.SearchIndex">
            <param name="path" value="${wsp.home}/index"/>
            <param name="supportHighlighting" value="true"/>
        </SearchIndex>
    </Workspace>
 
    <!--
        Configures the versioning
    -->
    <Versioning rootPath="${rep.home}/version">
        <!--
            Configures the filesystem to use for versioning for the respective
            persistence manager
        -->
        <FileSystem class="org.apache.jackrabbit.core.fs.db.DbFileSystem">
			<param name="driver" value="com.mysql.jdbc.Driver"/>
			<param name="url" value="jdbc:mysql://localhost:3306/jackrabbit"/>
			<param name="schema" value="mysql"/>
			<param name="schemaObjectPrefix" value="version_"/>
			<param name="user" value="xxx" />
            <param name="password" value="xxx" />
        </FileSystem>
 
        <!--
            Configures the persistence manager to be used for persisting version state.
            Please note that the current versioning implementation is based on
            a 'normal' persistence manager, but this could change in future
            implementations.
        -->
<!--
        <PersistenceManager class="org.apache.jackrabbit.core.persistence.pool.DerbyPersistenceManager">
          <param name="url" value="jdbc:derby:${rep.home}/version/db;create=true"/>
          <param name="schemaObjectPrefix" value="version_"/>
        </PersistenceManager>
-->
 
        <PersistenceManager class="org.apache.jackrabbit.core.persistence.pool.MySqlPersistenceManager">
          <param name="url" value="jdbc:mysql://localhost:3306/jackrabbit"/>
          <param name="schema" value="mysql"/>
          <param name="schemaObjectPrefix" value="pm_vs_"/>
		  <param name="driver" value="com.mysql.jdbc.Driver"/>
		  <param name="user" value="xxx" />
          <param name="password" value="xxx" />
        </PersistenceManager>
    </Versioning>
 
    <!--
        Search index for content that is shared repository wide
        (/jcr:system tree, contains mainly versions)
    -->
    <SearchIndex class="org.apache.jackrabbit.core.query.lucene.SearchIndex">
        <param name="path" value="${rep.home}/repository/index"/>
        <param name="supportHighlighting" value="true"/>
    </SearchIndex>
 
    <!--
        Run with a cluster journal
    -->
    <Cluster id="node1">
        <Journal class="org.apache.jackrabbit.core.journal.MemoryJournal"/>
    </Cluster>
</Repository>

Server and web application changes

For the sake of completeness we also list the changes required to get a Stardust web application hosted on Tomcat against the above MYSQL based Jackrabbit repository.