1. Classic LOCKSS Development

Note

This page is under construction.

The code base of the Classic LOCKSS system (version 1.x) is contained in a single Git repository, https://github.com/lockss/lockss-daemon.

1.1. Prerequisites

To do development work with the Classic LOCKSS system (version 1.x), you will need:

Git
Java 8 Development Kit (JDK 8), for example OpenJDK 8
Apache Ant
Python 3, invoked as python3
Some scripts require Python 2.7, invoked as python2
Some runtime contexts that process split Zip files and some unit tests require the zip program (zip and unzip are installed by default on most Linux systems).

1.1.4. Cloning the Git Repository

To clone the lockss-daemon repository from Git, use one of these commands:

# GitHub account with SSH key
git clone git@github.com:lockss/lockss-daemon

# Anonymous access
git clone https://github.com/lockss/lockss-daemon

This will create a lockss-daemon directory.

1.1.5. JUnit Prerequisites

JUnit 3.8.1 is included is included in the LOCKSS source distribution to run unit tests, but the Ant targets that invoke JUnit (test-xxx) require the JUnit JAR to be on Ant's CLASSPATH. The easiest way to do this is to copy lib/junit.jar (relative to the root of the lockss-daemon Git tree) into Ant's lib directory (relative to its installation directory on the system).

1.2. Tour of `lockss-daemon`

The main components of the lockss-daemon repository are as follows:

build.xml is the Ant build file. Type ant -projecthelp (or ant -p) will output a list of available build targets. The lib directory contains Java (JAR) dependencies for the project at large.
The src tree contains the source code of the LOCKSS system proper, and test/src its unit tests. The ant/src tree contains the source code for an ancillary prerequisite.
The plugins/src tree contains the source code of plugins written by the LOCKSS Program to support the preservation activities of LOCKSS networks such as the Global LOCKSS Network (GLN) and the CLOCKSS Archive, and plugins/test/src the unit tests.
The tools/src tree contains the source code of ancillary tools sometimes used in the context of LOCKSS development, and tools/test/src the unit tests.
The tdb directory contains the archival unit (AU) inventory of content managed by the LOCKSS Program on behalf of various LOCKSS networks such as the GLN and CLOCKSS.
The scripts and test/scripts directories contains scripts and tools used for TDB file processing, SOAP Web services, and more.
The test/frameworks tree contains multiple testing frameworks, to bring up one or more instance of the (classic) LOCKSS system on the local machine for testing or development purposes.

1. Classic LOCKSS Development

1.1. Prerequisites

1.1.1. Installing Git

1.1.2. Installing the Java Development Kit

1.1.3. Installing Apache Ant

1.1.4. Cloning the Git Repository

1.1.5. JUnit Prerequisites

1.2. Tour of `lockss-daemon`

1. Classic LOCKSS Development

1.1. Prerequisites

1.1.1. Installing Git

1.1.2. Installing the Java Development Kit

1.1.3. Installing Apache Ant

1.1.4. Cloning the Git Repository

1.1.5. JUnit Prerequisites

1.2. Tour of lockss-daemon

1.2. Tour of `lockss-daemon`