InstallationJava » History » Version 5

« Previous - Version 5/14 (diff) - Next » - Current version
J. Moringen, 08/30/2011 04:31 AM
extended installation instruction, mention necessity of installing protocol sub-project


Installation of RSB Java Implementation

For compilation and installation of the Java implementation, we use the Ant build tool.

Dependencies

Dependencies on Externals Libraries and Tools

Required: Optional:
  • javadoc

Dependencies on other RSB Sub-projects

The Java implementation of RSB depends on RSB's language independent network protocol specification. This specification is maintained in the protocol sub-project of the RSB source tree.

Assuming the entire RSB source tree has been checked out into the current directory, the protocol sub-project can be built and installed using the following commands ($prefix has to be replaced with a desired installation prefix):

cd protocol/build && cmake .. -DCMAKE_INSTALL_PREFIX=$prefix && make && make install

Installation of RSB Core

After installing the protocol sub-project (see above)
  1. Checkout code from Subversion repository (see front page)
  2. Invoke ant supplying build properties on the commandline or via build.properties (see below)
The following properties are used to configure the build:
Ant Property Meaning Example
prefix Location into which RSB should be installed /vol/cit/share
pbuf.protoc Location of protocol buffer compiler (protoc or protoc.exe /usr/bin/protoc
pbuf.protopath Location of RSB protocol IDL files (see TODO) /vol/cit/share/RSBProtocol
pbuf.lib Location of Java protocol buffer runtime library /usr/share/java/protobuf.jar
spread.daemon Location of Spread Daemon Executable /vol/cit/sbin/spread

All properties can be supplied on the ant commandline using the -DNAME=VALUE syntax or by creating a build.properties file containing lines of the form NAME = VALUE.

An exemplary ant dist command, which builds the RSB jar library, may look as follows:

ant -Dpbuf.protoc=/usr/bin/protoc -Dpbuf.protopath=/vol/cit/share/RSBProtocol -Dpbuf.lib=/usr/share/java/protobuf.jar -Dspread.daemon=/vol/cit/sbin/spread dist

The equivalent build.properties file looks like this:
pbuf.protoc = /usr/bin/protoc
pbuf.protopath = /vol/cit/share/RSBProtocol
pbuf.lib = /usr/share/java/protobuf.jar
spread.daemon = /vol/cit/sbin/spread dist

In the presence of this file, the ant command reduces to
ant dist

To install RSB jars into the configured prefix (e.g., into ${prefix}/share/java), the following ant command can be used

ant install

Installation of RSB-XML

  • for rsb-xml, you need to additionally install XOM (available via ubuntu)
  • and pass the following parameters to the ant build script
Ant Property Meaning Example
pbuf.lib Location of Protobuf Library /usr/share/java/protobuf.jar
spread.daemon Location of Spread Daemon Executable /vol/cit/sbin/spread
xom.lib Location of XOM XML Library /usr/share/java/xom-1.2.1.jar
rsb.lib Location of RSB Core Library /vol/cit/lib/java/RSBJava.jar