Build Guide
This guide describes how to build the OCE from source code.
Do I Need to Build?
The OCE is shipped in pre-built binary form as well as source form
and, since it is Java, this binary form is relevant on all platforms.
If you simply wish to run the OCE, there is no need to be able to build
it.
You will need to build the OCE fully or partially from the source code
if:
- You want to use an alternative Java runtime which is not
compatible with Sun's Java 1.4.2 VM runtime.
- You want to make modifications to the core OCE source code.
- You want to develop your own OCE Components and Templates.
In the first two cases, you will need to build the entire OCE from
source code.
In the third case, you have a choice - install the binary distribution
and just build your new frameworks and OCE-Server (to link your new
code in), or alternatively build the whole kaboodle from source code.
Build Pre-requisites
See the system requirements guide for
general information.
The CassiniJava framework needs some third-party library jar files in
order to build, which are not shipped as part of the distribution.
Check the installation
guide
to see which Java libraries are required, following the
instructions as described.
The Testing framework also needs some third-party testing library jar
files required to run the tests, as stated in the requirements. The library
jars should be downloaded from the corresponding sources and added into
the lib folder of the Testing
framework source. The framework should then be re-built and installed.
Build Procedure
- Cleaning up from old installations
If you have any older copies of any of the frameworks listed below,
remove them from your installed frameworks folder now.
- Installing Frameworks
In the order listed below, import each framework project into Eclipse,
build it and install it.
There are known issues with refreshing in WOLips, so be careful not to
import a project into Eclipse until the preceding frameworks have been
successfully installed. Should you mistakenly import frameworks in the
wrong order and experience build problems, relaunching Eclipse is
likely to help.
If you are starting from a binary distribution and just want to be able
to build your own OCE Components and Templates, you should rebuild the
OCE-Examples framework from source.
If this works, correctly-formed Component and Template frameworks of
your own will also build.
Framework Build Order
CassiniJava
CassiniWOExtensions
OCE-Content
OCE-Navigation
OCE-Rendering
OCE-Examples
OCE-Users
Building Applications
The applications may be built in any order; they are:
CassiniEOUtil
OCE-Server
OCE-SiteAdmin
OCE-UserAdmin
Build them and, if required, install them.
What Now?
If you started with a binary distribution, having followed instructions
in the installation guide, and
have simply been rebuilding things, you are now finished and everything
should run correctly.
However, if you've just installed everything from source code, you'll
now need to refer to the installation
guide for additional steps to ensure the software is properly
configured, that you have a database set up, and so forth.