This page describes how to build and install Freeze for Java from source code.
Freeze for Java is expected to build and run properly on Windows, macOS, and any recent Linux distribution for x86 and x86_64, and was extensively tested using the operating systems and compiler versions listed for our supported platforms. Due to the portability of Java, it is very likely that it will also work on other platforms for which a suitable Java implementation is available.
You will need the Slice-to-Java and Slice-to-Freeze-Java compilers, which are implemented in C++. These compilers are included in the Ice and Freeze binary distributions.
Freeze for Java requires J2SE 1.7.0 or later.
Make sure that the javac and java commands are present in your PATH.
Freeze uses Berkeley DB as its underlying database and currently requires Berkeley DB version 5.3 (the recommended version is 5.3.28).
Berkeley DB for Java is not a pure Java implementation: the db.jar
implementation calls a Berkeley DB C library through JNI.
In order to run an application that uses Freeze, you must add db.jar to your
CLASSPATH and verify that the Berkeley DB shared library is in your
java.library.path.
Freeze for Java uses the Gradle build system, and includes the Gradle
wrapper version 4.0.1 in the distribution. You cannot build the Freeze for Java
source distribution without an Internet connection. Except for Berkeley DB,
Gradle will download all required packages automatically (on Windows, it also
downloads the berkeley.db.java7 NuGet automatically).
If freeze/ice is an empty directory, fetch the ice submodule with:
cd freeze
git submodule update --init
You also need to install Berkeley DB Java before building Freeze for Java.
On Linux, the build system searches in standard locations for the following JAR files:
db-5.3.28.jar
db-5.3.21.jar
db.jar
On macOS, we recommend you install the keg-only berkeley-db@5.3 formula
available in ZeroC's tap (zeroc-ice/tap). It provides db.jar, the
associated Berkeley DB C shared library and more. The freeze formula
(for Freeze C++) depends on this formula, so if you install freeze,
you will get berkeley-db@5.3 automatically.
You can build Freeze for Java using the Slice to Java and the Slice to
Freeze Java compilers installed in /usr/bin (Linux) or /usr/local/bin
(macOS) with the following commands:
export ICE_BIN_DIST=all
export FREEZE_BIN_DIST=all
./gradlew build
If you installed Slice to Java (Ice) or Slice to Freeze Java (Freeze C++)
in another directory, you need to first set ICE_HOME or FREEZE_HOME, for
example:
export ICE_HOME=/opt/Ice-3.7.6
export FREEZE_HOME=/opt/Freeze-3.7.6
If you leave ICE_BIN_DIST resp. FREEZE_BIN_DIST unset, you must build
slice2java in the freeze/ice submodule resp. slice2freezej in the
freeze/cpp directory.
If freeze/ice is an empty directory, fetch the ice submodule with:
cd freeze
git submodule update --init
You can build Freeze for Java using NuGet packages that the build system downloads automatically from nuget.org:
set ICE_BIN_DIST=all
set FREEZE_BIN_DIST=all
gradlew build
This will download and use a binary NuGet package for Ice that includes the
Slice to Java compiler. If you want to use another Ice installation, set
ICE_HOME, for example:
set ICE_HOME=C:\Program Files\ZeroC\Ice-3.7.6
If you leave ICE_BIN_DIST resp. FREEZE_BIN_DIST unset, you must build
slice2java in the freeze/ice submodule resp. slice2freezej in the
freeze/cpp directory.
If at any time you wish to discard the current build and start a new one, use these commands:
gradlew clean
gradlew build
To run the tests, open a command window and change to the top-level directory. At the command prompt, execute:
python allTests.py
If everything worked out, you should see lots of ok messages. In case of a
failure, the tests abort with failed.