https://github.com/sitmcella/jackrabbit-oak-repository-upgrade
Jackrabbit Oak repository upgrade with custom node definitions
https://github.com/sitmcella/jackrabbit-oak-repository-upgrade
jackrabbit-oak java jcr
Last synced: 2 months ago
JSON representation
Jackrabbit Oak repository upgrade with custom node definitions
- Host: GitHub
- URL: https://github.com/sitmcella/jackrabbit-oak-repository-upgrade
- Owner: sitMCella
- License: mit
- Created: 2018-10-28T15:20:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-09T13:13:07.000Z (3 months ago)
- Last Synced: 2025-02-09T14:23:51.986Z (3 months ago)
- Topics: jackrabbit-oak, java, jcr
- Language: Java
- Homepage:
- Size: 1.19 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Apache Jackrabbit Oak repository upgrade
## Table of contents
* [Introduction](#introduction)
* [Build project](#build-project)
* [First Application](#first-application)
* [Configuration](#first-application-configuration)
* [Run the application](#run-the-first-version-application)
* [Repository upgrade](#repository-upgrade)
* [Second Application](#second-application)
* [Configuration](#second-application-configuration)
* [Run the application](#run-the-second-version-application)
* [Check repository content](#check-repository-content)
* [Custom node type registration](#custom-node-type-registration)
## Introduction
Apache Jackrabbit Oak is an implementation of JCR 2.0 specification.
https://jackrabbit.apache.org/oak/
This project provides a tool for upgrading a Jackrabbit Oak repository with custom node types defined in a Compact Namespace and Node Type Definition (CND) file.
Read the full [documentation](https://github.com/sitMCella/Jackrabbit-Oak-repository-upgrade/wiki/Home) of the project.
The project also provides a complete example with two applications used to interact with the repository in both the initial and final CND files.
The repository configuration file of the first application is "repository-first-version/src/main.resources/cnd.config".
The repository configuration file of the second application is "repository-second-version/src/main.resources/cnd.config".
The following are the main assumptions:
- The repository is an Oak Segment Tar (Tar file based Segment NodeStore)
- The repository contains custom node types
- The applications use the same Jackrabbit Oak version
The upgrade from the first repository to the second repository consists of the following steps:
- Remove the mixin "app:attributes" that contains the property "app:hidden"
- Add a new property "app:system" into an existent mixin "app:properties"
- Remove the property "app:deletable" from the mixin "app:properties"
- Add a new mixin "app:describable" with a property "app:description"
The repositories contain a versionable node "app:file" with a version-related mixin "app:versionInfo".
The upgrade procedure updates the node and node history properties definition.
## Build project
```sh
mvn clean install
```
## First Application
### Configuration
Configure the absolute path where to store the Jackrabbit Oak repository. Use the configuration file located in
"Jackrabbit-Oak-repository-upgrade/app-run-first-version/src/main/resources/settings.properties"
### Build the application
```sh
cd app-run-first-version
mvn clean install
```
### Run the application
```sh
cd app-run-first-version/target
java -jar app-run-first-version-1.0-SNAPSHOT.jar
```
## Repository upgrade
### Configuration
Configure the absolute path where to store the Jackrabbit Oak repository. Use the configuration file located in
"Jackrabbit-Oak-repository-upgrade/repository-upgrade-second-version/src/main/resources/settings.properties"
The path must match the one defined in the first application.
### Execute upgrade
```sh
cd repository-upgrade-second-version/target
java -jar repository-upgrade-second-version-1.0-SNAPSHOT.jar
```
## Second Application
### Configuration
Configure the absolute path where to store the Jackrabbit Oak repository. Use the configuration file located in
"Jackrabbit-Oak-repository-upgrade/app-run-second-version/src/main/resources/settings.properties"
The path must match the one defined in the first application.
### Build the application
```sh
cd app-run-second-version
mvn clean install
```
### Run the application
```sh
cd app-run-second-version/target
java -jar app-run-second-version-1.0-SNAPSHOT.jar
```
## Check repository content
Download oak-run-1.6.22.jar from https://search.maven.org/artifact/org.apache.jackrabbit/oak-run/1.6.22/jar
```sh
java -jar oak-run-1.6.22.jar explore /path/to/oak-repository/repository
```
Remember to refer to the path of the "repository" directory inside the Jackrabbit Oak repository.
## Custom node type registration
The custom node types can be registered into the content repository with a "Compact Namespace and Node Type Definition"
file. Refer to: http://jackrabbit.apache.org/jcr/node-types.html